API Guide
2-690 API Functions 601355 Rev A
Parame ters
Parameter Type Description
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH) Name of the client dispatch routine to receive
status for this request.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID) Identifier of the enterprise, if any, to receive
intermediate and final status for this request.
VSID_PRIORITY (VST_PRIORITY) The requested execution priority for this
request. Assignable priority values are
restricted to the 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 so ftware w aits
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).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.
VSID_TIMEOUT_VALUE (VST_TIME_OUT) Amount of time (in seconds) the API software
waits for status from VolServ before returning
a time-out to the client software. The default
time-out value is 120 seconds.