WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIConverterInputStream

IID:FC66FFB6-5404-4908-A4A3-27F92FA0579D
Inherits From:nsIUnicharInputStream

A unichar input stream that wraps an input stream. This allows reading unicode strings from a stream, automatically converting the bytes from a selected character encoding.

Constants

Default replacement char value, U+FFFD REPLACEMENT CHARACTER.
PRUnichar DEFAULT_REPLACEMENT_CHARACTER = 65533

Methods

void init ( nsIInputStream stream , char* charset , PRInt32 bufferSize , PRUnichar replacementChar )

void init ( nsIInputStream stream , char* charset , PRInt32 bufferSize , PRUnichar replacementChar )

Initialize this stream.

Arguments:
stream: The underlying stream to read from.
charset: The character encoding to use for converting the bytes of the stream. A null charset will be interpreted as UTF-8.
bufferSize: How many bytes to buffer.
replacementChar: The character to replace unknown byte sequences in the stream with. The standard replacement character is U+FFFD. A value of 0x0000 will cause an exception to be thrown if unknown byte sequences are encountered in the stream.

Reference documentation is generated from Mozilla's source.