Carbon


AEGetSpecialHandler

Header: AppleEvents.h Carbon status: Supported

Gets a specified handler from a special handler dispatch table.

OSErr AEGetSpecialHandler (
    AEKeyword functionClass, 
    AEEventHandlerUPP *handler, 
    Boolean isSysHandler
);
functionClass

The keyword for the special handler to get. You can specify any of the constants described in “Special Handler Callback Constants”.

handler

A universal procedure pointer. On return, a pointer to the specified special handler, if one exists that matches the value supplied in the functionClass parameter.

isSysHandler

Specifies the special handler dispatch table to get the handler from. Pass TRUE to get the handler from the system special handler dispatch table or FALSE to get the handler from your application’s special handler dispatch table. Use of the system special handler dispatch table is not recommended for Carbon applications.

function result

A result code.

DISCUSSION

See also AEInstallSpecialHandler and AERemoveSpecialHandler.

VERSION NOTES

A Carbon application should not install a special handler in a system dispatch table with the goal that the handler will get called when other applications receive events—this won’t necessarily work. See “Apple Event Dispatching” (to be supplied later) for more information.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)