Legacy Document

Inside Macintosh: Interapplication Communication /

Chapter 5 - Creating and Sending Apple Events / Reference to Creating and Sending Apple Events

Routines for Creating and Sending Apple Events / Adding Parameters and Attributes to Apple Events

AEPutParamPtr

You can use the AEPutParamPtr function to add a pointer to data, a descriptor type, and a keyword to an Apple event as an Apple event parameter.

FUNCTION AEPutParamPtr (theAppleEvent: AppleEvent; 
                        theAEKeyword: AEKeyword; 
                        typeCode: DescType; dataPtr: Ptr; 
                        dataSize: Size): OSErr;

theAppleEvent

The Apple event to which to add a parameter.

theAEKeyword

The keyword for the parameter to be added. If the Apple event already included a parameter with this keyword, the parameter is replaced.

typeCode

The descriptor type for the parameter.

dataPtr

A pointer to the data for the parameter.

dataSize

The length, in bytes, of the data for the parameter.

RESULT CODES

noErr	0	No error
memFullErr	-108	Not enough room in heap zone
errAEWrongDataType	-1703	Wrong descriptor type
errAENotAEDesc	-1704	Not a valid descriptor record
errAEBadListItem	-1705	Operation involving a list item failed

SEE ALSO

For an example of the use of AEPutParamPtr, see "Adding Parameters to an Apple Event," which begins on page 5-5.