XPLMIsDataRefGood

From X-Plane SDK
Jump to: navigation, search

XPLMIsDataRefGood

XPLM_API int                  XPLMIsDataRefGood(
                                   XPLMDataRef          inDataRef);    

WARNING: This function is deprecated and should not be used. Datarefs are valid until plugins are reloaded or the sim quits. Plugins sharing datarefs should support these semantics by not unregistering datarefs during operation. (You should however unregister datarefs when your plugin is unloaded, as part of general resource cleanup.)

This function returns whether a data ref is still valid. If it returns false, you should refind the data ref from its original string. Calling an accessor function on a bad data ref will return a default value, typically 0 or 0-length data.