Print (XmlDoc/XmlNode subroutine)
The Print subroutine displays an XmlDoc subtree in a readable form, useful for debugging, for example.
nr:Print[( [xpath], [options])] Throws XPathError
|nr||An XmlDoc or XmlNode, used as the context node for the XPath expression. If an XmlDoc, the Root node is the context node.|
|xpath||A Unicode string that is an XPath expression that results in a nodelist, the head of which is the top of the subtree to print. Any other nodes in the nodelist are ignored.
This is an optional argument, and its default is a period (
|options||A blank delimited string that can contain one or more of the following options. |
Note: These options are described in greater detail in XmlDoc API serialization options.
- Options may be specified in any case. For example, you can use either
- As a debugging aide, Print may be issued for the root node of an XmlDoc that is not well-formed, that is, does not contain an Element.
- As of Sirius Mods Version 7.6, Attribute values are always serialized within double-quotation-mark (
") delimiters, and a double-quotation mark character in an attribute value is serialized as
". Prior to Sirius Mods Version 7.6, this convention was not strictly observed.
- In the following example, the Print method is called first in its default form with no arguments, then with explicit values for its options:
begin print 'Print method' print '***********' %doc is object xmlDoc %doc = new call %doc:loadXml('<top><a><b>05</b></a><a2/></top>') %doc:Version ='1.0' call %doc:print print 'Non-default display:' call %doc:print('/', 'NoXmlDecl NoEmptyElt Indent 6 Expanded') end
The example results follow:
<?xml version="1.0"?> <top> <a> <b>05</b> </a> <a2/> </top> Non-default display: <top> <a> <b> 05 </b> </a> <a2> </a2> </top>
- In the following fragment, the Print result for a document with untranslatable Unicode is shown:
%doc2:addElement('circumference', '2 * π * r':U) %doc2:print
The result follows (the Unicode codepoint for the Greek letter π has the hexadecimal value 03C0):
<circumference>2 * π * r</circumference>
This list is not exhaustive: it does not include all the errors that are request cancelling.
- The xpath expression is invalid.
- The result of xpath is empty.
- options values are invalid.
- Insufficient free space exists in CCATEMP.
- For more information about using XPath expressions, see XPath.
- To more accurately serialize an XmlDoc, as opposed to providing a "displayable" form, use the Serial function. The Print subroutine, like its analogs Audit and Trace, inserts line breaks and performs indentation.
- See the description of Unicode to EBCDIC conversion performed by Print.
- For additional discussion about serialization, see Transport: receiving and sending XML.
- Additional serializing methods include: