Carbon


CreateOffsetDescriptor

Header: AEPackObject.h Carbon status: Supported

Creates an offset descriptor record that specifies the position of an element in relation to the beginning or end of its container.

OSErr CreateOffsetDescriptor (
    SInt32 theOffset, 
    AEDesc *theDescriptor
);
Parameter descriptions
theOffset

A positive integer that specifies the offset from the beginning of the container (the first element has an offset of 1), or a negative integer that specifies the offset from the end (the last element has an offset of –1).

theDescriptor

A pointer to a descriptor record. On successful return, the offset descriptor record created by CreateOffsetDescriptor. On error, returns a null descriptor. Your application must dispose of the descriptor record after it has finished using it.

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)