Parameters
NumVariables
[out, retval] Total number of Variables in the system.
Remarks
Use
GetVariableCount
in conjunction with
GetVariableByIdx
to enumerate the list of available
Variables.
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 (see GetVariableType ( VarId ) page
).
GetVariableGroup ( VarId )
Returns the group name for the Variable.
Syntax
HRESULT GetVariableGroup(
[in]long VarId,
[out, retval]BSTR* Group
);
Parameters
VarId
[in] ID of the Variable to get the group name for.
Group
[out, retval] Group name assigned to the Variable.
Remarks
The group name is an arbitrary value, and is used only to help manage and sort Variables within the Event
Manager web pages.
GetVariableName ( VarId )
Returns the Variable’s name from its ID.
16
Summary of Contents for WACI NX-22
Page 36: ......
Page 53: ...Finally drag and drop selected files from your File Explorer...