Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

CMNT^MXMLDOM(): XML—Extract Comment Text (True/False)

Reference Type: Supported, Category: XML Parser (VistA), ICR#: 3561

Description

The CMNT^MXMLDOM API extracts comment text associated with the specified node.

Format

  CMNT^MXMLDOM(handle,node,text)

Input Parameters

handle:

(required) The value (integer) returned by the $$EN^MXMLDOM API, which created the in-memory document image.
node:

(required) The node (integer) in the document tree that is being referenced by this API.
text:

(required) This input parameter (string) must contain a closed local or global array reference that is to receive the text. The specified array is deleted before being populated.

Output

returns:

Returns a Boolean value:

  • True (non-zero)—Text was retrieved.

  • False (zero)—Text was not retrieved.