Carbon


TECGetWebTextEncodings

Header: TextEncodingConverter.h Carbon status: Supported

Returns the currently supported text encoding specifications for a region code.

OSStatus TECGetWebTextEncodings (
    RegionCode locale, 
    TextEncoding availableEncodings[], 
    ItemCount maxAvailableEncodings, 
    ItemCount *actualAvailableEncodings
);
Parameter descriptions
locale

A Mac OS region code. A region code designates a combination of language, writing system, and geographic region and may not correspond to a particular country (for example, Swiss French or Arabic).

availableEncodings

On return, an array that contains specifications for the currently supported text encodings in the specified region. You should use the TECCountWebTextEncodings function to determine how large an array to allocate.

maxAvailableEncodings

The number of text encodings specifications the availableEncodings array can contain.

actualAvailableEncodings

On return, a pointer to the number of text encodings specifications in the availableEncodings array.

function result

A result code.

DISCUSSION

This function ignores duplicate text encoding specifications. If you used the TECCountWebTextEncodings function to determine the size of the availableEncodings[] array the number of available encodings may be fewer than the number of array elements, because TECCountWebTextEncodings includes duplicate text encoding specifications in its count.

You can use the list of available encodings to create an encoding selection menu for a Web browser.

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)