Carbon


PurgeCollectionTag

Header: Collections.h Carbon status: Supported

Removes all items with a specific collection tag from a collection.

void PurgeCollectionTag (
    Collection c, 
    CollectionTag tag
);
c

A reference to the collection object containing the items you want to remove. The behavior of this function is undefined if you do not provide a reference to a valid collection object.

tag

The collection tag associated with the items to remove.

DISCUSSION

The PurgeCollectionTag function removes from the c collection all items whose collection tag matches the value of the tag parameter. This function removes locked and unlocked items.

To remove all of the items in a collection whose attributes match a specified pattern, use the PurgeCollection function.

To remove every item in a collection, use the EmptyCollection function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)