API Guide
2-816 API Functions 601355 Rev A
Return Values VSCMD_DeleteMediaClass_SetDefaults returns:
• VSE_TRUE - Successful execution.
• VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
• VSE_ERR_BADFIELD - An invalid parameter was
specified.
• VSE_ERR_BADSIZE - Value passed for a string parame ter
exceeds the maximum allowable length for that parameter.
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
Delete Archive Media Class 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 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 Delete
Archive Media Class 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 Delete Archive
Media Class commands. Neither the API
software nor VolServ uses USER_FIELD.
Parameter Type Description