API Guide
601355 Rev A API Functions 2-567
Functions
Return Values VSCMD_Connect 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.
- If the object code value is VSE_NONE, the client must
query the global error code (VSG_Error) to
determine where the error occurred.
VSID_USER_FIELD (VST_USER_FIELD) Value to be 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.
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