createComment Method (Compact 2013)

  • Article

3/26/2014

Creates a comment node that contains the supplied data.

Syntax

var objXMLDOMComment = oXMLDOMDocument.createComment(data);

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

Parameters

Script

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

C/C++

  • data
    [in] Value to be supplied to the new comment object's nodeValue property.

Return Value

Script

Object. Returns the new IXMLDOMComment.

C/C++

  • 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 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.

This method applies to the following objects and interfaces:

DOMDocument and IXMLDOMComment.

Requirements

Header

msxml2.h,
msxml2.idl

Library

uuid.lib

See Also

Reference

XML DOM Methods
appendChild Method
createNode Method
insertBefore Method
replaceChild Method
nodeType Property
nodeValue Property
ownerDocument Property
parentNode Property