API Guide
2-550 API Functions 601355 Rev A
Return Values VSCMD_ClearEject returns:
•VSE_TRUE
- Successful execution if the API is operating in synchronous mode.- Good initial status received if the API is operating 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
ClearEject commands. 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.
VSID_TIMEOUT_VALUE (VST_TIME_OUT) Amount of time (in seconds) the API software
waits for status from VolServ before returning
a timeout to the client software for this
request. The total wait time for a command is
(VSID_RETRY_LIMIT plus 1) multiplied by
VSID_TIMEOUT_VALUE.
VSID_USER_FIELD (VST_USER_FIELD) Value to be put in USER_FIELD for ClearEject
commands. USER_FIELD is a 16-character
field provided for user information. Information
entered in this field is echoed back to the user
in every status message returned for
ClearEject commands. Neither the API
software nor VolServ uses USER_FIELD.
Parameter Type Description