Important: The information in this document is obsolete and should not be used for new development.
AEGetKeyDesc
You can use theAEGetKeyDesc
function to get the descriptor record for a keyword-specified descriptor record. You can use this function to get a descriptor record out of an AE record or an Apple event record.
FUNCTION AEGetKeyDesc (theAERecord: AERecord; theAEKeyword: AEKeyword; desiredType: DescType; VAR result: AEDesc): OSErr;
theAERecord
The AE record containing the desired descriptor record.theAEKeyword
- The keyword that specifies the desired descriptor record.
desiredType
- The desired descriptor type for the descriptor record to be returned; if the requested descriptor record is not of this type, the Apple Event Manager attempts to coerce it to this type. If the value of
desiredType
istypeWildCard
, no coercion is performed, and the descriptor type of the returned descriptor record is the same as the descriptor type of the original descriptor record.result
- A copy of the keyword-specified descriptor record, coerced to the descriptor type specified in the
desiredType
parameter.DESCRIPTION
TheAEGetKeyDesc
function returns a copy of the descriptor record for a keyword-specified descriptor record. Your application should call theAEDisposeDesc
function to dispose of the resulting descriptor record after your application has finished using it.If
AEGetKeyDesc
returns a nonzero result code, it returns a descriptor record of descriptor typetypeNull
. A descriptor record of this type does not contain any data.RESULT CODES