IXMLDOMDocument::createComment Method

Creates a comment node that contains the supplied data.

Visual Basic Syntax

Set objXMLDOMComment = oXMLDOMDocument.createComment(data)

C/C++ Syntax

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

Parameters

data [in]: Value to be supplied to the new comment object's nodeValue property.
comment [out]: Address of the new XMLDOMComment object.

C/C++ Return Values

S_OK: Value returned if successful.
E_INVALIDARG: Value returned if comment is Null.
E_FAIL: 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 within the data parameter.

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.