Important: The information in this document is obsolete and should not be used for new development.
PKillSendReq
ThePKillSendReq
function cancels the pendingPSendRequest
orPNSendRequest
functions whose queue element pointer you specify.
FUNCTION PKillSendReq (thePBPtr: ATPPBPtr; async: Boolean): OSErr;
thePBPtr
- A pointer to an ATP parameter block.
async
- A Boolean that indicates whether the function should be executed asynchronously or synchronously. Specify
TRUE
for asynchronous execution.
--> ioCompletion ProcPtr A pointer to the completion routine. <-- ioResult OSErr The function result. --> csCode Integer Always killSendReq
for this function.--> aKillQEl Ptr A pointer to queue element of function
to be removed.
Field Description
aKillQEl
- A pointer to the queue element of the pending function that is to be canceled. This is the pointer to the parameter block that you passed to the send request function when you issued the function.
DESCRIPTION
To cancel a specific pendingPSendRequest
orPNSendRequest
function, you specify the pointer to the queue element for the function in theaKillQEl
field of the parameter block for thePKillSendReq
function, then call the function. If the function has
already completed execution or if it is not in the ATP queue for any other reason,PKillSendReq
returns a message (cbNotFound
) indicating that it could not find the parameter block.ASSEMBLY-LANGUAGE INFORMATION
To execute thePKillSendReq
function from assembly language, call the_Control
trap macro with a value ofkillSendReq
in thecsCode
field of the parameter block. To execute this function from assembly language, you must also specify the .ATP driver reference number.RESULT CODES
noErr 0 No error cbNotFound -1102 The aKillQEl
parameter does not point to aPSendRequest
orPNSendRequest
queue elementSEE ALSO
To send requests, use thePSendRequest
function, described on page 6-24, and thePNSendRequest
function, described on page 6-27.