API Guide
601355 Rev A API Functions 2-931
Functins
Return Values VSCMD_ModifyMediaClass_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 - The value passed for a string
parameter exceeds the maximum allowable length for that
parameter.
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 Modify
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 Modify Media Class
commands. Neither the API software nor
VolServ uses USER_FIELD.
VSID_VERSION_NUMBER
(VST_VERSION_NUMBER) The RPC version number of the client process
to receive callbacks generated for this
MediaClass group. VSID_VERSION_NUMBER
is required if VSID_CLASS_RPC_OPTION is
set to VSE_CLASS_RPC_ENTERPRISE.
Otherwise, VSID_VERSION_NUMBER is not
applicable.
Parameter Type Description