Carbon


TECCountSubTextEncodings

Header: TextEncodingConverter.h Carbon status: Supported

Counts and returns the number of subencodings a text encoding supports.

OSStatus TECCountSubTextEncodings (
    TextEncoding inputEncoding, 
    ItemCount *numberOfEncodings
);
Parameter descriptions
inputEncoding

The text encoding specification that contains the subencodings.

numberOfEncodings

On return, a pointer to the number of currently supported subencodings. You use this value to determine the array size for a parameter of the TECGetSubTextEncodings function.

function result

A result code.

DISCUSSION

Subencodings are text encodings that are embedded as part of a larger text encoding specification. For example, EUC-JP contains JIS Roman or ASCII, JIS X0208, JIS X0212, and half-width Katakana from JIS X0201. Not every encoding that can be broken into multiple encodings necessarily supports this routine. It’s up to the plug-in developer to decide which encodings might be useful to break up. Subencodings are not the same as text encoding variants.

If an encoding can be converted to multiple runs of encodings (as indicated by a destination base encoding of kTextEncodingMultiRun), you can call the TECGetSubTextEncodings function to get the list of output encodings. See the TECCreateOneToManyConverter and TECGetDestinationTextEncodings functions for information.

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)