API Guide
2-578 API Functions 601355 Rev A
Return Values
VSCMD_Connect_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.
• VSE_ERR_NULLSTRING - A null value was passed to a
string argument.
Example 1 /****************************************
*********
2*
3 * FUNCTION: vst_connect_defaults
4*
5 * PURPOSE:
VSID_USER_FIELD (VST_USER_FIELD) Value to be put in USER_FIELD for Connect
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 Connect
commands. Neither the API software nor
VolServ uses USER_FIELD.
VSID_VERSION_NUMBER
(VST_VERSION_NUMBER)
RPC version number of the client process to
receive status messages and MediaClass
callbacks from VolServ.
VSID_VERSION_NUMBER is not applicable if
VSID_CONNECT_HANDLE is specified.
Parameter Type Description