fsVarsIVarSet

The fsVarsIVarSet function can be used to set the value of a specific IVar.

 

Syntax

FsVarError fsVarsIVarSet(
    FsOVarId iVarId,
    FsUnitId unitId,
    double value,
    FsObjectId target
);

 

Parameters

Parameters	Description
iVarId	The ID of an IVar (found using fsVarsGetIVarId or fsVarsRegisterIVar).
unitId	The ID of a unit (found using fsVarsGetUnitId).
value	The new value of the variable.
target	The ID of the object on which the variable is being set. 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");
FsIVarId iVarId = fsVarsRegisterIVar("Toto", "LIGHTING");
double value = 8;
if (fsVarsIVarSet(iVarId, unitId, value) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}