fsVarsGetOVarId
The fsVarsGetOVarId function can be used to get an existing OVar.
Syntax
FsOVarId fsVarsGetOVarId(
const char* name,
const char* componentPath,
FsObjectId target
);Parameters
| Parameters | Description |
|---|---|
name | The name of the variable. |
componentPath | The path of the component, in the format path:to:component or path:to:component@alias. The alias is optional but recommended, for performance reasons and to avoid conflicts. |
target | The ID of the object from which the variable is being retrieved. Default: FS_OBJECT_ID_USER_AIRCRAFT. |
Return Values
The function returns the ID associated with the given variable name. If the given name has not been registered, the function will return FS_VAR_INVALID_ID. If an error occurred, the function will return FS_VAR_INVALID_ID.
Remarks
OVar are local to an instrument, and the variable (and therefore the ID) will be different for each component.
Example
FsOVarId oVarId = fsVarsGetOVarId("TOTO", "LIGHTING:PANEL_EMISSIVE");