Xantech CRM-WIC, Reference Manual

Page: 94 / 99

94
Remarks
Use SetVariableByID to modify the Variable’s name.
Default and Value
The returned value is a string that represents the stored value of the Variable. The string value will need to be converted by
the caller into the actual type, e.g. a variable of type
long
.
The format for the returned string depends on the Variable’s type. In the examples below, %d represents an integer, %s
represents a string.
Type Format Example
Number "%d" “25”
String “%s” “This is a string”
Range “%d to %d” “1 to 35”
Schedule "%d:%d:%d" “17:35:02”
Persistence
When a Variable is persistent, the value of the variable is stored to permanent storage 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.
AddVariable ( Name, Type, Default, Value, Persist )
Creates a new Variable
Syntax
HRESULT AddVariable(
[in] BSTR Name,
[in] long Type,
[in] BSTR Default,
[in] BSTR Value,
[in] long Persist,
[out, retval] long VarId
);