Legacy Document

Inside Macintosh: Networking /

Chapter 6 - AppleTalk Transaction Protocol (ATP) / ATP Reference

Routines / Canceling Pending ATP Functions

PKillGetReq

The PKillGetReq function cancels the pending PGetRequest function that
you specify.

FUNCTION PKillGetReq (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 a completion routine.
<--	ioResult	OSErr	The function result.
-->	csCode	Integer	Always killGetReq for this function.
-->	aKillQEl	Pointer	A pointer to the queue element

Field Description

aKillQEl

A pointer to the queue element of the pending call that is to
be canceled.

DESCRIPTION

The PKillGetReq function lets you cancel a specific outstanding PGetRequest function without having to cancel all pending get requests or having to close the
socket to do this; closing the socket cancels all outstanding functions on that socket.

To cancel a specific pending PGetRequest function, you specify the pointer to the queue element for the function in the aKillQEl field of the parameter block for the PKillGetReq function. The queue element pointer is the pointer to the parameter block of the PGetRequest function to be canceled. If the function has already completed execution or if it is not in the ATP queue for any other reason, PKillGetReq returns a message (cbNotFound) indicating that it could not find the parameter block.

ASSEMBLY-LANGUAGE INFORMATION

To execute the PKillGetReq function from assembly language, call the _Control trap macro with a value of killGetReq 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	The aKilllQEl parameter does not point to a PGetRequest queue element