Extracts data from an Apple event array created with the
AEPut function and stores it as a standard array of fixed size items in the specified buffer.
- macOS 10.0+
- Core Services
A pointer to the descriptor list to get the array from. If the array is of type
k, the descriptor list must be factored. A factored descriptor list is one in which the Apple Event Manager automatically isolates the data that is common to all the elements of the list so that the common data only appears in the list once. To create a factored descriptor list, you call the
AECreatefunction and specify the data that is common to all elements in the descriptor array. See the Discussion section for related information. See
List(_: _: _: _:)
A pointer to a buffer, allocated and disposed of by your application, for storing the array. The size in bytes must be at least as large as the value you pass in the
maximumparameter. On return, the buffer contains the array of fixed-size items. See
The maximum length, in bytes, of the expected data. The
AEGetfunction will not return more data than you specify in this parameter.
A pointer to a descriptor type. On return, for arrays of type
k, the descriptor type of the items in the returned array. The
AEGetfunction doesn’t supply a value in
itemfor arrays of type
kbecause they may contain descriptors of different types. Possible descriptor types are listed in Descriptor Type Constants. See
AEKey Desc Array
A pointer to a size variable. On return, for arrays of type
k, the size (in bytes) of each item in the returned array. You don’t get an item size for arrays of type
AEKey Desc Array
kbecause descriptors and handles (though not the data they point to) have a known size.
A pointer to a size variable. On return, the number of items in the returned array.
A result code. See Result Codes.
AEGet function uses a buffer identified by the pointer in the
array parameter to store the converted data for the Apple event array specified by the
the parameter. For example,
AEGet may convert an array of descriptors of type
type into a simple array of integer values or an array of descriptors of type
type into an array of file specification records.
Even if the descriptor list that contains the array is factored, the converted data for each array item includes the data common to all the descriptors in the list. The Apple Event Manager automatically reconstructs the common data for each item when you call
For information about creating and factoring descriptor lists for Apple event arrays, see
AECreate. For information about adding an Apple event array to a descriptor list, see
Thread safe starting in OS X v10.2.