Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Up Previous Next 

PATH Mac OS 8 and 9 Developer Documentation > Text Encoding Conversion Manager
Programming With the Text Encoding Conversion Manager

TECGetWebTextEncodings

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

pascal OSStatus TECGetWebTextEncodings (
                     RegionCode locale,
                     TextEncoding availableEncodings[],
                     ItemCount maxAvailableEncodings,
                     ItemCount *actualAvailableEncodings);
locale
A Mac OS region code indicating the locale for which you want to obtain encodings. A region code designates a combination of language, writing system, and geographic region; the region may not correspond to a particular country (for example, Swiss French or Arabic).

availableEncodings[]
An array of text encoding specifications. On return, the array contains specifications for the currently supported text encodings in the specified region. To determine how large an array to allocate, use the function TECGetWebTextEncodings.

maxAvailableEncodings
The number of text encoding specifications the availableEncodings array can contain.

actualAvailableEncodings
A pointer to a value of type ItemCount. On output, this value indicates the number of text encodings the function returned in the availableEncodings array.

function result
A result code. See Text Encoding Conversion Manager Result Codes for a list of possible values. If other than noErr, then one of the text conversion plug-ins encountered an error when polled by the Text Encoding Converter.

DISCUSSION

For a specified Mac OS region code, TECGetWebTextEncodings fills in an array of type TextEncoding with a list of encodings commonly found on the World Wide Web for that region. The function eliminates any duplicate information in the process, so the number of encodings TECGetWebTextEncodings returns in the availableEncodings array may be fewer than the number of elements you allocated for the array based on your call to TECCountWebTextEncodings. TECGetWebTextEncodings tells you the number of specifications it returns in the actualAvailableEncodings parameter.

The list of available encodings could be used for an encoding selection menu found in many Web browsers.

SEE ALSO

The function TECCountAvailableTextEncodings

The function TECGetAvailableTextEncodings

The function TECGetTextEncodingFromInternetName

The function GetTextEncodingName

The region codes section of "Script Manager" in Inside Macintosh: Text

© 1999 Apple Computer, Inc. – (Last Updated 13 Dec 99)

Up Previous Next