171
Syntax
HRESULT GetVariableByName(
[in] long VarId,
[out, retval] BSTR* Name
);
Parameters
VarId
[in] ID of the Variable to get the name of.
Name
[out, retval] Name of specified Variable.
Remarks
Variable names consist of letters, numbers, and the underscore. All other characters are not permitted. The
Variable name should start with a non-number.
GetVariablePersist
GetVariablePersist
GetVariablePersist
GetVariablePersist ( V
( V
( V
( VarId )
arId )
arId )
arId )
Returns the persistence status of a Variable.
Syntax
HRESULT GetVariablePersist(
[in] long VarId,
[out, retval] long* Persist
);
Parameters
VarId
[in] ID of specified Variable.
Persist
[out, retval] Returns 1 if the Variable is persistent, and 0 if it is not.
Remarks
When a Variable is persistent, the value of the Variable is stored to permanent storage after each time it is
changed. So, if the device is reset or the power is turned off, the Variable will still have its last value when the
system restarts.
If the Variable is not persistent, then the Variable’s value is set to its default whenever the system restarts.
GetVariableType
GetVariableType
GetVariableType
GetVariableType ( VarId )
( VarId )
( VarId )
( VarId )
Returns the type of the specified Variable.
Syntax
HRESULT GetVariableType(
[in] long VarId,
[out, retval] long* Type
);
Parameters
VarId
[in] ID of specified Variable.
Type
[out, retval] The type of value stored in the Variable.
Valid types are: