Print (XmlDoc/XmlNode subroutine): Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 92: | Line 92: | ||
<ul> | <ul> | ||
<li><var>[[WebSend (XmlDoc subroutine)|WebSend]]</var> | <li><var>[[WebSend (XmlDoc subroutine)|WebSend]]</var> | ||
<li><var>[[AddXml]]</var> (<var>[[HttpRequest]]</var> class) | <li><var>[[AddXml (HttpRequest subroutine)|AddXml]]</var> (<var>[[HttpRequest class|HttpRequest]]</var> class) | ||
</ul> | </ul> | ||
</ul> | </ul> | ||
{{Template:XmlDoc/XmlNode:Print footer}} | {{Template:XmlDoc/XmlNode:Print footer}} |
Revision as of 22:16, 21 June 2011
Print selected subtree (XmlDoc and XmlNode classes)
The Print subroutine displays an XmlDoc subtree in a readable form, useful for debugging, for example.
Syntax
nr:Print[( [xpath], [options])] Throws XPathError
Syntax terms
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. An optional argument, its default is a period (. ), that is, the node referenced by the method object (nr). |
options | A blank delimited string that can contain one or more of the following options, which are identified below and described in greater detail in "XmlDoc API serialization options":
|
Usage notes
- Options may be specified in any case. For example, you can use either
NoXmlDecl
ornoxmldecl
, interchangeably. - 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.
Examples
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>
Request-cancellation errors
- The xpath expression is invalid.
- The result of xpath is empty.
- options values are invalid.
- Insufficient free space exists in CCATEMP.
See also
- 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.
- Additional serializing methods include:
- WebSend
- AddXml (HttpRequest class)