Xantech CRM-WIC, Reference Manual

Page: 90 / 99

90
GetVariableType ( 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:
Type
Value Description
1 Number
2 Schedule
3 String
4 Range
GetVariableDefault ( VarId )
Returns the default value of the specified variable.
Syntax
HRESULT GetVariableDefault(
[in] long VarId,
[out, retval] BSTR* Default
);
Parameters
VarId [in] ID of specified variable.
Default [out, retval] String containing default value of the specified variable.
Remarks
The returned value is a string that represents the Variable’s default value. 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”
GetVariableValue ( VarId )
Returns the current value of the specified variable.