fsVarsLVarGet

The fsVarsLVarGet function can be used to get the value of a specific LVar.

 

Syntax

FsVarError fsVarsLVarGet(
    FsLVarId lVarId,
    FsUnitId unitId,
    double* result
);

 

Parameters

Parameters	Description
lVarId	The ID of an LVar (found using fsVarsGetLVarId or fsVarsRegisterLVar).
unitId	The ID of a unit (found using fsVarsGetUnitId).
result	The variable that will receive the value of the LVar if others parameters are correct.

 

Return Values

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

 

Example

FsUnitId unitId = fsVarsGetUnitId("DEGREES");
FsLVarId lVarId = fsVarsRegisterLVar("Toto");
double result = 0;
if (fsVarsLVarGet(lVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}