Enumeration

Keyword Attribute Constants

Specify keyword values for Apple event attributes.

Declaration

enum : AEKeyword {
    ...
};

Overview

These constants are keyword constants for Apple event attributes. An Apple event consists of attributes (which identify the Apple event and denote its task) and, often, parameters (which contain information to be used by the target application). An Apple event attribute is a descriptor that identifies the event class, event ID, target application, or some other characteristic of the Apple event. Taken together, the attributes of an Apple event denote the task to be performed on any data specified in the Apple event’s parameters.

Keywords are arbitrary names used by the Apple Event Manager to keep track of various descriptors. Your application cannot examine the contents of an Apple event directly. Instead, you call Apple Event Manager routines such as those described in Getting Data or Descriptors From Apple Events and Apple Event Records to request attributes and parameters by keyword.

See also Keyword Parameter Constants.

Version-Notes

The constant keyReplyRequestedAttr was added in OS X version 10.3.

Topics

Constants

keyTransactionIDAttr

Transaction ID identifying a series of Apple events that are part of one transaction.

keyReturnIDAttr

Return ID for a reply Apple event.

keyEventClassAttr

Event class of an Apple event. See AEAddressDesc.

keyEventIDAttr

Event ID of an Apple event. See AEAddressDesc.

keyAddressAttr

Address of a target or client application. See also AEAddressDesc.

keyOptionalKeywordAttr

List of keywords for parameters of an Apple event that should be treated as optional by the target application.

keyTimeoutAttr

Length of time, in ticks, that the client will wait for a reply or a result from the server.

keyInteractLevelAttr

Settings for when to allow the Apple Event Manager to bring a server application to the foreground, if necessary, to interact with the user. See AEAddressDesc. (Read-only.)

keyEventSourceAttr

Nature of the source application. (Read-only.)

keyOriginalAddressAttr

Address of original source of Apple event if the event has been forwarded (available only in version 1.01 or later versions of the Apple Event Manager). See also AEAddressDesc.

keyReplyRequestedAttr

A Boolean value indicating whether the Apple event expects to be replied to.