Carbon


AEGetDescData

Header: AEDataModel.h Carbon status: Supported

Gets the data from the specified AEDesc record.

OSErr AEGetDescData (
    const AEDesc *theAEDesc, 
    DescType typeCode, 
    void *dataPtr, 
    Size maximumSize
);
theAEDesc

A pointer to the descriptor record to get the data from.

typeCode

A pointer to a buffer, local variable, or other storage location created and disposed of by your application. The size in bytes should be the same as the value you pass in the maximumSize parameter. On return, contains the data from the descriptor record.

dataPtr

The length, in bytes, of the expected descriptor data. The AEGetDescData function will not return more data than you specify in this parameter. You typically determine the maximum size by calling AEGetDescDataSize.

maximumSize
function result

A result code.

DISCUSSION

Your application can call AEGetDescDataSize to get the size, in bytes, of the data in a descriptor record, allocate a buffer or variable of that size, then call AEGetDescData to get the data.

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)