Filter
Top Products
API Guide
2-506 API Functions 601355 Rev A
Arguments • handle = The command handle for this Cancel request.
• “…” = Variable length argument list consisting of pairs of
Arguments. Each pair of Arguments consists of a parameter
identifier, followed by the value of the field to use for this
request. The valid parameter identifiers and types for this
function are shown in the following "Parameters"
paragraph.
• VSID_ENDFIELD = Required at the end of the variable
length argument list to indicate the end of the list.
Parameters
Parameter Type Description
VSID_CLIENT_DISPATCH
(VST_CLIENT_DISPATCH)
Name of the client dispatch routine to receive
status for this request.
VSID_COMMAND_HANDLE
(VST_COMMAND_HANDLE)
The command handle of the request to
cancel.
VSID_ENTERPRISE_ID
(VST_ENTERPRISE_ID)
Identifier of the enterprise, if any, to receive
final status for this request.
VSID_PRIORITY (VST_PRIORITY) Requested execution priority for this request.
Assignable priority values are restricted to a
range from 1 (highest) to 32 (lowest) inclusive.
The default priority value is 15.
VSID_REQUEST_ID (VST_REQUEST_ID) The request identifier of the request to cancel.
VSID_REQUEST_TYPE
(VST_REQUEST_TYPE)
The request type of the request to cancel.
Valid VSID_REQUEST_TYPE values are
enumerated in the vs_types.h file.
VSID_RETRY_LIMIT (VST_RETRY_LIMIT) Number of times the API software retries for
command status from VolServ before
returning a time-out to the client software for
this request. VSID_RETRY_LIMIT is not
applicable when the API software executes in
asynchronous mode.