Carbon


AEPutDesc

Header: AEDataModel.h Carbon status: Supported

Adds a descriptor record to any descriptor list, possibly replacing an existing record in the list.

OSErr AEPutDesc (
    AEDescList *theAEDescList, 
    SInt32 index, 
    const AEDesc *theAEDesc
);
theAEDescList

A pointer to the descriptor list to add a descriptor record to.

index

A one-based positive integer indicating the position to insert the descriptor record at. If there is already a descriptor record in the specified position, it is replaced.

You can pass a value of zero or count + 1 to add the descriptor record at the end of the list. AEPutDesc returns an error (AEIllegalIndex) if you pass a negative number or a value that is out of range.

theAEDesc

A pointer to the descriptor record to add to the list.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)