AESizeOfKeyDesc

Gets the size and descriptor type of an Apple event parameter from a descriptor of type AERecord.

Declaration

OSErr AESizeOfKeyDesc (
   const AppleEvent *theAERecord,
   AEKeyword theAEKeyword,
   DescType *typeCode,
   Size *dataSize
);

Parameters

theAERecord

A pointer to the Apple event record to get the parameter data from.

theAEKeyword

The keyword that specifies the desired parameter. Some keyword parameter constants are described in Keyword Parameter Constants. See AEKeyword.

typeCode

A pointer to a descriptor type. On return, specifies the descriptor type of the Apple event parameter. For a list of AppleScript’s predefined descriptor types, see Descriptor Type Constants. See DescType.

dataSize

A pointer to a size variable. On return, the length, in bytes, of the data in the Apple event parameter.

Return Value

A result code. See Result Codes.

Overview

This function is declared as a macro that invokes AESizeOfParam, 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

Getting the Sizes and Descriptor Types of Descriptors

AESizeOfAttribute

Gets the size and descriptor type of an Apple event attribute from a descriptor of type AppleEvent.

AESizeOfNthItem

Gets the data size and descriptor type of the descriptor at a specified position in a descriptor list.

AESizeOfParam

Gets the size and descriptor type of an Apple event parameter from a descriptor of type AERecord or AppleEvent.