Functions


Adding Items to Descriptor Lists

AEPutArray Puts the data for an Apple event array into a descriptor list, replacing any previous records in the list.
AEPutDesc Adds a descriptor record to any descriptor list, possibly replacing an existing record in the list.
AEPutPtr Puts data specified in a buffer to a descriptor list as a descriptor record, possibly replacing an existing record in the list.

Adding Parameters and Attributes to an Apple Event

AEPutAttributeDesc Adds a descriptor record and a keyword to an Apple event as an attribute.
AEPutAttributePtr Adds a pointer to data, a descriptor type, and a keyword to an Apple event as an attribute.
AEPutParamDesc Puts a descriptor record and a keyword into an Apple event or AE record as an Apple event parameter.
AEPutParamPtr Puts a pointer to data, a descriptor type, and a keyword into an Apple event or AE record as an Apple event parameter.

Coercing Descriptor Types

AECoerceDesc Coerces the data in a descriptor record to another descriptor type and creates a descriptor record containing the newly coerced data.
AECoercePtr Coerces data to a desired descriptor type and creates a descriptor record containing the newly coerced data.

Counting the Items in Descriptor Lists

AECountItems Counts the number of descriptor records in a descriptor list.

Creating Descriptor Lists and Apple Event Records

AECreateList Creates an empty descriptor list or AE record.

Creating Object Specifier Records

CreateCompDescriptor Creates a comparison descriptor record that specifies how to compare one or more Apple event objects with either another Apple event object or a descriptor record.
CreateLogicalDescriptor Creates a logical descriptor record that specifies a logical operator and one or more logical terms for the Apple Event Manager to evaluate.
CreateObjSpecifier Assembles an object specifier record that identifies one or more Apple event objects, from other descriptor records.
CreateOffsetDescriptor Creates an offset descriptor record that specifies the position of an element in relation to the beginning or end of its container.
CreateRangeDescriptor Creates a range descriptor record that specifies a series of consecutive elements in the same container.

Creating an Apple Event

AECreateAppleEvent Creates an Apple event with several important attributes but no parameters.

Creating and Duplicating Descriptor Records

AECreateDesc Creates a new descriptor record that incorporates the specified data.
AEDuplicateDesc Creates a copy of a descriptor record.

Creating, Calling, and Deleting Universal Procedure Pointers

DisposeAECoerceDescUPP Disposes of a universal procedure pointer to a function that coerces data stored in a descriptor record.
DisposeAECoercePtrUPP Disposes of a universal procedure pointer to a function that coerces data stored in a buffer.
DisposeAEEventHandlerUPP Disposes of a universal procedure pointer to an event handler function.
DisposeAEFilterUPP Disposes of a universal procedure pointer to an Apple event filter function.
DisposeAEIdleUPP Disposes of a universal procedure pointer to an Apple event idle function.
DisposeOSLAccessorUPP Disposes of a universal procedure pointer to an object accessor function.
DisposeOSLAdjustMarksUPP Disposes of a universal procedure pointer to an object callback adjust marks function.
DisposeOSLCompareUPP Disposes of a universal procedure pointer to an object callback comparison function.
DisposeOSLCountUPP Disposes of a universal procedure pointer to an object callback count function.
DisposeOSLDisposeTokenUPP Disposes of a universal procedure pointer to an object callback dispose token function.
DisposeOSLGetErrDescUPP Disposes of a universal procedure pointer to an object callback get error descriptor function.
DisposeOSLGetMarkTokenUPP Disposes of a universal procedure pointer to an object callback get mark function.
DisposeOSLMarkUPP Disposes of a universal procedure pointer to an object callback mark function.
InvokeAECoerceDescUPP Calls a universal procedure pointer to a function that coerces data stored in a descriptor record.
InvokeAECoercePtrUPP Calls a universal procedure pointer to a function that coerces data stored in a buffer.
InvokeAEEventHandlerUPP Calls an event handler universal procedure pointer.
InvokeAEFilterUPP Calls an Apple event filter universal procedure pointer.
InvokeAEIdleUPP Calls an Apple event idle universal procedure pointer.
InvokeOSLAccessorUPP Calls an object accessor universal procedure pointer.
InvokeOSLAdjustMarksUPP Calls an object callback adjust marks universal procedure pointer.
InvokeOSLCompareUPP Calls an object callback comparison universal procedure pointer.
InvokeOSLCountUPP Calls an object callback count universal procedure pointer.
InvokeOSLDisposeTokenUPP Calls an object callback dispose token universal procedure pointer.
InvokeOSLGetErrDescUPP Calls an object callback get error descriptor universal procedure pointer.
InvokeOSLGetMarkTokenUPP Calls an object callback get mark universal procedure pointer.
InvokeOSLMarkUPP Calls an object callback mark universal procedure pointer.
NewAECoerceDescUPP Creates a new universal procedure pointer to a function that coerces data stored in a descriptor record.
NewAECoercePtrUPP Creates a new universal procedure pointer to a function that coerces data stored in a buffer.
NewAEEventHandlerUPP Creates a new universal procedure pointer to an event handler function.
NewAEFilterUPP Creates a new universal procedure pointer to an Apple event filter function.
NewAEIdleUPP Creates a new universal procedure pointer to an Apple event idle function.
NewOSLAccessorUPP Creates a new universal procedure pointer to an object accessor function.
NewOSLAdjustMarksUPP Creates a new universal procedure pointer to an object callback adjust marks function.
NewOSLCompareUPP Creates a new universal procedure pointer to an object callback comparison function.
NewOSLCountUPP Creates a new universal procedure pointer to an object callback count function.
NewOSLDisposeTokenUPP Creates a new universal procedure pointer to an object callback dispose token function.
NewOSLGetErrDescUPP Creates a new universal procedure pointer to an object callback get error descriptor function.
NewOSLGetMarkTokenUPP Creates a new universal procedure pointer to an object callback get mark function.
NewOSLMarkUPP Creates a new universal procedure pointer to an object callback mark function.

