Gets an event handler from an Apple event dispatch table.
- macOS 10.0+
- Core Services
The event class for the desired handler. See
The event ID for the desired handler. See
A universal procedure pointer. On return, a pointer to the specified handler, if a dispatch table entry exists that exactly matches the values supplied in the parameters
If you use the
typeconstant for either or both of these parameters,
AEGetwill return an error unless an entry exists that specifies
typein exactly the same way. For example, if you specify
typein both the
theparameter and the
theparameter, the Apple Event Manager will not return the first handler for any event class and event ID in the dispatch table; instead, it will only return a handler if an entry exists that specifies type
typefor both the event class and the event ID.
For an explanation of wildcard values, see the Discussion section for
A pointer to a reference constant. On return, the reference constant from the dispatch table entry for the specified handler. The reference constant may have a value of 0.
Specifies the Apple event dispatch table to get the handler from. Pass
TRUEto get the handler from the system dispatch table or
FALSEto get the handler from your application’s dispatch table. See Version Notes for related information.
A result code. See Result Codes.
Thread safe starting in OS X v10.2.
Your application should not install a handler in a system dispatch table with the goal that the handler will get called when other applications receive events—this won’t work in macOS. For more information, see The System Dispatch Table in Apple Event Dispatching in Apple Events Programming Guide.
In Mac OS 7.1 through 9.x and macOS version v10.2 and later,
err when there’s not an exact match, even if a wildcard handler is installed that could handle the event. macOS version v10.0.x and v10.1.x will return the wildcard handler.