CFBagCreateCopy

Header: CFBag.h Carbon status: Supported

Creates an immutable CFBag object from the contents of an existing CFBag object.

CFBagRef CFBagCreateCopy (
    CFAllocatorRef allocator, 
    CFBagRef bag
);
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.

bag

Pass a reference to the CFBag object to be copied.

function result

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

DISCUSSION

The CFBagCreateCopy function creates an immutable copy of an existing CFBag object. The values are copied as pointers into the new CFBag object (that is, values are themselves copied, not that which they point to). The callbacks that the original uses to retain, release, compare, and describe values are reused for the copy.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


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