Deallocating Memory for Descriptor Records

AEDisposeDesc Deallocates the memory used by a descriptor record.

Deallocating Memory for Tokens

AEDisposeToken Deallocates the memory used by a token.

Deleting Descriptor Records

AEDeleteItem Deletes a descriptor record from a descriptor list, causing all subsequent descriptor records to move up one place.
AEDeleteParam Deletes a keyword-specified parameter from an Apple event or AE record.

Dispatching Apple Events

AEProcessAppleEvent Calls the handler, if one exists, for a specified Apple event.

Getting Data or Descriptor Records From Apple Event Parameters and Attributes

AEGetAttributeDesc Gets a copy of the descriptor record for a specified Apple event attribute from an Apple event; typically used when your application needs to pass the descriptor on to another function.
AEGetAttributePtr Gets a copy of the data for a specified Apple event attribute from an Apple event; typically used when your application needs to work with the data directly.
AEGetParamDesc Gets a copy of the descriptor record for a specified Apple event parameter from an Apple event; typically used when your application needs to pass the extracted data to another function as a descriptor record.
AEGetParamPtr Gets a copy of the data for a specified Apple event parameter from an Apple event; typically used when your application needs to work with the extracted data directly.

Getting Information About the Apple Event Manager

AEManagerInfo Provides information about the version of the Apple Event Manager currently available or the number of processes that are currently recording Apple events.

Getting Items From Descriptor Lists

AEGetArray Extracts data from an Apple event array created with the AEPutArray function and stores it as a standard array of fixed size items in the specified buffer.
AEGetNthDesc Copies a descriptor record from a specified position in a descriptor list into a specified descriptor record; typically used when your application needs to pass the extracted data to another function as a descriptor record.
AEGetNthPtr Gets a copy of the data from a descriptor record at a specified position in a descriptor list; typically used when your application needs to work with the extracted data directly.

Getting the Sizes and Descriptor Types of Descriptor Records

AESizeOfAttribute Gets the size and descriptor type of an Apple event attribute from a record of type AppleEvent.
AESizeOfNthItem Gets the data size and descriptor type of the descriptor record at a specified position in a descriptor list.
AESizeOfParam Gets the size and descriptor type of an Apple event parameter from a record of type AERecord or AppleEvent.

Getting, Calling, and Removing Object Accessor Functions

AECallObjectAccessor Invokes the appropriate object accessor function for a specific desired type and container type.
AEGetObjectAccessor Gets an object accessor function from an object accessor dispatch table.
AEInstallObjectAccessor Adds or replaces an entry for an object accessor function to an object accessor dispatch table.
AERemoveObjectAccessor Removes an object accessor function from an object accessor dispatch table.

Initializing the Object Support Library

AEObjectInit Initializes the Object Support Library.
AESetObjectCallbacks Specifies the object callback functions for your application.

Managing Apple Event Dispatch Tables

AEGetEventHandler Gets an event handler from an Apple event dispatch table.
AEInstallEventHandler Adds an entry for an event handler to an Apple event dispatch table.
AERemoveEventHandler Removes an event handler entry from an Apple event dispatch table.

Managing Coercion Handler Dispatch Tables

AEGetCoercionHandler Gets the coercion handler for a specified descriptor type.
AEInstallCoercionHandler Installs a coercion handler in either the application or system coercion handler dispatch table.
AERemoveCoercionHandler Removes a coercion handler from a coercion handler dispatch table.

Managing Special Handler Dispatch Tables

AEGetSpecialHandler Gets a specified handler from a special handler dispatch table.
AEInstallSpecialHandler Installs a callback function in a special handler dispatch table.
AERemoveSpecialHandler Removes a handler from a special handler dispatch table.

Operating On a Descriptor Record’s Data

AEGetDescData Gets the data from the specified AEDesc record.
AEGetDescDataSize Gets the size, in bytes, of the data in the specified AEDesc record.
AEReplaceDescData Copies the specified data into the specified descriptor record, replacing any previous data.

Requesting More Time to Respond to Apple Events

AEResetTimer Resets the timeout value for an Apple event to its starting value.

Requesting User Interaction

AEGetInteractionAllowed Gets your application’s current user interaction preferences for responding to an Apple event as a server application.
AEInteractWithUser Initiates interaction with the user when your application is a server application responding to an Apple event.
AESetInteractionAllowed Specifies user interaction preferences for responding to an Apple event when your application is the server application.

Resolving Object Specifier Records

AEResolve Resolves an object specifier record.

Sending an Apple Event

AESend Sends the specified Apple event.

Suspending and Resuming Apple Event Handling

AEGetTheCurrentEvent Gets the Apple event that is currently being handled.
AEResumeTheCurrentEvent Informs the Apple Event Manager that your application wants to resume the handling of a previously suspended Apple event or that it has completed the handling of the Apple event.
AESetTheCurrentEvent Specifies a current Apple event to take the place of the one your application has suspended.
AESuspendTheCurrentEvent Suspends the processing of the Apple event that is currently being handled.

Miscellaneous

CallAECoerceDescProc
CallAECoercePtrProc
CallAEEventHandlerProc
CallAEFilterProc
CallAEIdleProc
CallOSLAccessorProc
CallOSLAdjustMarksProc
CallOSLCompareProc
CallOSLCountProc
CallOSLDisposeTokenProc
CallOSLGetErrDescProc
CallOSLGetMarkTokenProc
CallOSLMarkProc

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)