Carbon


Keyword Attribute Constants

Header: AEDataModel.h

Specify keyword values for Apple event attributes.

enum {
    keyTransactionIDAttr = 'tran',
    keyReturnIDAttr = 'rtid',
    keyEventClassAttr = 'evcl',
    keyEventIDAttr = 'evid',
    keyAddressAttr = 'addr',
    keyOptionalKeywordAttr = 'optk',
    keyTimeoutAttr = 'timo',
    keyInteractLevelAttr = 'inte',
    keyEventSourceAttr = 'esrc',
    keyMissedKeywordAttr = 'miss',
    keyOriginalAddressAttr = 'from',
    keyAcceptTimeoutAttr = ''actm''
};

Constant descriptions

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 “Event Class Constants”.

keyEventIDAttr

Event ID of an Apple event. See “Event ID Constants”.

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 “User Interaction Level Constants”. (Read only.)

keyEventSourceAttr

Nature of the source application. (Read only.)

keyMissedKeywordAttr

Keyword for first required parameter remaining in an Apple event. (Read only.)

After extracting all known Apple event parameters from an event, your handler should check whether the keyMissedKeywordAttr attribute exists. If so, your handler has not retrieved all the parameters that the source application considered to be required, and it should return an error.

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.

keyAcceptTimeoutAttr

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 record 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 descriptor records. 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 Descriptor Records From Apple Event Parameters and Attributes” to request attributes and parameters by keyword.

See also “Keyword Parameter Constants”.


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