Kernel APIs: $$EN^MXMLDOM

$$EN^MXMLDOM(): XML—Initial Processing, Build In-memory Image

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

Description

The $$EN^MXMLDOM extrinsic function performs initial processing of the XML document. The client application must first call this entry point to build the in-memory image of the document before the remaining methods can be applied. The return value is a handle to the document instance that was created and is used by the remaining API calls to identify a specific document instance. The parameters for this entry point are listed by type, requirement (yes or no), and description.

Format

  $$EN^MXMLDOM(doc[,opt])

Input Parameters

doc:

(required) This string is either of the following:

Closed reference to a global root containing the document
Filename and path reference identifying the document on the host system.

If a global root is passed, the document either:

Must be stored in standard VA FileMan word-processing format.
May occur in sequentially numbered nodes below the root node.

Thus, if the global reference is ^XYZ, the global must be of one of the following formats:

^XYZ(1,0) = "LINE 1"

^XYZ(2,0) = "LINE 2" ...

Or:

^XYZ(1) = "LINE 1"

^XYZ(2) = "LINE 2" ...

opt:

(optional) This string is a list of option flags that control parser behavior. Recognized option flags are:

W—Do not report warnings to the client.
V—Validate the document. If not specified, the parser only checks for conformance.
1—Terminate parsing on encountering a validation error. (By default, the parser terminates only when a conformance error is encountered.)
0—Terminate parsing on encountering a warning.

Output

returns:

Returns:

Successful—A non-zero handle of document instance if parsing completed successfully.
Unsuccessful—Zero handle of document instance.

This handle is passed to all other API methods to indicate which document instance is being referenced. This allows for multiple document instances to be processed concurrently.