createComment Method

Creates a comment node that contains the supplied data.

objXMLDOMComment = oXMLDOMDocument.createComment(data)

Parameters

data

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

Return Value

Object. Returns the new XMLDOMComment object.

Remarks

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. You must explicitly call one of the node insert methods—insertBefore, replaceChild, or appendChild—to add the new object.

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

Example

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

Dim xmlDoc
Dim root
Dim comment
Set xmlDoc = CreateObject("Msxml2.DOMDocument")
xmlDoc.async = False
xmlDoc.load("c:\books.xml")
Set root = xmlDoc.documentElement
Set comment = xmlDoc.createComment("Hello World!")
root.appendChild comment
Msgbox (root.xml)

See Also

Applies To: DOMDocument Object