API Guide
601355 Rev A API Functions 2-535
Functions
Parameters
Parameter Type Description
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH)
Name of the client dispatch routine to receive
status for this request.
VSID_COMMENT (VST_COMMENT) The text information (comment) to appear on
the appropriate archive console eject list for
each medium specified for this request.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID)
Identifier of the enterprise, if any, to receive
intermediate and final status on this request.
VSID_MEDIA_ID_LIST (int) Number of media to check-out.
(char **) An array of the identifiers of the media to
check-out.
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
this request. Valid options are VSE_TRUE (API
software waits for final status) and
VSE_FALSE (API software does not wait for
final status). Also determines whether the API
software operates in synchronous mode
(VSE_TRUE) or in asynchronous mode
(VSE_FALSE). The default
VSID_STATUS_WAIT_FLAG value is
VSE_TRUE.