fsVarsOVarGet

The fsVarsOVarGet function can be used to get the value of a specific OVar.

Syntax#

FsVarError fsVarsOVarGet(
    FsOVarId oVarId,
    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 OVar has been set in result).

Example#

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsOVarId oVarId = fsVarsRegisterOVar("Toto", "LIGHTING:EMISSIVE");
double result = 0;
if (fsVarsOVarGet(oVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}