Important: The information in this document is obsolete and should not be used for new development.
AEPutArray
You can use theAEPutArray
function to put the data for an Apple event array into any descriptor list.
FUNCTION AEPutArray (theAEDescList: AEDescList; arrayType: AEArrayType; arrayPtr: AEArrayDataPointer; itemType: DescType; itemSize: Size; itemCount: LongInt): OSErr;
theAEDescList
- The descriptor list into which to put the Apple event array. If there are any items already in the descriptor list, they are replaced.
arrayType
- The Apple event array type to be created. This is specified by one of the following constants:
kAEDataArray
,kAEPackedArray
,kAEHandleArray
,kAEDescArray
, orkAEKeyDescArray
.arrayPtr
- A pointer to the buffer containing the array.
itemType
- For arrays of type
kAEDataArray
,kAEPackedArray
, orkAEHandleArray
, the descriptor type of array items to be created.itemSize
- For arrays of type
kAEDataArray
orkAEPackedArray
, the size (in bytes) of the array items to be created.itemCount
- The number of elements in the array.
DESCRIPTION
When you useAEPutArray
to put an array into a factored descriptor list, each array item must include the data that is common to all the descriptor records in the list. The Apple Event Manager automatically isolates the data you specified in the call toAECreateList
that is common to all the elements of the array.RESULT CODES
noErr 0 No error memFullErr -108 Not enough room in heap zone errAEWrongDataType -1703 Wrong descriptor type errAENotAEDesc -1704 Not a valid descriptor record SEE ALSO
For information about data types and constants used withAEPutArray
, see "Apple Event Array Data Types" on page 4-57.For more information about creating descriptor lists for Apple event arrays, see the description of
AECreateList
on page 5-29.