Carbon


TECGetMailTextEncodings

Header: TextEncodingConverter.h Carbon status: Supported

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

OSStatus TECGetMailTextEncodings (
    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; 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 e-mail text encodings for a region code. You should use the function TECCountMailTextEncodings function to determine what size array to allocate.

maxAvailableEncodings

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

actualAvailableEncodings

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

function result

A result code.

DISCUSSION

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

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)