ATPKillAllGetReq
The ATPKillAllGetReq function cancels all pending calls to the PGetRequest function for a specific socket.
FUNCTION ATPKillAllGetReq (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 killAllGetReq for this function. |
| --> | atpSocket | Byte | The socket number whose pending PGetRequest functions are to be canceled. |
Field Description
atpSocket
- The socket whose pending
PGetRequest functions are to
be canceled.
DESCRIPTION
The ATPKillAllGetReq function cancels all pending PGetRequest functions issued on a specific socket without closing the socket. For each function executed asynchro-
nously, ATPKillAllGetReq also calls the completion routine with the value reqAborted (-1105) in the D0 register. You should call the ATPKillAllGetReq function before closing a socket.
ASSEMBLY-LANGUAGE INFORMATION
To execute the ATPKillAllGetReq function from assembly language, call the _Control trap macro with a value of killAllGetReq in the csCode 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 | Control block not found; no pending asynchronous calls |