Important: The information in this document is obsolete and should not be used for new development.
AEGetKeyPtr
You can use theAEGetKeyPtr
function to get a pointer to a buffer that contains the data from a keyword-specified descriptor record. You can use this function to get data from an AE record or an Apple event record.
FUNCTION AEGetKeyPtr (theAERecord: AERecord; theAEKeyword: AEKeyword; desiredType: DescType; VAR typeCode: DescType; dataPtr: Ptr; maximumSize: Size; VAR actualSize: Size): OSErr;
theAERecord
The AE record containing the desired data.theAEKeyword
- The keyword that specifies the desired descriptor record.
desiredType
- The desired descriptor type for the data to be returned; if the requested data 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 returned data is the same as the descriptor type of the original data.typeCode
- The descriptor type of the returned data.
dataPtr
- A pointer to the buffer for storing the data.
maximumSize
The maximum length, in bytes, of the data to be returned. You must allocate at least this amount of storage for the buffer specified by thedataPtr
parameter.actualSize
- The length, in bytes, of the data for the keyword-specified descriptor record. If this value is larger than the value of the
maximumSize
parameter, not all of the data for the parameter was returned.DESCRIPTION
TheAEGetKeyPtr
function uses a buffer to return the data from a keyword-specified Apple event parameter, which the function attempts to coerce to the descriptor type specified by thedesiredType
parameter.RESULT CODES