createComment Method
Creates a comment node that contains the supplied data.
Script Syntax
var objXMLDOMComment = oXMLDOMDocument.createComment(data);
Parameters
- data
- The string specifying the value to be supplied to the new
Comment
object'snodeValue
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.5.0"); var root; var comment; xmlDoc.async = false; xmlDoc.load("books.xml"); if (xmlDoc.parseError.errorCode <> 0) { var myErr = xmlDoc.parseError; alert("You have error " + myErr.reason); } else { root = xmlDoc.documentElement; comment = xmlDoc.createComment("Hello World!"); root.appendChild(comment); alert(root.xml); }
Visual Basic Syntax
Set objXMLDOMComment = oXMLDOMDocument.createComment(data)
Parameters
- data
- A string specifying the value to be supplied to the new
Comment
object'snodeValue
property.
Return Value
An object. Returns the new IXMLDOMComment
.
Example
The following Visual Basic example creates a new comment node and appends it as the last child node of the DOMDocument
object.
Dim xmlDoc As New Msxml2.DOMDocument50 Dim root As IXMLDOMElement Dim comment As IXMLDOMComment xmlDoc.async = False xmlDoc.Load ("books.xml") If (xmlDoc.parseError.errorCode <> 0) Then Dim myErr Set myErr = xmlDoc.parseError MsgBox("You have error " & myErr.reason) Else Set root = xmlDoc.documentElement Set comment = xmlDoc.createComment("Hello World!") root.appendChild comment MsgBox (root.xml) End If
C/C++ Syntax
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.
C/C++ 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.
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. 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
.
To view reference information for Visual Basic, C/C++, or Script only, click the Language Filter button in the upper-left corner of the page.
See Also
createNode Method | ownerDocument Property | parentNode Property | insertBefore Method | replaceChild Method | appendChild Method | nodeType Property | nodeValue Property | IXMLDOMComment
Applies to: DOMDocument