Carbon


GetIndexedCollectionTag

Header: Collections.h Carbon status: Supported

Examines a specific collection tag contained in a collection.

OSErr GetIndexedCollectionTag (
    Collection c, 
    SInt32 tagIndex, 
    CollectionTag *tag
);
Parameter descriptions
c

The collection from which to obtain a specific collection tag. The behavior of this function is undefined if you do not provide a reference to a valid collection object.

tagIndex

The position of the desired collection tag in the c collection’s list of distinct collection tags.

tag

A pointer to a collection tag. On return, the collection tag that lies at the specified position in the list of distinct collection tags contained in the c collection.

function result

A result code.

DISCUSSION

Each collection object contains a number of distinct collection tags. By sequentially incrementing the value of the tagIndex parameter from 1 to the result of the CountCollectionTags function, you can use this function to determine every collection tag contained in a collection.

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)