Function

CFCopyDescription

Returns a textual description of a Core Foundation object.

Declaration

CFStringRef CFCopyDescription(CFTypeRef cf);

Parameters

cf

The CFType object (a generic reference of type CFTypeRef) from which to derive a description.

Return Value

A string that contains a description of cf. Ownership follows the The Create Rule.

Discussion

The nature of the description differs by object. For example, a description of a CFArray object would include descriptions of each of the elements in the collection.

You can use this function for debugging Core Foundation objects in your code. Note, however, that the description for a given object may be different in different releases of the operating system. Do not create dependencies in your code on the content or format of the information returned by this function.

See Also

Miscellaneous Functions

CFCopyTypeIDDescription

Returns a textual description of a Core Foundation type, as identified by its type ID, which can be used when debugging.

CFGetTypeID

Returns the unique identifier of an opaque type to which a Core Foundation object belongs.

CFShow

Prints a description of a Core Foundation object to stderr.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software