Carbon


CreateObjSpecifier

Header: AEPackObject.h Carbon status: Supported

Assembles an object specifier record that identifies one or more Apple event objects, from other descriptor records.

OSErr CreateObjSpecifier (
    DescType desiredClass, 
    AEDesc *theContainer, 
    DescType keyForm, 
    AEDesc *keyData, 
    Boolean disposeInputs, 
    AEDesc *objSpecifier
);
desiredClass

The object class of the desired Apple event objects.

theContainer

A pointer to a descriptor record that describes the container for the requested object, usually in the form of another object specifier record.

keyForm

The key form for the object specifier record.

keyData

A pointer to a descriptor record that supplies the key data for the object specifier record.

disposeInputs

A Boolean value. Pass (TRUE) if the function should dispose of the descriptor records for the theContainer and keyData parameters or (FALSE) if your application will. A value of FALSE may be more efficient for some applications because it allows them to reuse descriptor records.

objSpecifier

On successful return, a pointer to the object specifier record created by the CreateObjSpecifier function. Your application should always call the AEDisposeDesc function to dispose of this descriptor record after it has finished using it.

function result

A result code.

AVAILABILITY

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)