XQuilla/docs/dom3-api/classXPath2Result.html

599 lines
30 KiB
HTML
Raw Normal View History

2020-02-17 22:05:20 +01:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 22:11:31 +01:00
<title>XQilla DOM3 API Documentation</title>
2020-02-17 22:05:20 +01:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 22:11:31 +01:00
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
2020-02-17 22:24:47 +01:00
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
2020-02-17 22:19:57 +01:00
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
2020-02-17 22:24:47 +01:00
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
2020-02-17 22:19:57 +01:00
</ul>
</div>
2020-02-17 22:24:47 +01:00
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classXPath2Result-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">XPath2Result Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
2020-02-17 22:19:57 +01:00
<div class="contents">
2020-02-17 22:24:47 +01:00
2020-02-17 22:19:57 +01:00
<p>The XPathResult2 interface represents the result of the evaluation of an XPath 2.0 expression within the context of a particular node.
2020-02-17 22:24:47 +01:00
<a href="classXPath2Result.html#details">More...</a></p>
2020-02-17 22:19:57 +01:00
<p><code>#include &lt;<a class="el" href="XPath2Result_8hpp_source.html">XPath2Result.hpp</a>&gt;</code></p>
2020-02-17 22:24:47 +01:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
2020-02-17 22:24:47 +01:00
<tr class="memitem:a18e0dff57e4162f32438836da74eaabd"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabd">ResultType</a> { <a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabdacaf577b5b4e9d358e98e266635178916">FIRST_RESULT</a> = 100,
<a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabdaa6da9af2d88f691092166a318d9f5f3f">ITERATOR_RESULT</a> = 101,
<a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabdac9cfdd09d682afd6d40222907da1b8d7">SNAPSHOT_RESULT</a> = 102
2020-02-17 22:05:20 +01:00
}</td></tr>
2020-02-17 22:24:47 +01:00
<tr class="separator:a18e0dff57e4162f32438836da74eaabd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
2020-02-17 22:17:06 +01:00
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
2020-02-17 22:24:47 +01:00
<tr class="memitem:ac6209c093de954f12163bc234c9f5306"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#ac6209c093de954f12163bc234c9f5306">~XPath2Result</a> ()</td></tr>
<tr class="memdesc:ac6209c093de954f12163bc234c9f5306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ac6209c093de954f12163bc234c9f5306">More...</a><br/></td></tr>
<tr class="separator:ac6209c093de954f12163bc234c9f5306"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
2020-02-17 22:24:47 +01:00
<tr class="memitem:a99c7a03d8af94716b20ee9b459d8c4e0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabd">ResultType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a99c7a03d8af94716b20ee9b459d8c4e0">getResultType</a> () const =0</td></tr>
<tr class="memdesc:a99c7a03d8af94716b20ee9b459d8c4e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the result type of this result. <a href="#a99c7a03d8af94716b20ee9b459d8c4e0">More...</a><br/></td></tr>
<tr class="separator:a99c7a03d8af94716b20ee9b459d8c4e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ebbdf5df735155dd651afb9766dfc01"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a7ebbdf5df735155dd651afb9766dfc01">isNode</a> () const =0</td></tr>
<tr class="memdesc:a7ebbdf5df735155dd651afb9766dfc01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the result has a current result and the value is a node. <a href="#a7ebbdf5df735155dd651afb9766dfc01">More...</a><br/></td></tr>
<tr class="separator:a7ebbdf5df735155dd651afb9766dfc01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae123dc342ef0c418d3bda6f0146d118d"><td class="memItemLeft" align="right" valign="top">virtual const <br class="typebreak"/>
<a class="el" href="classxercesc_1_1DOMTypeInfo.html">xercesc::DOMTypeInfo</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#ae123dc342ef0c418d3bda6f0146d118d">getTypeInfo</a> () const =0</td></tr>
<tr class="memdesc:ae123dc342ef0c418d3bda6f0146d118d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the DOM type info of the current result node or value. <a href="#ae123dc342ef0c418d3bda6f0146d118d">More...</a><br/></td></tr>
<tr class="separator:ae123dc342ef0c418d3bda6f0146d118d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a0af5522688bd3c5e381d49f66edf6d"><td class="memItemLeft" align="right" valign="top">virtual double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a1a0af5522688bd3c5e381d49f66edf6d">getNumberValue</a> () const =0</td></tr>
<tr class="memdesc:a1a0af5522688bd3c5e381d49f66edf6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion of the current result to double. <a href="#a1a0af5522688bd3c5e381d49f66edf6d">More...</a><br/></td></tr>
<tr class="separator:a1a0af5522688bd3c5e381d49f66edf6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3250ab9fbe8afae2c6198f6aca3d3e3a"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a3250ab9fbe8afae2c6198f6aca3d3e3a">getIntegerValue</a> () const =0</td></tr>
<tr class="memdesc:a3250ab9fbe8afae2c6198f6aca3d3e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion of the current result to int. <a href="#a3250ab9fbe8afae2c6198f6aca3d3e3a">More...</a><br/></td></tr>
<tr class="separator:a3250ab9fbe8afae2c6198f6aca3d3e3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8c06bc3deef9c1a806503f64d35f1c1"><td class="memItemLeft" align="right" valign="top">virtual const XMLCh *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#ae8c06bc3deef9c1a806503f64d35f1c1">getStringValue</a> () const =0</td></tr>
<tr class="memdesc:ae8c06bc3deef9c1a806503f64d35f1c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion of the current result to string. <a href="#ae8c06bc3deef9c1a806503f64d35f1c1">More...</a><br/></td></tr>
<tr class="separator:ae8c06bc3deef9c1a806503f64d35f1c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6be0a85fa7a0d470cc6bed503bb7bf74"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a6be0a85fa7a0d470cc6bed503bb7bf74">getBooleanValue</a> () const =0</td></tr>
<tr class="memdesc:a6be0a85fa7a0d470cc6bed503bb7bf74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion of the current result to boolean. <a href="#a6be0a85fa7a0d470cc6bed503bb7bf74">More...</a><br/></td></tr>
<tr class="separator:a6be0a85fa7a0d470cc6bed503bb7bf74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69224ddd15b39f90f62529cb32e5072f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNode.html">xercesc::DOMNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a69224ddd15b39f90f62529cb32e5072f">getNodeValue</a> () const =0</td></tr>
<tr class="memdesc:a69224ddd15b39f90f62529cb32e5072f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the current node value. <a href="#a69224ddd15b39f90f62529cb32e5072f">More...</a><br/></td></tr>
<tr class="separator:a69224ddd15b39f90f62529cb32e5072f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03fe13a9c19742f3e9bae278a4090f1b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a03fe13a9c19742f3e9bae278a4090f1b">getInvalidIteratorState</a> () const =0</td></tr>
<tr class="memdesc:a03fe13a9c19742f3e9bae278a4090f1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signifies that the iterator has become invalid. <a href="#a03fe13a9c19742f3e9bae278a4090f1b">More...</a><br/></td></tr>
<tr class="separator:a03fe13a9c19742f3e9bae278a4090f1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3683bef6a9431b6429df0340a14ce6e5"><td class="memItemLeft" align="right" valign="top">virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a3683bef6a9431b6429df0340a14ce6e5">getSnapshotLength</a> () const =0</td></tr>
<tr class="memdesc:a3683bef6a9431b6429df0340a14ce6e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of items in the result snapshot. <a href="#a3683bef6a9431b6429df0340a14ce6e5">More...</a><br/></td></tr>
<tr class="separator:a3683bef6a9431b6429df0340a14ce6e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0eb8f59658545aa61b7dab1c30f5b64"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#ab0eb8f59658545aa61b7dab1c30f5b64">iterateNext</a> ()=0</td></tr>
<tr class="memdesc:ab0eb8f59658545aa61b7dab1c30f5b64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates and returns true if the current result is the next item from the sequence or false if there are no more items. <a href="#ab0eb8f59658545aa61b7dab1c30f5b64">More...</a><br/></td></tr>
<tr class="separator:ab0eb8f59658545aa61b7dab1c30f5b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a680aedffaaec93d362b7caec17628c15"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a680aedffaaec93d362b7caec17628c15">snapshotItem</a> (size_t)=0</td></tr>
<tr class="memdesc:a680aedffaaec93d362b7caec17628c15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the current result to the indexth item in the snapshot collection. <a href="#a680aedffaaec93d362b7caec17628c15">More...</a><br/></td></tr>
<tr class="separator:a680aedffaaec93d362b7caec17628c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-02-17 22:05:20 +01:00
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
2020-02-17 22:24:47 +01:00
<tr class="memitem:a626c24927dfce8d8bc8162c643ff590c"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a626c24927dfce8d8bc8162c643ff590c">release</a> ()=0</td></tr>
<tr class="memdesc:a626c24927dfce8d8bc8162c643ff590c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to indicate that this object (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. <a href="#a626c24927dfce8d8bc8162c643ff590c">More...</a><br/></td></tr>
<tr class="separator:a626c24927dfce8d8bc8162c643ff590c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
2020-02-17 22:17:06 +01:00
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
2020-02-17 22:24:47 +01:00
<tr class="memitem:a19e37cebc1d9d50bb02c23eb7de2f3d1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a19e37cebc1d9d50bb02c23eb7de2f3d1">XPath2Result</a> ()</td></tr>
<tr class="separator:a19e37cebc1d9d50bb02c23eb7de2f3d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
2020-02-17 22:19:57 +01:00
</table>
2020-02-17 22:24:47 +01:00
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The XPathResult2 interface represents the result of the evaluation of an XPath 2.0 expression within the context of a particular node. </p>
2020-02-17 22:19:57 +01:00
<p>Since evaluation of an XPath 2.0 expression can result in various result types, this object makes it possible to discover and manipulate the type and value of the result. </p>
2020-02-17 22:24:47 +01:00
<dl class="section since"><dt>Since</dt><dd>DOM Level 3 </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="a18e0dff57e4162f32438836da74eaabd"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">enum <a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabd">XPath2Result::ResultType</a></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>FIRST_RESULT <br/>
The result is a sequence as defined by XPath 2.0 and will be accessed as a single current value or there will be no current value if the sequence is empty. Document modification does not invalidate the value, but may mean that the result no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first item in the resulting sequence has been found. If there is more than one item in the actual result, the single item returned might not be the first in document order. </p>
<p>ITERATOR_RESULT <br/>
The result is a sequence as defined by XPath 2.0 that will be accessed iteratively. Document modification invalidates the iteration. </p>
<p>SNAPSHOT_RESULT <br/>
The result is a sequence as defined by XPath 2.0 that will be accessed as a snapshot list of values. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and any items in the snapshot may have been altered, moved, or removed from the document. </p>
2020-02-17 22:24:47 +01:00
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a18e0dff57e4162f32438836da74eaabdacaf577b5b4e9d358e98e266635178916"></a>FIRST_RESULT</em>&nbsp;</td><td class="fielddoc">
2020-02-17 22:05:20 +01:00
</td></tr>
2020-02-17 22:24:47 +01:00
<tr><td class="fieldname"><em><a class="anchor" id="a18e0dff57e4162f32438836da74eaabdaa6da9af2d88f691092166a318d9f5f3f"></a>ITERATOR_RESULT</em>&nbsp;</td><td class="fielddoc">
2020-02-17 22:05:20 +01:00
</td></tr>
2020-02-17 22:24:47 +01:00
<tr><td class="fieldname"><em><a class="anchor" id="a18e0dff57e4162f32438836da74eaabdac9cfdd09d682afd6d40222907da1b8d7"></a>SNAPSHOT_RESULT</em>&nbsp;</td><td class="fielddoc">
2020-02-17 22:05:20 +01:00
</td></tr>
</table>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac6209c093de954f12163bc234c9f5306"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual XPath2Result::~XPath2Result </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Destructor. </p>
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a19e37cebc1d9d50bb02c23eb7de2f3d1"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">XPath2Result::XPath2Result </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6be0a85fa7a0d470cc6bed503bb7bf74"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual bool XPath2Result::getBooleanValue </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Conversion of the current result to boolean. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>asBoolean of type boolean, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if cannot be properly converted to boolean. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
2020-02-17 22:19:08 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:19:08 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a3250ab9fbe8afae2c6198f6aca3d3e3a"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual int XPath2Result::getIntegerValue </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Conversion of the current result to int. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>asInt of type int, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if current result cannot be properly converted to int. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
2020-02-17 22:19:08 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:19:08 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a03fe13a9c19742f3e9bae278a4090f1b"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:10:06 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual bool XPath2Result::getInvalidIteratorState </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:10:06 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Signifies that the iterator has become invalid. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>invalidIteratorState of type boolean, readonly </dd></dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a69224ddd15b39f90f62529cb32e5072f"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:10:06 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual xercesc:: DOMNode* XPath2Result::getNodeValue </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:10:06 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Retrieve the current node value. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>asNode of type Node, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if current result is not a node. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a1a0af5522688bd3c5e381d49f66edf6d"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual double XPath2Result::getNumberValue </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Conversion of the current result to double. </p>
<p>If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding to specify how the XPath number is converted to the native binding number. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>asDouble of type double, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if current result cannot be properly converted to double. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a99c7a03d8af94716b20ee9b459d8c4e0"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual <a class="el" href="classXPath2Result.html#a18e0dff57e4162f32438836da74eaabd">ResultType</a> XPath2Result::getResultType </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Returns the result type of this result. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>ResultType A code representing the type of this result, as defined by the type constants. </dd></dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a3683bef6a9431b6429df0340a14ce6e5"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual size_t XPath2Result::getSnapshotLength </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>The number of items in the result snapshot. </p>
<p>Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>snapshotLength of type size_t, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if resultType is not SNAPSHOT_RESULT. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="ae8c06bc3deef9c1a806503f64d35f1c1"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual const XMLCh* XPath2Result::getStringValue </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Conversion of the current result to string. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>asString of type DOMString, readonly </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if current result cannot be properly converted to string. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
2020-02-17 22:10:06 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:10:06 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="ae123dc342ef0c418d3bda6f0146d118d"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual const xercesc:: DOMTypeInfo* XPath2Result::getTypeInfo </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Returns the DOM type info of the current result node or value. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>typeInfo of type TypeInfo, readonly </dd></dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a7ebbdf5df735155dd651afb9766dfc01"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual bool XPath2Result::isNode </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td> const</td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Returns true if the result has a current result and the value is a node. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>isNode of type boolean, readonly </dd></dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="ab0eb8f59658545aa61b7dab1c30f5b64"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual bool XPath2Result::iterateNext </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Iterates and returns true if the current result is the next item from the sequence or false if there are no more items. </p>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>boolean True if the current result is the next item from the sequence or false if there are no more items. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if resultType is not ITERATOR_RESULT. </td></tr>
<tr><td class="paramname">DOMException</td><td>INVALID_STATE_ERR: The document has been mutated since the result was returned. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a626c24927dfce8d8bc8162c643ff590c"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:19:08 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual void XPath2Result::release </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramname"></td><td>)</td>
<td></td>
2020-02-17 22:19:08 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Called to indicate that this object (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. </p>
<p>Access to a released object will lead to unexpected result. </p>
</div>
</div>
2020-02-17 22:24:47 +01:00
<a class="anchor" id="a680aedffaaec93d362b7caec17628c15"></a>
2020-02-17 22:19:57 +01:00
<div class="memitem">
<div class="memproto">
2020-02-17 22:24:47 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2020-02-17 22:19:57 +01:00
<table class="memname">
2020-02-17 22:05:20 +01:00
<tr>
2020-02-17 22:19:57 +01:00
<td class="memname">virtual bool XPath2Result::snapshotItem </td>
<td>(</td>
2020-02-17 22:24:47 +01:00
<td class="paramtype">size_t&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
2020-02-17 22:05:20 +01:00
</tr>
</table>
2020-02-17 22:24:47 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
2020-02-17 22:19:57 +01:00
<p>Sets the current result to the indexth item in the snapshot collection. </p>
<p>If index is greater than or equal to the number of items in the list, this method returns false. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated. </p>
2020-02-17 22:24:47 +01:00
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>of type size_t - Index into the snapshot collection. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:24:47 +01:00
<dl class="section return"><dt>Returns</dt><dd>boolean True if the current result is the next item from the sequence or false if there are no more items. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">XPathException</td><td>TYPE_ERR: raised if resultType is not SNAPSHOT_RESULT. </td></tr>
2020-02-17 22:05:20 +01:00
</table>
2020-02-17 22:19:57 +01:00
</dd>
2020-02-17 22:05:20 +01:00
</dl>
2020-02-17 22:19:57 +01:00
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XPath2Result_8hpp_source.html">XPath2Result.hpp</a></li>
</ul>
2020-02-17 22:24:47 +01:00
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
2020-02-17 22:05:20 +01:00
</body>
</html>