CFBagCreateMutable

Header: CFBag.h Carbon status: Supported

Creates an empty mutable CFBag object.

CFMutableBagRef CFBagCreateMutable (
    CFAllocatorRef allocator, 
    CFIndex capacity, 
    const CFBagCallBacks *callBacks
);
Parameter descriptions
allocator

Pass a reference to an allocator object to be used to allocate memory for the CFBag object and its stored values. Pass NULL or kCFAllocatorDefault if the current default allocator should be used.

capacity

Specify the number of values that the CFBag object can contain. Pass zero if there is no limitation (other than available memory and address space) on the number of contained values.

callBacks

Pass a pointer to a CFBagCallBacks structure initialized with the callbacks to use to retain, release, describe, and compare values in the CFBag object. See CFBagCallBacks for information on the fields of this structure.

function result

A reference to a mutable CFBag object or NULL if there was a problem creating the object.

DISCUSSION

The CFBagCreateMutable function creates an empty mutable CFBag object to which you can add values using the CFBagAddValue function. The capacity parameter specifies the maximum number of values that the CFBag object can contain. If it is zero, then there is no limit to the number of values that can be added (aside from constraints such as available memory).

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)