![]() |
GetIndexedCollectionItemInfo |
||||
Header: | Collections.h | Carbon status: | Supported | |
Obtains information about a specific collection item given the items collection index.
OSErr GetIndexedCollectionItemInfo ( Collection c, SInt32 index, CollectionTag *tag, SInt32 *id, SInt32 *itemSize, SInt32 *attributes );
A reference to the collection object containing the item you want to obtain information about. The behavior of this function is undefined if you do not provide a reference to a valid collection object.
The collection index associated with the item you want to obtain information about.
A pointer to a collection tag. On return, the collection tag associated with the specified item. You may specify the constant dontWantTag for this parameter if you do not want to determine the specified items collection tag.
A pointer to an SInt32 value. On return, the collection ID associated with the specified item. You may specify the constant dontWantId for this parameter if you do not want to determine the specified items collection ID.
A pointer to an SInt32 value. On return, this value indicates the size in bytes of the data associated with the specified item. You may specify the constant dontWantSize for this parameter if you do not want to determine the specified items data size.
A pointer to an SInt32 value. On return, this value contains a copy of the attributes associated with the specified item. You may specify the constant dontWantAttributes for this parameter if you do not want a copy of the items attributes.
A result code.
To obtain information about a collection item using the collection tag and collection ID to specify the item, use the GetCollectionItemInfo function.
To obtain information about a collection item using the collection tag and tag list position to specify the item, use the GetTaggedCollectionItemInfo function.
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)