Filter
Top Products
API Guide
2-978 API Functions 601355 Rev A
Return Values
VSCMD_Move returns:
•VSE_TRUE
- Successful execution if the API is operating in
synchronous mode
VSID_STATUS_WAIT_FLAG
(VST_STATUS_WAIT_FLAG)
A 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.
VSID_TARGET_ARCHIVE_NAME
(VST_ARCHIVE_NAME)
The name of the archive where the specified
media are to be moved. Valid archive names
may contain up to 16 alphanumeric
characters, including spaces. Leading and
trailing spaces are not permitted.
VSID_TIMEOUT_VALUE (VST_TIME_OUT) The amount of time (in seconds) the API
software waits for status from VolServ before
returning a time-out to the client software for
this request. The default time-out value is 120
seconds.
VSID_USER_FIELD (VST_USER_FIELD) The value to 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