Carbon


TECGetDestinationTextEncodings

Header: TextEncodingConverter.h Carbon status: Supported

Returns the encoding specifications for all the destination text encodings to which the Text Encoding Converter can directly convert the specified source encoding.

OSStatus TECGetDestinationTextEncodings (
    TextEncoding inputEncoding, 
    TextEncoding destinationEncodings[], 
    ItemCount maxDestinationEncodings, 
    ItemCount *actualDestinationEncodings
);
Parameter descriptions
inputEncoding

The text encoding specification describing the source text.

destinationEncodings

On return, an array of specifications for the destination encodings to which the converter can directly convert the source encoding. You should use the TECCountDestinationTextEncodings function to determine how large an array to allocate.

maxDestinationEncodings

The maximum number of destination text encodings that the array can contain.

actualDestinationEncodings

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

function result

A result code.

DISCUSSION

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

You can display the names of these destination encodings to the user.

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)