Google Git
Sign in
android / platform / external / xerces-cpp / refs/heads/main / . / doc / html / apiDocs / classDOMXPathResult.html
blob: 9ee06a32b5ec12f822e7411120f2ea45655fb39d [file] [log] [blame]
<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>Xerces-C++: DOMXPathResult Class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
<A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../charter.html" onMouseOut="rolloverOff('side-charter');" onMouseOver="rolloverOn('side-charter');"><IMG alt="Charter" border="0" height="12" hspace="0" name="side-charter" onLoad="rolloverLoad('side-charter','../graphics/charter-label-2.jpg','../graphics/charter-label-3.jpg');" src="../graphics/charter-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="http://xerces.apache.org/xerces-c/download.cgi" onMouseOut="rolloverOff('side-ext-20');" onMouseOver="rolloverOn('side-ext-20');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-20" onLoad="rolloverLoad('side-ext-20','../graphics/ext-20-label-2.jpg','../graphics/ext-20-label-3.jpg');" src="../graphics/ext-20-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build Instructions" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-88');" onMouseOver="rolloverOn('side-ext-88');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-88" onLoad="rolloverLoad('side-ext-88','../graphics/ext-88-label-2.jpg','../graphics/ext-88-label-3.jpg');" src="../graphics/ext-88-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../mailing-lists.html" onMouseOut="rolloverOff('side-mailing-lists');" onMouseOver="rolloverOn('side-mailing-lists');"><IMG alt="Mailing Lists" border="0" height="12" hspace="0" name="side-mailing-lists" onLoad="rolloverLoad('side-mailing-lists','../graphics/mailing-lists-label-2.jpg','../graphics/mailing-lists-label-3.jpg');" src="../graphics/mailing-lists-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
<A href="../source-repository.html" onMouseOut="rolloverOff('side-source-repository');" onMouseOver="rolloverOn('side-source-repository');"><IMG alt="Source Repository" border="0" height="12" hspace="0" name="side-source-repository" onLoad="rolloverLoad('side-source-repository','../graphics/source-repository-label-2.jpg','../graphics/source-repository-label-3.jpg');" src="../graphics/source-repository-label-3.jpg" vspace="0" width="120"></A><BR>
<A href="../applications.html" onMouseOut="rolloverOff('side-applications');" onMouseOver="rolloverOn('side-applications');"><IMG alt="Applications" border="0" height="12" hspace="0" name="side-applications" onLoad="rolloverLoad('side-applications','../graphics/applications-label-2.jpg','../graphics/applications-label-3.jpg');" src="../graphics/applications-label-3.jpg" vspace="0" width="120"></A><BR>
<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
<TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
<P>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</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>DOMXPathResult Class Reference</h1><!-- doxytag: class="DOMXPathResult" -->The <code><a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a></code> interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node.
<a href="#_details">More...</a>
<p>
<p>
<a href="classDOMXPathResult-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 Contants</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f">resultType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30fb6800b7cef4e81a65ca48732dd8fd05b">ANY_TYPE</a> = 0,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30fea34a8448e783d65ddd9519195cb072d">NUMBER_TYPE</a> = 1,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f46318bb5e72271bc9bf5c08b9012fa31">STRING_TYPE</a> = 2,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30fb783d233cc89a2850f4e13ca637d4994">BOOLEAN_TYPE</a> = 3,
<br>
&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f6461a931354777353b499091cfc14d27">UNORDERED_NODE_ITERATOR_TYPE</a> = 4,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f8e8ed330af65222a55d3ad156a7d11df">ORDERED_NODE_ITERATOR_TYPE</a> = 5,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30fe0a1108c8b5cd49097fc57e513c58d21">UNORDERED_NODE_SNAPSHOT_TYPE</a> = 6,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f754c1eda41b3c5b147089cc549490d8a">ORDERED_NODE_SNAPSHOT_TYPE</a> = 7,
<br>
&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30ff86aed2645a86b9c424519d1c12518f9">ANY_UNORDERED_NODE_TYPE</a> = 8,
<a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f154547853ad0e89be9ea5b32f7201d6c">FIRST_ORDERED_NODE_TYPE</a> = 9
<br>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#e6d02311052ec70a50347e101f7f2d56">~DOMXPathResult</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#e6d02311052ec70a50347e101f7f2d56"></a><br></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 bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#cab3ba41dfaec6c38e4c0c485bdc204b">getBooleanValue</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the boolean value of this result. <a href="#cab3ba41dfaec6c38e4c0c485bdc204b"></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="classDOMXPathResult.html#6203550451cb9d2535e08e5f6c17a50a">getInvalidIteratorState</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the state of the iterator. <a href="#6203550451cb9d2535e08e5f6c17a50a"></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="classDOMXPathResult.html#15e02a76d2751a344030603238518edf">getNumberValue</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number value of this result. <a href="#15e02a76d2751a344030603238518edf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual short&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#ea4b6efc014e1e6c959a878da04ab1c7">getResultType</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the result type of this result. <a href="#ea4b6efc014e1e6c959a878da04ab1c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#f8f69f720f421e996e3f0566b0c561b7">getSingleNodeValue</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the single node value of this result. <a href="#f8f69f720f421e996e3f0566b0c561b7"></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="classDOMXPathResult.html#a504f206d2967900174f550f1063cfaa">getSnapshotLength</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the snapshot length. <a href="#a504f206d2967900174f550f1063cfaa"></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="classDOMXPathResult.html#a592b89fbd30c4f2b1631488208fbb33">getStringValue</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the string value of this result. <a href="#a592b89fbd30c4f2b1631488208fbb33"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#dac2208d93ae15a6caf44803389ff8d4">iterateNext</a> () const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Iterates and returns the next node from the node set or nullif there are no more nodes. <a href="#dac2208d93ae15a6caf44803389ff8d4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#b18eb779d30fd4746e7b11ae5dfc350c">snapshotItem</a> (unsigned long index) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the indexth item in the snapshot collection. <a href="#b18eb779d30fd4746e7b11ae5dfc350c"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMXPathResult.html#b6a4f01a6c661f6640c58c5403551ae9">DOMXPathResult</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classDOMXPathResult.html" title="The DOMXPathResult interface represents the result of the evaluation of an XPath...">DOMXPathResult</a></code> interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node.
<p>
Since evaluation of an XPath 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>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f"></a><!-- doxytag: member="DOMXPathResult::resultType" ref="b64c224a9a4af9a43995eab35a05f30f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classDOMXPathResult.html#b64c224a9a4af9a43995eab35a05f30f">DOMXPathResult::resultType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ANY_TYPE <br>
This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression. If the natural result is a node set when ANY_TYPE was requested, then UNORDERED_NODE_ITERATOR_TYPE is always the resulting type. Any other representation of a node set must be explicitly requested. <p>
ANY_UNORDERED_NODE_TYPE <br>
The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be nullif the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once any node in the resulting set has been found. If there is more than one node in the actual result, the single node returned might not be the first in document order. <p>
BOOLEAN_TYPE <br>
The result is a boolean as defined by [XPath 1.0]. Document modification does not invalidate the boolean, but may mean that reevaluation would not yield the same boolean. <p>
FIRST_ORDERED_NODE_TYPE <br>
The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first node in document order of the resulting set has been found. If there are more than one node in the actual result, the single node returned will be the first in document order. <p>
NUMBER_TYPE <br>
The result is a number as defined by [XPath 1.0]. Document modification does not invalidate the number, but may mean that reevaluation would not yield the same number. <p>
ORDERED_NODE_ITERATOR_TYPE <br>
The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which will produce document-ordered nodes. Document modification invalidates the iteration. <p>
ORDERED_NODE_SNAPSHOT_TYPE <br>
The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that will be in original document order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document. <p>
STRING_TYPE <br>
The result is a string as defined by [XPath 1.0]. Document modification does not invalidate the string, but may mean that the string no longer corresponds to the current document. <p>
UNORDERED_NODE_ITERATOR_TYPE <br>
The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which may not produce nodes in a particular order. Document modification invalidates the iteration. This is the default type returned if the result is a node set and ANY_TYPE is requested. <p>
UNORDERED_NODE_SNAPSHOT_TYPE <br>
The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that may not be in a particular order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes 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="b64c224a9a4af9a43995eab35a05f30fb6800b7cef4e81a65ca48732dd8fd05b"></a><!-- doxytag: member="ANY_TYPE" ref="b64c224a9a4af9a43995eab35a05f30fb6800b7cef4e81a65ca48732dd8fd05b" args="" -->ANY_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30fea34a8448e783d65ddd9519195cb072d"></a><!-- doxytag: member="NUMBER_TYPE" ref="b64c224a9a4af9a43995eab35a05f30fea34a8448e783d65ddd9519195cb072d" args="" -->NUMBER_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f46318bb5e72271bc9bf5c08b9012fa31"></a><!-- doxytag: member="STRING_TYPE" ref="b64c224a9a4af9a43995eab35a05f30f46318bb5e72271bc9bf5c08b9012fa31" args="" -->STRING_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30fb783d233cc89a2850f4e13ca637d4994"></a><!-- doxytag: member="BOOLEAN_TYPE" ref="b64c224a9a4af9a43995eab35a05f30fb783d233cc89a2850f4e13ca637d4994" args="" -->BOOLEAN_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f6461a931354777353b499091cfc14d27"></a><!-- doxytag: member="UNORDERED_NODE_ITERATOR_TYPE" ref="b64c224a9a4af9a43995eab35a05f30f6461a931354777353b499091cfc14d27" args="" -->UNORDERED_NODE_ITERATOR_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f8e8ed330af65222a55d3ad156a7d11df"></a><!-- doxytag: member="ORDERED_NODE_ITERATOR_TYPE" ref="b64c224a9a4af9a43995eab35a05f30f8e8ed330af65222a55d3ad156a7d11df" args="" -->ORDERED_NODE_ITERATOR_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30fe0a1108c8b5cd49097fc57e513c58d21"></a><!-- doxytag: member="UNORDERED_NODE_SNAPSHOT_TYPE" ref="b64c224a9a4af9a43995eab35a05f30fe0a1108c8b5cd49097fc57e513c58d21" args="" -->UNORDERED_NODE_SNAPSHOT_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f754c1eda41b3c5b147089cc549490d8a"></a><!-- doxytag: member="ORDERED_NODE_SNAPSHOT_TYPE" ref="b64c224a9a4af9a43995eab35a05f30f754c1eda41b3c5b147089cc549490d8a" args="" -->ORDERED_NODE_SNAPSHOT_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30ff86aed2645a86b9c424519d1c12518f9"></a><!-- doxytag: member="ANY_UNORDERED_NODE_TYPE" ref="b64c224a9a4af9a43995eab35a05f30ff86aed2645a86b9c424519d1c12518f9" args="" -->ANY_UNORDERED_NODE_TYPE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="b64c224a9a4af9a43995eab35a05f30f154547853ad0e89be9ea5b32f7201d6c"></a><!-- doxytag: member="FIRST_ORDERED_NODE_TYPE" ref="b64c224a9a4af9a43995eab35a05f30f154547853ad0e89be9ea5b32f7201d6c" args="" -->FIRST_ORDERED_NODE_TYPE</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b6a4f01a6c661f6640c58c5403551ae9"></a><!-- doxytag: member="DOMXPathResult::DOMXPathResult" ref="b6a4f01a6c661f6640c58c5403551ae9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DOMXPathResult::DOMXPathResult </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e6d02311052ec70a50347e101f7f2d56"></a><!-- doxytag: member="DOMXPathResult::~DOMXPathResult" ref="e6d02311052ec70a50347e101f7f2d56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DOMXPathResult::~DOMXPathResult </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cab3ba41dfaec6c38e4c0c485bdc204b"></a><!-- doxytag: member="DOMXPathResult::getBooleanValue" ref="cab3ba41dfaec6c38e4c0c485bdc204b" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::getBooleanValue </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 boolean value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>booleanValue of type boolean, readonly The value of this boolean result. </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 BOOLEAN_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6203550451cb9d2535e08e5f6c17a50a"></a><!-- doxytag: member="DOMXPathResult::getInvalidIteratorState" ref="6203550451cb9d2535e08e5f6c17a50a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool DOMXPathResult::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>
Returns the state of the iterator.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>invalidIteratorState Signifies that the iterator has become invalid. True if resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned. </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 NUMBER_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="15e02a76d2751a344030603238518edf"></a><!-- doxytag: member="DOMXPathResult::getNumberValue" ref="15e02a76d2751a344030603238518edf" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double DOMXPathResult::getNumberValue </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 number value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>numberValue The value of this number result. 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. </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 NUMBER_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ea4b6efc014e1e6c959a878da04ab1c7"></a><!-- doxytag: member="DOMXPathResult::getResultType" ref="ea4b6efc014e1e6c959a878da04ab1c7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual short DOMXPathResult::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>
<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 ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f8f69f720f421e996e3f0566b0c561b7"></a><!-- doxytag: member="DOMXPathResult::getSingleNodeValue" ref="f8f69f720f421e996e3f0566b0c561b7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::getSingleNodeValue </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 single node value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>singleNodeValue The value of this single node result, which may be null. </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 ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a504f206d2967900174f550f1063cfaa"></a><!-- doxytag: member="DOMXPathResult::getSnapshotLength" ref="a504f206d2967900174f550f1063cfaa" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned long DOMXPathResult::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>
Returns the snapshot length.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>snapshotLength The number of nodes in the result snapshot. Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive. </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 UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a592b89fbd30c4f2b1631488208fbb33"></a><!-- doxytag: member="DOMXPathResult::getStringValue" ref="a592b89fbd30c4f2b1631488208fbb33" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const XMLCh* DOMXPathResult::getStringValue </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 string value of this result.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>stringValue The value of this string result. </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 STRING_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="dac2208d93ae15a6caf44803389ff8d4"></a><!-- doxytag: member="DOMXPathResult::iterateNext" ref="dac2208d93ae15a6caf44803389ff8d4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::iterateNext </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>
Iterates and returns the next node from the node set or nullif there are no more nodes.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the next node. </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 UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE. </td></tr>
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classDOMException.html">DOMException</a></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="b18eb779d30fd4746e7b11ae5dfc350c"></a><!-- doxytag: member="DOMXPathResult::snapshotItem" ref="b18eb779d30fd4746e7b11ae5dfc350c" args="(unsigned long index) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::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%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the indexth item in the snapshot collection.
<p>
If index is greater than or equal to the number of nodes in the list, this method returns null. 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>The node at the indexth position in the NodeList, or null if that is not a valid index. </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 UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMXPathResult_8hpp-source.html">DOMXPathResult.hpp</a></ul>
</FONT></TD></TR></TABLE><BR>
</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
Copyright &copy; 1994-2004 The Apache Software Foundation.
All Rights Reserved.
</I></FONT></TD></TR></TABLE></BODY></HTML>