MDN may have intermittent access issues April 18 13:00 - April 19 01:00 UTC. See whistlepig.mozilla.org for all notifications.

mozilla
Your Search Results

    nsIConverterOutputStream

    This interface allows writing strings to a stream, doing automatic character encoding conversion.
    1.0
    28
    Introduced
    Gecko 1.8
    Inherits from: nsIUnicharOutputStream Last changed in Gecko 1.8 (Firefox 1.5 / Thunderbird 1.5 / SeaMonkey 1.0)

    Implemented by: @mozilla.org/intl/converter-output-stream;1. To create an instance, use:

    var converterOutputStream = Components.classes["@mozilla.org/intl/converter-output-stream;1"]
                                .createInstance(Components.interfaces.nsIConverterOutputStream);
    

    Method overview

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

    Methods

    init()

    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.

    void init(
      in nsIOutputStream aOutStream,
      in string aCharset,
      in unsigned long aBufferSize,
      in PRUnichar aReplacementCharacter
    );
    
    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. A value of 0x0000 will cause an exception to be thrown upon attempts to write unsupported characters.
    Exceptions thrown
    NS_ERROR_LOSS_OF_SIGNIFICANT_DATA
    If aReplacementCharacter is not encodable in the selected character encoding and an attempt is made to write the character.

    See also

    Document Tags and Contributors

    Contributors to this page: Sheppy, trevorh, JacobBramley
    Last updated by: Sheppy,