API Guide
2-728 API Functions 601355 Rev A
Return Values VSCMD_MediaClassQuery_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 parameter
exceeds the maximum allowable length for that parameter.
•VSE_ERR_NULLSTRING - A null value was passed to a
string argument.
Example 1 /****************************************
*********
2*
3 * FUNCTION:
vst_mediaclassquery_defaults
4*
5 * PURPOSE:
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 Media
Class Query 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 Media Class Query
commands. Neither the API software nor
VolServ uses USER_FIELD.
Parameter Type Description