API Guide
601355 Rev A API Functions 2-485
Functions
Arguments •“…” = Variable length argument list consisting of pairs of
arguments. Each pair of arguments consists of a parameter
identifier, followed by the value to be used as a command
default value for the field. The parameter identifiers and
types this function accepts are shown in the following
"Parameters" paragraph.
•VSID_ENDFIELD = Required at the end of the variable
length argument list to indicate the end of the list.
Parame ters
Parameter Type Description
VSID_ARCHIVE_NAME
(VST_ARCHIVE_NAME) Name of the archive to be varied on Archive
Vary requests. Valid archive names may
contain up to 16 alphanumeric characters,
including spaces. Leading and trailing spaces
are not permitted.
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH) Name of the client dispatch routine to receive
status on Archive Vary requests.
VSID_COMP_STATE (VST_COMP_STATE) State where the archive is varied on Archive
Vary requests. Valid VSID_COMP_STATE
values are enumerated in the vs_types.h file.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID) Identifier of the enterprise, if any, to receive
final status on Archive Vary requests.
VSID_PRIORITY (VST_PRIORITY) Requested execution priority for Archive Vary
requests. Assignable priority values are
restricted to a range from 1 (highest) to 32
(lowest) inclusive. The default priority value is
15.