API Guide
2-380 API Functions 601355 Rev A
Return Values
VS_Request_SetFields returns:
• VSE_TRUE - Successful execution.
• VSE_FALSE - API failure - An appropriate error code is set
in VSG_Error.
• VSE_ERR_FIELD - An invalid parameter was specified.
• VSE_ERR_BADHANDLE - Specified handle was not a
request handle.
• VSE_ERR_BADSIZE - Value passed for a string parameter
exceeds the maximum allowable length for that parameter.
• VSE_ERR_NULLHANDLE - Specified handle was a null
pointer.
• VSE_ERR_NULLSTRING - A null value was passed to a
string argument.
VSID_REQUEST_ID (VST_REQUEST_ID) Identifier of the request (assigned by VolServ)
associated with the specified request handle.
A valid request identifier must be specified in
the yyyyddmm format where yyyy
represents the year, dd represents the day,
and mm is a month.
VSID_REQUEST_STATE
(VST_REQUEST_STATE)
The execution state of the request. Valid
VSID_REQUEST_STATE values are
enumerated in the vs_types.h file.
VSID_REQUEST_TYPE
(VST_RQUEST_TYPE)
The request type to be associated with the
request handle. Valid VSID_REQUEST_TYPE
values are enumerated in the vs_types.h file.
VSID_TIME (VST_TIME) Arrival time of the request.
Parameter Type Description
