CreateTextToUnicodeInfo

Creates and returns a Unicode converter object containing information required for converting strings from a non-Unicode encoding to Unicode.

pascal OSStatus CreateTextToUnicodeInfo (
ConstUnicodeMappingPtr iUnicodeMapping,
TextToUnicodeInfo *oTextToUnicodeInfo);

iUnicodeMapping

A pointer to a structure of type UnicodeMapping . Your application provides this structure to identify the mapping to be used for the conversion. The unicodeEncoding field of this structure can specify a Unicode format of kUnicode16BitFormat or kUnicodeUTF8Format. Versions of the Unicode Converter prior to 1.2.1 do not support kUnicodeUTF8Format.

oTextToUnicodeInfo

On output, the parameter returns a Unicode converter object that holds mapping table information you supply as the UnicodeMapping parameter and state information related to the conversion. This information is required for conversion of a text stream in a non-Unicode encoding to Unicode.

function result

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

DISCUSSION

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

You pass a Unicode converter object returned from CreateTextToUnicodeInfo 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.

In addition to various resource and memory errors that it can return, the function can return the following result codes:

kTextUnsupportedEncodingErr One of the encodings specified by the Unicode mapping structure you supply is not currently supported.
kTECMissingTableErr A resource associated with one of the encodings is missing.
kTECTableChecksumErr A resource has an invalid checksum, indicating that it has become corrupted.

If an error is returned, the Unicode converter object is invalid

Legacy Document

CreateTextToUnicodeInfo

DISCUSSION

SEE ALSO