Carbon


TECGetEncodingList

Header: TextEncodingConverter.h Carbon status: Supported

Gets the list of destination encodings from a converter object created by TECCreateOneToManyConverter. It returns the number of destination encodings and a pointer to an array of text encoding specifications.

OSStatus TECGetEncodingList (
    TECObjectRef encodingConverter, 
    ItemCount *numEncodings, 
    Handle *encodingList
);
Parameter descriptions
encodingConverter

A reference to the text encoding conversion object returned by the TECCreateOneToManyConverter function.

numEncodings

On return, a pointer to the number of encodings specified by the encodingList handle.

encodingList

A handle to an array of text encoding specifications. On return, it contains an array of text encoding specifications to which the converter object can convert. The memory for the array is allocated automatically by the Text Encoding Converter.

function result

A result code.

DISCUSSION

The TECDisposeConverter function automatically disposes of the pointer for you. This means you should not reference the pointer after you have disposed of the converter object.

Plug-ins that perform one-to-many conversions use the TECGetEncodingList function to get the output encoding list from the converter object reference.

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)