Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIDOMSerializer Interface Reference

The nsIDOMSerializer interface is really a placeholder till the W3C DOM Working Group defines a mechanism for serializing DOM nodes. More...

import "nsIDOMSerializer.idl";

Inheritance diagram for nsIDOMSerializer:
Inheritance graph
[legend]
Collaboration diagram for nsIDOMSerializer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

AString serializeToString (in nsIDOMNode root)
 The subtree rooted by the specified element is serialized to a string.
void serializeToStream (in nsIDOMNode root, in nsIOutputStream stream, in AUTF8String charset)
 The subtree rooted by the specified element is serialized to a byte stream using the character set specified.

Detailed Description

The nsIDOMSerializer interface is really a placeholder till the W3C DOM Working Group defines a mechanism for serializing DOM nodes.

An instance of this interface can be used to serialize a DOM document or any DOM subtree.

Definition at line 51 of file nsIDOMSerializer.idl.


Member Function Documentation

void nsIDOMSerializer::serializeToStream ( in nsIDOMNode  root,
in nsIOutputStream  stream,
in AUTF8String  charset 
)

The subtree rooted by the specified element is serialized to a byte stream using the character set specified.

Parameters:
rootThe root of the subtree to be serialized. This could be any node, including a Document.
streamThe byte stream to which the subtree is serialized.
charsetThe name of the character set to use for the encoding to a byte stream.

The subtree rooted by the specified element is serialized to a string.

Parameters:
rootThe root of the subtree to be serialized. This could be any node, including a Document.
Returns:
The serialized subtree in the form of a Unicode string

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