TECCountMailTextEncodings

Counts and returns the number of currently supported e-mail encodings for a specified region.

pascal OSStatus TECCountMailTextEncodings (
RegionCode locale,
ItemCount *numberEncodings);

locale

A Mac OS region code indicating the locale for which you want to count 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).

numberEncodings

A pointer to a value of type ItemCount. On output, this value indicates the number of currently supported e-mail encodings for the region.

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

The TECCountMailTextEncodings function counts and returns the number of e-mail text encodings currently available for a specified region. This number tells you what size array you must allocate in a parameter of the function TECGetMailTextEncodings. Therefore, you should call this function before you call TECGetMailTextEncodings in order to accommodate the specifications for all of these text encodings.

TECCountMailTextEncodings counts each instance of the same encoding. That is, if different conversion plug-ins support the same e-mail text encoding for any of the conversion processes they provide, this function includes each instance of the text encoding in its sum. Consequently, the same text encoding may be counted more than once. For example, the Japanese Encodings plug-in supports Mac OS Japanese and so does the Unicode Encodings plug-in. However, since the TECGetMailTextEncodings function does not return duplicate text encoding specifications, TECCountMailTextEncodings may return a number greater than the number of array elements required.

Legacy Document

TECCountMailTextEncodings

DISCUSSION

SEE ALSO