CFStringGetSmallestEncoding

Header: CFString.h Carbon status: Supported

Obtains the smallest encoding on the current system for the character contents of a CFString object.

CFStringEncoding CFStringGetSmallestEncoding (
    CFStringRef theString
);
Parameter descriptions
theString

Pass a reference to the CFString object for which you want to find the smallest encoding.

function result

A constant of type CFStringEncoding that identifies a supported encoding.

DISCUSSION

The CFStringGetSmallestEncoding function obtains the supported encoding that requires the least space (in terms of bytes needed to represent one character) to represent the character contents of a CFString object. This information is not always immediately available, so this function might need to compute it.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later.


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