Carbon


TECClearConverterContextInfo

Header: TextEncodingConverter.h Carbon status: Supported

Resets a converter object to its initial state so you can reuse it.

OSStatus TECClearConverterContextInfo (
    TECObjectRef encodingConverter
);
Parameter descriptions
encodingConverter

A reference to the text encoding converter object you want to reset. It can be a reference returned by the TECCreateConverter, TECCreateOneToManyConverter, or TECCreateConverterFromPath functions.

function result

A result code.

DISCUSSION

It is more efficient to reuse an existing converter object than to create a new one that contains the same conversion information. This function clears the text string, but does not alter the source and destination encodings.

If you are converting multiple segments of a text string, you should not clear the converter object until you have converted all the text segments.

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)