WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsIDOMParser

IID:5677f36e-1842-4c6f-a39c-2e5576ab8b40
Inherits From:nsISupports

The nsIDOMParser interface is a non-SAX interface that can be used to parse a string or byte stream containing XML or HTML content to a DOM document. Parsing is always synchronous - a document is always returned from the parsing methods. This is as opposed to loading and parsing with the XMLHttpRequest interface, which can be used for asynchronous (callback-based) loading.

This interface is implemented by the following components:

Methods

[noscript] void init ( nsIPrincipal principal , nsIURI documentURI , nsIURI baseURI , nsIScriptGlobalObject scriptObject ) nsIDOMDocument parseFromBuffer ( arrayof PRUint8 buf , PRUint32 bufLen , char* contentType ) nsIDOMDocument parseFromStream ( nsIInputStream stream , char* charset , PRInt32 contentLength , char* contentType ) nsIDOMDocument parseFromString ( PRUnichar* str , char* contentType )

void init ( nsIPrincipal principal , nsIURI documentURI , nsIURI baseURI , nsIScriptGlobalObject scriptObject )

Initialize the principal and document and base URIs that the parser should use for documents it creates. If this is not called, then a null principal and its URI will be used. When creating a DOMParser via the JS constructor, this will be called automatically. This method may only be called once. If this method fails, all following parse attempts will fail.

Arguments:
principal: The principal to use for documents we create. If this is null, a codebase principal will be created based on documentURI; in that case the documentURI must be non-null.
documentURI: The documentURI to use for the documents we create. If null, the principal's URI will be used; in that case, the principal must be non-null and its URI must be non-null.
baseURI: The baseURI to use for the documents we create. If null, the documentURI will be used.
scriptObject: The object from which the context for event handling can be got.

nsIDOMDocument parseFromBuffer ( arrayof PRUint8 buf , PRUint32 bufLen , char* contentType )

The buffer is parsed into a DOM document. The charset is determined from the xml entity decl.

Arguments:
buf: The octet array data to be parsed
bufLen: Length (in bytes) of the data
contentType: The content type of the data (see parseFromStream)

nsIDOMDocument parseFromStream ( nsIInputStream stream , char* charset , PRInt32 contentLength , char* contentType )

The byte stream passed in is parsed into a DOM document.

Not accessible from web content.

Arguments:
stream: The byte stream whose contents are parsed
charset: The character set that was used to encode the byte stream. NULL if not specified.
contentLength: The number of bytes in the input stream.
contentType: The content type of the string - either text/xml, application/xml, or application/xhtml+xml. Must not be NULL.

nsIDOMDocument parseFromString ( PRUnichar* str , char* contentType )

The string passed in is parsed into a DOM document.

Arguments:
str: The UTF16 string to be parsed
contentType: The content type of the string (see parseFromStream)

Reference documentation is generated from Mozilla's source.