API Guide
601355 Rev A API Functions 2-245
Functions
Return Values VS_Global_SetFields returns:
•VSE_TRUE - Successful execution.
•VSE_FALSE - API failure - The appropriate error code is
set in VSG_Error.
•VSE_ERR_BADFIELD - An invalid parameter was
specified.
•VSE_ERR_BADHANDLE - Specified handle was not an
expression handle.
•VSE_ERR_BADSIZE - The value passed for a string
parameter exceeds the maximum allowable length for that
parameter.
•VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
VSID_SYNC_PROGRAM_NUMBER
(VST_PROGRAM_NUMBER) RPC program number to use for synchronous
processing. If not specified or 0, the API uses
a transient number. Default value is 0.
VSID_TIMEOUT_VALUE (VST_TIME_OUT) Amount of time (in seconds) the API software
waits for status from VolServ before returning
a timeout to the client software for this
request. Default time-out value is 120
seconds.
VSID_USER_FIELD (VST_USER_FIELD) Pointer to the default value to be put in the
VSID_USER_FIELD for every command.
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 each command.
Neither the API software nor VolServ uses
USER_FIELD.
Parameter Type Description