![]() |
AEGetAttributeDesc |
||||
Header: | AEDataModel.h | Carbon status: | Supported | |
Gets a copy of the descriptor record for a specified Apple event attribute from an Apple event; typically used when your application needs to pass the descriptor on to another function.
OSErr AEGetAttributeDesc ( const AppleEvent *theAppleEvent, AEKeyword theAEKeyword, DescType desiredType, AEDesc *result );
A pointer to the Apple event to get the attribute descriptor from.
The keyword that specifies the desired attribute. Some keyword constants are described in
The descriptor type for the desired attribute. For a list of AppleScripts predefined descriptor types, see
If the requested Apple event attribute is not of the desired type, the Apple Event Manager attempts to coerce it to the desired type. However, if you pass a value of typeWildCard, no coercion is performed, and the descriptor type of the returned record is the same as the descriptor type of the Apple event attribute.
A pointer to a descriptor record. On successful return, a copy of the specified Apple event attribute, coerced, if necessary, to the descriptor type specified in desiredType. On error, a null descriptor. Your application should always call the AEDisposeDesc function to dispose of the resulting descriptor record after it has finished using it.
A result code.
To get Apple event attribute data for your application to use directly, call AEGetAttributePtr. To get a descriptor record for an Apple event attribute to pass on to another Apple Event Manager routine, call AEGetAttributeDesc.
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)