API Guide
601355 Rev A API Functions 2-897
Functins
Return Values VSCMD_ModifyArchiveMediaClass 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.
To determine where the error occurred, and what the error
was, the client queries the command’s error handle (with
VS_Error_GetFields) to retrieve the error handle’s
object code.
VSID_TARGET_ARCHIVE_NAME
(VST_ARCHIVE_NAME) The destination archive for media
automatically migrated out of this archive
media class. Valid archive names may co ntain
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) A 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