Filter
Top Products
API Guide
601355 Rev A API Functions 2-719
Functions
Return Values
VSCMD_MediaClassQuery 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.
• VSE_FALSE - The command failed. A return code of
VSE_FALSE (which is 0) means the command failed.
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).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.
VSID_USER_FIELD (VST_USER_FIELD) Value to be put in USER_FIELD for this
request. 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 this
request. Neither the API software nor VolServ
uses USER_FIELD.
Parameter Type Description