API Guide
601355 Rev A API Functions 2-477
Functions
Parameters
Parameter Type Description
VSID_ARCHIVE_NAME
(VST_ARCHIVE_NAME)
Name of the archive to be varied. 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 this command.
VSID_COMP_STATE (VST_COMP_STATE) State where the archive is varied. 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 for this request.
VSID_PRIORITY (VST_PRIORITY) Requested execution priority for this request.
Assignable priority values are restricted to a
range from 1 (highest) to 32 (lowest) inclusive.
The default priority value is 15.
VSID_RETRY_LIMIT (VST_RETRY_LIMIT) Number of times the API software retries for
command status from VolServ before
returning a time-out to the client software for
this request. VSID_RETRY_LIMIT is not
applicable when the API software executes in
asynchronous mode.
VSID_STATUS_WAIT_FLAG
(VST_STATUS_WAIT_FLAG)
Flag indicating whether the API software waits
for final status from VolServ (or times-out) for
a command. Valid options are VSE_TRUE
(API waits for final status) and VSE_FALSE
(API does not wait for final status). Valid
options are VSE_TRUE (API software is to wait
for final status) and VSE_FALSE (API software
is not to wait for final status). Also determines
whether the API software operates in
synchronous mode (VSE_TRUE) or in
asynchronous mode (VSE_FALSE).