fsVarsZVarSet

The fsVarsZVarSet function can be used to set the value of a specific ZVar.

 

Syntax

FsVarError fsVarsZVarSet(
    FsZVarId zVarId,
    FsUnitId unitId,
    double value,
    FsObjectId target
);

 

Parameters

Parameters	Description
zVarId	The ID of an ZVar (found using fsVarsGetZVarId or fsVarsRegisterZVar).
unitId	The ID of a unit (found using fsVarsGetUnitId).
value	The new value of the variable.
target	The ID of the object from which the variable is being retrieved. Possible targets are: FS_OBJECT_ID_USER_AIRCRAFT FS_OBJECT_ID_USER_AVATAR FS_OBJECT_ID_USER_CURRENT Default: FS_OBJECT_ID_USER_AIRCRAFT.

 

Return Values

The function returns FsVarError, where 0 means there is no error.

 

Example

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsZVarId zVarId = fsVarsRegisterZVar("Toto");
double value = 8;
if (fsVarsZVarSet(oVarId, unitId, value) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}