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.
- macOS 10.0+
- Core Services
A pointer to the Apple event to get the attribute data from. See
The desired descriptor type for the copied data. For a list of AppleScript’s predefined descriptor types, see Descriptor Type Constants.
If the descriptor specified by the
theparameter is not of the desired type,
AEGetattempts to coerce the data to this type. However, if you pass a value of
type, no coercion is performed, and the descriptor type of the returned data is the same as the descriptor type of the Apple event attribute.
On return, you can determine the actual descriptor type by examining the
A pointer to a descriptor type. On return, specifies the descriptor type of the attribute data pointed to by
data. The returned type is either the same as the type specified by the
desiredparameter or, if the desired type was type wildcard, the true type of the descriptor. For a list of AppleScript’s predefined descriptor types, see Descriptor Type Constants. See
A pointer to a buffer, local variable, or other storage location, created and disposed of by your application. The size in bytes must be at least as large as the value you pass in the
maximumparameter. On return, contains the attribute data.
The maximum length, in bytes, of the expected attribute data. The
AEGetfunction will not return more data than you specify in this parameter.
A pointer to a size variable. On return, the length, in bytes, of the data for the specified Apple event attribute. If this value is larger than the value you passed in the
maximumparameter, the buffer pointed to by
datawas not large enough to contain all of the data for the attribute, though
AEGetdoes not write beyond the end of the buffer. If the buffer was too small, you can resize it and call
A result code. See Result Codes.
To get Apple event attribute data for your application to use directly, call
AEGet. To get a descriptor for an Apple event attribute to pass on to another Apple Event Manager routine, call
AEGet, you can call the
AESize function to determine a size for the
data buffer. However, unless you specify
type for the
AEGet may coerce the data, which may cause the size of the data to change.
Thread safe starting in OS X v10.2.