mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classXPath2Result.html
King_DuckZ 9b71614762 v1.1.0
2020-02-17 22:11:31 +01:00

542 lines
28 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<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>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XPath2Result Class Reference</h1><!-- doxytag: class="XPath2Result" -->The XPathResult2 interface represents the result of the evaluation of an XPath 2.0 expression within the context of a particular node.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XPath2Result_8hpp-source.html">XPath2Result.hpp</a>&gt;</code>
<p>
<a href="classXPath2Result-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Public Constants</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabd">ResultType</a> { <a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabdcaf577b5b4e9d358e98e266635178916">FIRST_RESULT</a> = 100,
<a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabda6da9af2d88f691092166a318d9f5f3f">ITERATOR_RESULT</a> = 101,
<a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabdc9cfdd09d682afd6d40222907da1b8d7">SNAPSHOT_RESULT</a> = 102
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabd">ResultType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#09598a91138133e3bb065dd974002edc">getResultType</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the result type of this result. <a href="#09598a91138133e3bb065dd974002edc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#114e9137afe371592e7abc61e4ae93d7">isNode</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if the result has a current result and the value is a node. <a href="#114e9137afe371592e7abc61e4ae93d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classxercesc_1_1DOMTypeInfo.html">xercesc::DOMTypeInfo</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#1d6432d78b39995f67342066828ee6b6">getTypeInfo</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the DOM type info of the current result node or value. <a href="#1d6432d78b39995f67342066828ee6b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#d28683831824450814fae36678b1c41f">asDouble</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion of the current result to double. <a href="#d28683831824450814fae36678b1c41f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#be568a8971335a33f1251c627a9b14ad">asInt</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion of the current result to int. <a href="#be568a8971335a33f1251c627a9b14ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const XMLCh *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#303b5f55dbf242d6201fd261ccd79c84">asString</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion of the current result to string. <a href="#303b5f55dbf242d6201fd261ccd79c84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#27785dd1d85494fe937caca827a4aaf1">asBoolean</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Conversion of the current result to boolean. <a href="#27785dd1d85494fe937caca827a4aaf1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classxercesc_1_1DOMNode.html">xercesc::DOMNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#942bcfadc1d44951fa28cd4372c36efc">asNode</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieve the current node value. <a href="#942bcfadc1d44951fa28cd4372c36efc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#46f38844d49ad2d58a480f417c3a2244">getInvalidIteratorState</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signifies that the iterator has become invalid. <a href="#46f38844d49ad2d58a480f417c3a2244"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#a660195bc0644d02fe9193000c677e84">getSnapshotLength</a> () const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of items in the result snapshot. <a href="#a660195bc0644d02fe9193000c677e84"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#b0eb8f59658545aa61b7dab1c30f5b64">iterateNext</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#b0eb8f59658545aa61b7dab1c30f5b64"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#e369b3e0ef4e277b26577c3854cd74fe">snapshotItem</a> (unsigned long index)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the current result to the indexth item in the snapshot collection. <a href="#e369b3e0ef4e277b26577c3854cd74fe"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXPath2Result.html#626c24927dfce8d8bc8162c643ff590c">release</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#626c24927dfce8d8bc8162c643ff590c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The XPathResult2 interface represents the result of the evaluation of an XPath 2.0 expression within the context of a particular node.
<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. <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="18e0dff57e4162f32438836da74eaabd"></a><!-- doxytag: member="XPath2Result::ResultType" ref="18e0dff57e4162f32438836da74eaabd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabd">XPath2Result::ResultType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
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>
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. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="18e0dff57e4162f32438836da74eaabdcaf577b5b4e9d358e98e266635178916"></a><!-- doxytag: member="FIRST_RESULT" ref="18e0dff57e4162f32438836da74eaabdcaf577b5b4e9d358e98e266635178916" args="" -->FIRST_RESULT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="18e0dff57e4162f32438836da74eaabda6da9af2d88f691092166a318d9f5f3f"></a><!-- doxytag: member="ITERATOR_RESULT" ref="18e0dff57e4162f32438836da74eaabda6da9af2d88f691092166a318d9f5f3f" args="" -->ITERATOR_RESULT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="18e0dff57e4162f32438836da74eaabdc9cfdd09d682afd6d40222907da1b8d7"></a><!-- doxytag: member="SNAPSHOT_RESULT" ref="18e0dff57e4162f32438836da74eaabdc9cfdd09d682afd6d40222907da1b8d7" args="" -->SNAPSHOT_RESULT</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="c6209c093de954f12163bc234c9f5306"></a><!-- doxytag: member="XPath2Result::~XPath2Result" ref="c6209c093de954f12163bc234c9f5306" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XPath2Result::~XPath2Result </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="19e37cebc1d9d50bb02c23eb7de2f3d1"></a><!-- doxytag: member="XPath2Result::XPath2Result" ref="19e37cebc1d9d50bb02c23eb7de2f3d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPath2Result::XPath2Result </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c6209c093de954f12163bc234c9f5306"></a><!-- doxytag: member="XPath2Result::~XPath2Result" ref="c6209c093de954f12163bc234c9f5306" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XPath2Result::~XPath2Result </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="19e37cebc1d9d50bb02c23eb7de2f3d1"></a><!-- doxytag: member="XPath2Result::XPath2Result" ref="19e37cebc1d9d50bb02c23eb7de2f3d1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XPath2Result::XPath2Result </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="09598a91138133e3bb065dd974002edc"></a><!-- doxytag: member="XPath2Result::getResultType" ref="09598a91138133e3bb065dd974002edc" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classXPath2Result.html#18e0dff57e4162f32438836da74eaabd">ResultType</a> XPath2Result::getResultType </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the result type of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>ResultType A code representing the type of this result, as defined by the type constants. </dd></dl>
</div>
</div><p>
<a class="anchor" name="114e9137afe371592e7abc61e4ae93d7"></a><!-- doxytag: member="XPath2Result::isNode" ref="114e9137afe371592e7abc61e4ae93d7" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPath2Result::isNode </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if the result has a current result and the value is a node.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>isNode of type boolean, readonly </dd></dl>
</div>
</div><p>
<a class="anchor" name="1d6432d78b39995f67342066828ee6b6"></a><!-- doxytag: member="XPath2Result::getTypeInfo" ref="1d6432d78b39995f67342066828ee6b6" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const xercesc:: DOMTypeInfo* XPath2Result::getTypeInfo </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the DOM type info of the current result node or value.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>typeInfo of type TypeInfo, readonly </dd></dl>
</div>
</div><p>
<a class="anchor" name="d28683831824450814fae36678b1c41f"></a><!-- doxytag: member="XPath2Result::asDouble" ref="d28683831824450814fae36678b1c41f" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double XPath2Result::asDouble </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Conversion of the current result to double.
<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. <dl class="return" compact><dt><b>Returns:</b></dt><dd>asDouble of type double, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if current result cannot be properly converted to double. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="be568a8971335a33f1251c627a9b14ad"></a><!-- doxytag: member="XPath2Result::asInt" ref="be568a8971335a33f1251c627a9b14ad" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int XPath2Result::asInt </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Conversion of the current result to int.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>asInt of type int, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if current result cannot be properly converted to int. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="303b5f55dbf242d6201fd261ccd79c84"></a><!-- doxytag: member="XPath2Result::asString" ref="303b5f55dbf242d6201fd261ccd79c84" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* XPath2Result::asString </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Conversion of the current result to string.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>asString of type DOMString, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if current result cannot be properly converted to string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="27785dd1d85494fe937caca827a4aaf1"></a><!-- doxytag: member="XPath2Result::asBoolean" ref="27785dd1d85494fe937caca827a4aaf1" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPath2Result::asBoolean </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Conversion of the current result to boolean.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>asBoolean of type boolean, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if cannot be properly converted to boolean. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="942bcfadc1d44951fa28cd4372c36efc"></a><!-- doxytag: member="XPath2Result::asNode" ref="942bcfadc1d44951fa28cd4372c36efc" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const xercesc:: DOMNode* XPath2Result::asNode </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the current node value.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>asNode of type Node, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if current result is not a node. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: There is no current result in the result. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="46f38844d49ad2d58a480f417c3a2244"></a><!-- doxytag: member="XPath2Result::getInvalidIteratorState" ref="46f38844d49ad2d58a480f417c3a2244" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPath2Result::getInvalidIteratorState </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Signifies that the iterator has become invalid.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>invalidIteratorState of type boolean, readonly </dd></dl>
</div>
</div><p>
<a class="anchor" name="a660195bc0644d02fe9193000c677e84"></a><!-- doxytag: member="XPath2Result::getSnapshotLength" ref="a660195bc0644d02fe9193000c677e84" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned long XPath2Result::getSnapshotLength </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The number of items in the result snapshot.
<p>
Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive. <dl class="return" compact><dt><b>Returns:</b></dt><dd>snapshotLength of type unsigned long, readonly </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if resultType is not SNAPSHOT_RESULT. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b0eb8f59658545aa61b7dab1c30f5b64"></a><!-- doxytag: member="XPath2Result::iterateNext" ref="b0eb8f59658545aa61b7dab1c30f5b64" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPath2Result::iterateNext </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if resultType is not ITERATOR_RESULT. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>DOMException</em>&nbsp;</td><td>INVALID_STATE_ERR: The document has been mutated since the result was returned. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e369b3e0ef4e277b26577c3854cd74fe"></a><!-- doxytag: member="XPath2Result::snapshotItem" ref="e369b3e0ef4e277b26577c3854cd74fe" args="(unsigned long index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool XPath2Result::snapshotItem </td>
<td>(</td>
<td class="paramtype">unsigned long&nbsp;</td>
<td class="paramname"> <em>index</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the current result to the indexth item in the snapshot collection.
<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. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>of type unsigned long - Index into the snapshot collection. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></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 compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>XPathException</em>&nbsp;</td><td>TYPE_ERR: raised if resultType is not SNAPSHOT_RESULT. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="626c24927dfce8d8bc8162c643ff590c"></a><!-- doxytag: member="XPath2Result::release" ref="626c24927dfce8d8bc8162c643ff590c" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XPath2Result::release </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
Access to a released object will lead to unexpected result.
</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Aug 31 14:38:07 2007 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink