Carbon


AEPutParamPtr

Header: AEDataModel.h Carbon status: Supported

Puts a pointer to data, a descriptor type, and a keyword into an Apple event or AE record as an Apple event parameter.

OSErr AEPutParamPtr (
    AppleEvent *theAppleEvent, 
    AEKeyword theAEKeyword, 
    DescType typeCode, 
    const void *dataPtr, 
    Size dataSize
);
Parameter descriptions
theAppleEvent

A pointer to the Apple event to add a parameter to.

theAEKeyword

The keyword for the parameter to add. If the Apple event already includes an parameter with this keyword, the parameter is replaced.

Some keyword constants are described in “Keyword Parameter Constants”.

typeCode

The descriptor type for the parameter to add. For a list of AppleScript’s predefined descriptor types, see “Descriptor Type Constants”.

dataPtr

A pointer to the data for the parameter to add.

dataSize

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

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)