xml.DomDocument.createComment

Creates a XML Comment DomNode object for a DomDocument object.

Syntax

createComment(
   cmt STRING )  
  RETURNS xml.DomNode
  1. cmt defines the data of the XML Comment node.

Usage

Creates a XML Comment DomNode object for this DomDocument object, where cmt is the data of the XML Comment node, or NULL.

Returns the XML element DomNode object, or NULL.

Only the characters #x9, #xA, #xD, [#x20-#xD7FF], [#xE000-#xFFFD] and [#x10000-#x10FFFF] are allowed in the content of an XML Comment node.

The character sequence (Double-Hyphen) '--' is not allowed in the content of a XML CDATASection node. The save and normalize methods will fail if the sequence of characters other than those allowed exist in a CDATASection node.

In case of error, the method throws an exception and sets the STATUS variable. Depending on the error, a human-readable description of the problem is available in the SQLCA.SQLERRM register. See Error handling in GWS calls (STATUS).