Public Member Functions

nsIConverterOutputStream Interface Reference

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

import "nsIConverterOutputStream.idl";

Inheritance diagram for nsIConverterOutputStream:
Collaboration diagram for nsIConverterOutputStream:

List of all members.

Public Member Functions

void init (in nsIOutputStream aOutStream, in string aCharset, in unsigned long aBufferSize, in PRUnichar aReplacementCharacter)
 Initialize this stream.

Detailed Description

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


Member Function Documentation

void nsIConverterOutputStream::init ( in nsIOutputStream  aOutStream,
in string  aCharset,
in unsigned long  aBufferSize,
in PRUnichar  aReplacementCharacter 
)

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.

Parameters:
aOutStream The underlying output stream to which the converted strings will be written.
aCharset The character set to use for encoding the characters. A null charset will be interpreted as UTF-8.
aBufferSize How many bytes to buffer. A value of 0 means that no bytes will be buffered. Implementations not supporting buffering may ignore this parameter.
aReplacementCharacter 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.

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


The documentation for this interface was generated from the following file: