ADIC 601355 Rev A - page 895

API Guide
601355 Rev A API Functions 2-845
Functions
Return Values VSCMD_DeletePool_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
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
Disconnect 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 Disconnect 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 disconnect from VolServ.
Parameter Type Description