Legacy Document

Inside Macintosh: QuickDraw GX Environment and Utilities /

Chapter 5 - Collection Manager / Collection Manager Reference

Functions / Getting Information About Collection Tags

GetIndexedCollectionTag

Each collection object contains a number of distinct collection tags. You can use the GetIndexedCollectionTag function to examine a specific collection tag contained in a collection.

OSErr GetIndexedCollectionTag(Collection source,
                              long whichTag,
                              CollectionTag *tag);

source

The collection from which to obtain a specific collection tag.

whichTag

The position of the desired collection tag in the source 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 source collection.

DESCRIPTION

The GetIndexedCollectionTag function returns in the tag parameter the collection tag that lies at the position specified by the whichTag parameter in the list of distinct collection tags contained in the collection referenced by the source parameter.

By sequentially incrementing the value of the whichTag parameter from 1 to the result of the CountCollectionTags function, you can use this function to determine every collection tag contained in a collection.

RESULT CODES

collectionIndexRangeErr

-5752

Index is out of range.

SEE ALSO

For information about collection tags, see "Collection Items" beginning on page 5-8. For information about data types related to collection tags, see the section "Collection Tags" beginning on page 5-49.

For an example of this function, see "Examining the Collection Tags of a Collection" beginning on page 5-35.

To determine the total number of distinct collection tags contained in a collection, use the CountCollectionTags function, described in the previous section.