Important: The information in this document is obsolete and should not be used for new development.
AEGetParamDesc
You can use theAEGetParamDesc
function to get the descriptor record for a specified Apple event parameter.
FUNCTION AEGetParamDesc (theAppleEvent: AppleEvent; theAEKeyword: AEKeyword; desiredType: DescType; VAR result: AEDesc): OSErr;
theAppleEvent
- The Apple event containing the desired parameter.
theAEKeyword
The keyword that specifies the desired parameter.desiredType
The desired descriptor type for the descriptor record to be returned; if the requested Apple event parameter is not of this type, the Apple Event Manager attempts to coerce it to this type. If the value ofdesiredType
istypeWildCard
, no coercion is performed, and the descriptor type of the returned data is the same as the descriptor type of the Apple event parameter.result
- The descriptor record from the desired Apple event parameter coerced to the descriptor type specified in
desiredType
.DESCRIPTION
TheAEGetParamDesc
function returns, in theresult
parameter, the descriptor record for a specified Apple event parameter, which it attempts to coerce to the descriptor type specified by thedesiredType
parameter. Your application should call theAEDisposeDesc
function to dispose of the resulting descriptor record after your application has finished using it.If
AEGetParamDesc
returns a nonzero result code, it returns a null descriptor record unless the Apple Event Manager is not available because of limited memory.RESULT CODES
noErr 0 No error memFullErr -108 Not enough room in heap zone errAECoercionFail -1700 Data could not be coerced to the requested descriptor type errAEDescNotFound -1701 Descriptor record was not found errAENotAEDesc -1704 Not a valid descriptor record errAEReplyNotArrived -1718 Reply has not yet arrived SEE ALSO
For an example of the use ofAEGetParamDesc
, see "Getting Data Out of an Apple Event Parameter," which begins on page 4-26.