Removes a coercion handler from a coercion handler dispatch table.
SDK
- macOS 10.0+
Framework
- Core Services
Declaration
OSErr AERemoveCoercionHandler(Desc Type fromType, Desc Type toType, AECoercion Handler UPP handler, Boolean isSysHandler);
Parameters
fromType
The descriptor type of the data coerced by the handler. For a list of AppleScript’s predefined descriptor types, see Descriptor Type Constants. See
Desc
.Type toType
The descriptor type of the resulting data. For a list of AppleScript’s predefined descriptor types, see Descriptor Type Constants. See
Desc
.Type handler
A universal procedure pointer to the coercion handler to remove. Although the parameters
from
andType to
are sufficient to identify the handler, you can identify the handler explicitly as a safeguard. If you passType NULL
for this parameter, the Apple Event Manager relies solely on the event class and event ID to identify the handler. SeeAECoercion
.Handler UPP isSysHandler
Specifies the coercion table to remove the handler from. Pass
TRUE
to remove the handler from the system coercion table orFALSE
to remove the handler from your application’s coercion table. Use of the system coercion table is not recommended.
Return Value
A result code. See Result Codes.
Discussion
Thread safe starting in OS X v10.2.
Use of system coercion tables is not recommended. For more information, see Writing and Installing Coercion Handlers in Apple Events Programming Guide.