Filter
Top Products
API Guide
601355 Rev A API Functions 2-505
Functions
VSCMD_
Cancel
VSCMD_Cancel stops a pending request from executing or
aborts an executing Audit request.
Upon receipt of a Cancel request, VolServ returns final status to
the client that requested the cancellation. If the specified request
is capable of being cancelled, a good status is returned.
Otherwise, a status that indicates why the request cannot be
cancelled is returned.
If the specified request is pending execution, the request is
directed to terminate after any allocated resources are released.
A final status that indicates “failure due to cancellation” is sent
to the original issuer of the cancelled request.
Upon receipt of a Cancel request of an executing Audit request,
the processing is directed to abort, and the remainder of the
Audit request is cancelled. A final status that indicates “failure
due to cancellation” is sent to the original issuer of the
cancelled request.
To issue a valid Cancel request, the client must supply the
request identifier and request type of the request to be canceled.
The VSCMD_Cancel function can either take these parameters
separately or retrieve them from a command handle.
Synopsis
VST_BOOLEAN VSCMD_Cancel
(VST_COMMAND_HANDLE handle,
“…”,
VSID_ENDFIELD)