AEPutKeyDesc

Inserts a descriptor and a keyword into an Apple event record as an Apple event parameter.

Declaration

OSErr AEPutKeyDesc (
   AERecord *theAERecord,
   AEKeyword theAEKeyword,
   const AEDesc *theAEDesc
);

Parameters

theAERecord

A pointer to the Apple event record to add a parameter to.

theAEKeyword

The keyword specifying the parameter to add. If the Apple event record already has a parameter with this keyword, the parameter is replaced.

Some keyword constants are described in Keyword Parameter Constants.

See AEKeyword.

theAEDesc

A pointer to the descriptor for the parameter to add. See AEDesc.

Return Value

A result code. See Result Codes.

Overview

This function is declared as a macro that invokes AEPutParamDesc, which can operate on an Apple event or an Apple event record. See the Discussion for that function for more information.

Version-Notes

See Also

Adding Parameters and Attributes to Apple Events and Apple Event Records

AEPutAttributeDesc

Adds a descriptor and a keyword to an Apple event as an attribute.

AEPutAttributePtr

Adds a pointer to data, a descriptor type, and a keyword to an Apple event as an attribute.

AEPutKeyPtr

Inserts data, a descriptor type, and a keyword into an Apple event record as an Apple event parameter.

AEPutParamDesc

Inserts a descriptor and a keyword into an Apple event or Apple event record as an Apple event parameter.

AEPutParamPtr

Inserts data, a descriptor type, and a keyword into an Apple event or Apple event record as an Apple event parameter.