nsIConverterOutputStream

IID:4b71113a-cb0d-479f-8ed5-01daeba2e8d4
Inherits From:nsIUnicharOutputStream

This interface allows writing strings to a stream, doing automatic character encoding conversion.

This interface is implemented by the following components:


Methods

void init ( nsIOutputStream outStream , char* charset , PRUint32 bufferSize , PRUnichar replacementCharacter )

void init ( nsIOutputStream outStream , char* charset , PRUint32 bufferSize , PRUnichar replacementCharacter )

Initialize this stream. Must be called before any other method on this interface, or you will crash. The output stream passed to this method must not be null, or you will crash.

A value of 0x0000 will cause an exception to be thrown upon attempts to write unsupported characters.

Arguments:
outStream: The underlying output stream to which the converted strings will be written.
charset: The character set to use for encoding the characters. A null charset will be interpreted as UTF-8.
bufferSize: How many bytes to buffer. A value of 0 means that no bytes will be buffered. Implementations not supporting buffering may ignore this parameter.
replacementCharacter: The replacement character to use when an unsupported character is found. The character must be encodable in the selected character encoding; otherwise, attempts to write an unsupported character will throw NS_ERROR_LOSS_OF_SIGNIFICANT_DATA.

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com