Carbon


CreateRangeDescriptor

Header: AEPackObject.h Carbon status: Supported

Creates a range descriptor record that specifies a series of consecutive elements in the same container.

OSErr CreateRangeDescriptor (
    AEDesc *rangeStart, 
    AEDesc *rangeStop, 
    Boolean disposeInputs, 
    AEDesc *theDescriptor
);
Parameter descriptions
rangeStart

A pointer to an object specifier record that identifies the first Apple event object in the range.

rangeStop

A pointer to an object specifier record that identifies the last Apple event object in the range.

disposeInputs

A Boolean value. Pass (TRUE) if the function should dispose of the descriptor records for the rangeStart and rangeStop parameters and set them to the null descriptor 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.

theDescriptor

A pointer to a descriptor record. On successful return, the range descriptor record created by CreateRangeDescriptor. Your application must dispose of this descriptor record after it has finished using it.

function result

A result code.

DISCUSSION

Although the rangeStart and rangeStop parameters can be any object specifier records—including object specifier records that specify more than one Apple event object—most applications expect these parameters to specify single Apple event objects.

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)