Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Up Previous Next 

PATH 
Mac OS 8 and 9 Developer Documentation > Text Encoding Conversion Manager
Programming With the Text Encoding Conversion Manager



CreateTextToUnicodeInfoByEncoding

Based on the given text encoding specification, creates and returns a Unicode converter object containing information required for converting strings from the specified non-Unicode encoding to Unicode.

pascal OSStatus CreateTextToUnicodeInfoByEncoding (
                     TextEncoding iEncoding,
                     TextToUnicodeInfo *oTextToUnicodeInfo);
iEncoding
The text encoding specification for the source text. For text encoding specifications, see Basic Text Types Reference

oTextUnicodeInfo
The Unicode converter object of type TextToUnicodeInfo returned by the function.

function result
A result code. See Text Encoding Conversion Manager Result Codes in the chapter Basic Text Types Reference

DISCUSSION

This function offers you an easier, alternative way to create a Unicode converter than with the function CreateTextToUnicodeInfo because you do not need to create a Unicode mapping structure. You simply specify the text encoding of the source text. However, this method is less efficient because the text encoding parameter must be resolved internally into a Unicode mapping.

Using this function, you cannot specify a version of Unicode, so a default version of Unicode is used; 16-bit format is assumed.

You pass a Unicode converter object returned from CreateTextToUnicodeInfoByEncoding to the function ConvertFromTextToUnicode or ConvertFromPStringToUnicode to identify the information to be used for the conversion. These two functions modify the contents of the Unicode converter object.

You pass a Unicode converter object returned from CreateTextToUnicodeInfoByEncoding to the function TruncateForTextToUnicode to identify the information to be used to truncate the string. This function does not modify the contents of the Unicode converter object.

If you are converting the text stream to Unicode as an intermediary encoding, and then from Unicode to the final destination encoding, you use the function CreateUnicodeToTextInfo to create a Unicode converter object for the second part of the process.

SEE ALSO

CreateTextToUnicodeInfo

Text Encoding Base


© 1999 Apple Computer, Inc. – (Last Updated 13 Dec 99)

Up Previous Next