Carbon


AEDisposeDesc

Header: AEDataModel.h Carbon status: Supported

Deallocates the memory used by a descriptor record.

OSErr AEDisposeDesc (
    AEDesc *theAEDesc
);
Parameter descriptions
theAEDesc

A pointer to the descriptor record to deallocate. On return, a null descriptor record. If you pass a null descriptor record in this parameter, AEDisposeDesc returns noErr.

function result

A result code. As currently implemented, AEDisposeDesc always returns noErr.

DISCUSSION

The AEDisposeDesc function deallocates the memory used by a descriptor record. Because all Apple event structures (except for keyword-specified descriptor records) are descriptor records, you can use AEDisposeDesc for any of them.

SPECIAL CONSIDERATIONS

If the AEDesc might contain an OSL token, dispose of it with AEDisposeToken.

AVAILABILITY

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


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)