Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Previous Book Contents Book Index Next

Inside Macintosh: Interapplication Communication /
Chapter 11 - Program-to-Program Communications Toolbox / PPC Toolbox Reference
PPC Toolbox Routines / Receiving, Accepting, and Rejecting a Session


PPCReject

Use the PPCReject function to reject a session request after a PPCInform function completes.

FUNCTION PPCReject (pb: PPCRejectPBPtr; async: Boolean): OSErr;
pb
A pointer to a PPCReject parameter block.
async
A value that specifies whether the function is to be executed asynchronously (TRUE) or synchronously (FALSE).
-->ioCompletionPPCCompProcPtrAddress of a completion routine
<--ioResultOSErrResult code
-->sessRefNumPPCSessRefNumSession reference number of session to reject
-->rejectInfoLongIntValue to return if session is rejected

DESCRIPTION
If your application calls the PPCReject function asynchronously, you must specify in the ioCompletion field either the address of a completion routine or NIL. If you set ioCompletion to NIL, you should poll the ioResult field of the PPC parameter block (from your application's main event loop) to determine whether the PPC Toolbox has completed the requested operation. A value in the ioResult field other than 1 indicates that the call is complete. Note that it is unsafe to poll the ioResult field at interrupt time since the PPC Toolbox may be in the process of completing a call. See "PPC Toolbox Calling Conventions" beginning on page 11-14 for detailed information.

The sessRefNum field specifies a session to be rejected. This must be a valid session reference number returned from a previous PPCInform function. The rejectInfo field is an optional field. The application receiving a session request may specify any data in this field. The initiating application receives this information in the PPCStart parameter block.

ASSEMBLY-LANGUAGE INFORMATION
The trap macro and routine selector for the PPCReject function are
Trap macroSelector
_PPC$0005

The registers on entry and exit for this routine are
Registers on entry
A0Pointer to a parameter block
D0Selector code
Registers on exit
D0Result code

RESULT CODES
noErr0No error
notInitErr-900PPC Toolbox has not been initialized yet
noGlobalsErr-904System unable to allocate memory, critical error
noSessionErr-908Invalid session reference number
badReqErr-909Bad parameter or invalid state for this operation
SEE ALSO
For an example of the use of the PPCReject function, see page 11-39.


Previous Book Contents Book Index Next

© Apple Computer, Inc.
7 JUL 1996