Filter
Top Products
API Guide
601355 Rev A API Functions 2-471
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.
Parameters
Parameter Type Description
VSID_ARCHIVE_NAME
(VST_ARCHIVE_NAME)
Name of the archive to be queried on all
Archive Query requests. Valid archive names
may contain up to 16 alphanumeric
characters, including spaces. Leading and
trailing spaces are not permitted.
VSID_ARCHIVE_QUERY_OPTION
(VST_ARCHIVE_QUERY_OPTION)
Type (or types) of information being requested
on Archive Query requests. Valid
VSID_ARCHIVE_QUERY_OPTION values are
defined in the vs_defs.h file. Multiple values
may be specified by connecting them with the
“|” operator.
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH)
Name of the client dispatch routine to receive
status on Archive Query requests.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID)
Identifier of the enterprise, if any, to receive
intermediate and final status on Archive Query
requests.
VSID_PRIORITY (VST_PRIORITY) Execution priority for Archive Query requests.
Assignable priority values are restricted to a
range from 1 (highest) to 32 (lowest) inclusive.
The default priority value is 15.