fsVarsIVarGet

The fsVarsIVarGet function can be used to get the value of a specific IVar.

Syntax#

FsVarError fsVarsIVarGet(
    FsLVarId iVarId,
    FsUnitId unitId,
    double* result,
    FsObjectId target
);

Parameters#

Return Values#

The function returns FsVarError, where 0 means there is no error (in which case, the value of the IVar has been set in result).

Example#

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsIVarId iVarId = fsVarsRegisterIVar("Toto", "LIGHTING");
double result = 0;
if (fsVarsIVarGet(iVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}