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

DisposeUnicodeToTextRunInfo

Releases the memory allocated for the specified Unicode converter object.

pascal OSStatus DisposeUnicodeToTextRunInfo (
                     UnicodeToTextRunInfo *ioUnicodeToTextRunInfo);
ioUnicodeToTextRunInfo
A pointer to a Unicode converter object. On input, you specify a Unicode converter object that points to the conversion information to be disposed of, which your application created using the function CreateUnicodeToTextRunInfo, CreateUnicodeToTextRunInfoByEncoding, or CreateUnicodeToTextRunInfoByScriptCode.

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

DISCUSSION

The DisposeUnicodeToTextRunInfo function disposes of the Unicode converter object specified by the ioUnicodeToTextRunInfo parameter and releases the memory allocated for it. Your application should not attempt to dispose of the same Unicode converter object more than once.

You must use this function to release the memory only for a Unicode converter object that your application created through the function CreateUnicodeToTextRunInfo, CreateUnicodeToTextRunInfoByEncoding, or CreateUnicodeToTextRunInfoByScriptCode.

You must not use it for any other type of Unicode converter object.

If your application specifies an invalid Unicode converter object, such as NULL, the function returns paramErr.

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

Up Previous Next