Export (0) Print
Expand All
DOM
Expand Minimize

createComment Method

Creates a comment node that contains the supplied data.

var objXMLDOMComment = oXMLDOMDocument.createComment(data);

Parameters

data

The string specifying the value to be supplied to the new Comment object's nodeValue property.

Return Value

An object. Returns the new IXMLDOMComment.

Example

The following script example creates a new comment node and appends it as the last child node of the DOMDocument object.

var xmlDoc = new ActiveXObject("Msxml2.DOMDocument.6.0");
var root;
var comment;
xmlDoc.async = false;
xmlDoc.loadXML("<root><child/></root>");
if (xmlDoc.parseError.errorCode != 0) {
   var myErr = xmlDoc.parseError;
   WScript.Echo("You have error " + myErr.reason);
} else {
   root = xmlDoc.documentElement;
   comment = xmlDoc.createComment("Hello World!");
   root.appendChild(comment);
   WScript.Echo(root.xml);
}

Output

<root><child/><!--Hello World! --></root>

HRESULT createComment(
    BSTR data,
    IXMLDOMComment **comment);

Parameters

data[in]

A value to be supplied to the new comment object's nodeValue property.

comment[out, retval]

The address of the new IXMLDOMComment object.

Return Values

S_OK

The value returned if successful.

E_INVALIDARG

The value returned if the comment parameter is Null.

E_FAIL

The value returned if an error occurs.

Creating a comment with this method is the same as using createNode where the type parameter value is NODE_COMMENT and no namespace is specified. You cannot specify a namespace with the createComment method.

Although this method creates the new object in the context of this document, it does not automatically add the new object to the document tree. In other words, although the ownerDocument property of the new node points to this document object, the parentNode property is set to Null. To add the new object, you must explicitly call one of the node insert methods, insertBefore method, replaceChild method, or appendChild method.

The new object's nodeType property has the value NODE_COMMENT.

Implemented in: MSXML 3.0 and MSXML 6.0

Show:
© 2014 Microsoft