xml.DomDocument.createComment

Creates an XML Comment DomNode object for a DomDocument object.

Syntax

createComment(
   comment STRING )  
  RETURNING object xml.DomNode

comment is the data of the XML Comment node.

Usage

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

Returns a 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 an XML Comment node. The saveToFile() and normalize() methods will fail if this sequence or characters other than those allowed exist in a Comment 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).