fsVarsEnvironmentVarGet

NOTE: Deprecated. Use fsVarsEVarGet instead.

The fsVarsEnvironmentVarGet function can be used to get the value of a specific EVar.

 

Syntax

FsVarError fsVarsEnvironmentVarGet(
    FsEnvVarId eVarId,
    FsUnitId unitId,
    double* result
);

 

Parameters

Parameters	Description
eVarId	The ID of an EVar (found using fsVarsGetEnvironmentVarId).
unitId	The ID of a unit (found using fsVarsGetUnitId).
result	The variable that will receive the value of the EVar if others parameters are correct.

 

Return Values

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

 

Example

FsUnitId unitId = fsVarsGetUnitId("seconds");
FsEnvVarId eVarId = fsVarsGetEVarId("ZULU TIME");
double result = 0;
if (fsVarsEnvironmentVarGet(eVarId, unitId, &result) == FS_VAR_ERROR_NONE)
{
    // valid
}
else
{
    // error
}