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

$$CHILD^MXMLDOM(): XML—Get Parent Node’s First or Next Child

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

Description

The $$CHILD^MXMLDOM extrinsic function returns the node of the first or next child of a given parent node, or zero (0) if there are none remaining.

Format

  $$CHILD^MXMLDOM(handle,parent[,child])

Input Parameters

handle:

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

(required) The node (integer) whose children are being retrieved.
child:

(optional) If specified, this is the last child node (integer) retrieved. The function returns the next child in the list. If the parameter is zero or missing, the first child is returned.

Output

returns:

Returns:

  • Child Node—The next child node (integer).

  • Zero (0)—If there are none remaining.