createComment Method
A version of this page is also available for
4/8/2010
Creates a comment node that contains the supplied data.
Script Syntax
var objXMLDOMComment = oXMLDOMDocument.createComment(data);
Remarks
Script Parameters
- data
String specifying the value to be supplied to the new Comment object's nodeValue property.
Script Return Value
Object. Returns the new IXMLDOMComment.
C/C++ Syntax
HRESULT createComment(
BSTR data,
IXMLDOMComment** comment
);
Remarks
C/C++ Parameters
- data
[in] Value to be supplied to the new comment object's nodeValue property.
- comment
[out, retval] Address of the new IXMLDOMComment 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.
Requirements
| Header | msxml2.h, msxml2.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
General 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.
See Also
Concepts
appendChild Method
createNode Method
insertBefore Method
replaceChild Method
nodeType Property
nodeValue Property
ownerDocument Property
parentNode Property