Carbon


CreateTextEncoding

Header: TextCommon.h Carbon status: Supported

Creates and returns a text encoding specification.

TextEncoding CreateTextEncoding (
    TextEncodingBase encodingBase, 
    TextEncodingVariant encodingVariant, 
    TextEncodingFormat encodingFormat
);
Parameter descriptions
encodingBase

A base text encoding of type TextEncodingRun.

encodingVariant

A variant of the base text encoding. To specify the default variant for the base encoding given in the encodingBase parameter, you can use the kTextEncodingDefaultVariant constant.

encodingFormat

A format for the base text encoding. To specify the default format for the base encoding, you can use the kTextEncodingDefaultFormat constant.

function result

The text encoding specification that the function creates from the values you pass it.

DISCUSSION

When you create a text encoding specification, the three values that you specify are packed into an unsigned integer, which you can then pass by value to the functions that use text encodings. See the data type TextEncodingRun.

AVAILABILITY

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


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)