Back to index

lightning-sunbird  0.9+nobinonly
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:
Inheritance graph
[legend]
Collaboration diagram for nsIConverterOutputStream:
Collaboration graph
[legend]

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.
boolean write (in unsigned long aCount,[const, array, size_is(aCount)] in PRUnichar c)
 Write a single character to the stream.
boolean writeString (in AString str)
 Write a string to the stream.
void flush ()
 Flush the stream.
void close ()
 Close the stream and free associated resources.

Detailed Description

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

Definition at line 47 of file nsIConverterOutputStream.idl.


Member Function Documentation

Close the stream and free associated resources.

This also closes the underlying stream.

Flush the stream.

This finishes the conversion and writes any bytes that finish the current byte sequence.

It does NOT flush the underlying stream.

See also:
nsIUnicodeEncoder::Finish
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:
aOutStreamThe underlying output stream to which the converted strings will be written.
aCharsetThe character set to use for encoding the characters. A null charset will be interpreted as UTF-8.
aBufferSizeHow many bytes to buffer. A value of 0 means that no bytes will be buffered. Implementations not supporting buffering may ignore this parameter.
aReplacementCharacterThe 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.

boolean nsIUnicharOutputStream::write ( in unsigned long  aCount,
[const, array, size_is(aCount)] in PRUnichar  c 
) [inherited]

Write a single character to the stream.

When writing many characters, prefer the string-taking write method.

Return values:
trueThe character was written successfully
falseNot all bytes of the character could be written.
boolean nsIUnicharOutputStream::writeString ( in AString  str) [inherited]

Write a string to the stream.

Return values:
trueThe string was written successfully
falseNot all bytes of the string could be written.

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