source: NonGTP/Xerces/xerces/doc/html/apiDocs/classDOMXPathResult.html @ 358

Revision 358, 37.0 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>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>
2  <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>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <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>
7  <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>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <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>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" 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>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <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> 
15  <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>
16  <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> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <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>
22  <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>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <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>
27  <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> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<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>
38    <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">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DOMXPathResult Class Reference</h1>The <code>DOMXPathResult</code> interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMXPathResult-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
48<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
49<tr><td colspan="2"><div class="groupHeader">Public Contants</div></td></tr>
50<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z206_0">resultType</a> { <br>
51&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#z206_0s0">ANY_TYPE</a> =  0,
52<a class="el" href="classDOMXPathResult.html#z206_0s1">NUMBER_TYPE</a> =  1,
53<a class="el" href="classDOMXPathResult.html#z206_0s2">STRING_TYPE</a> =  2,
54<a class="el" href="classDOMXPathResult.html#z206_0s3">BOOLEAN_TYPE</a> =  3,
55<br>
56&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#z206_0s4">UNORDERED_NODE_ITERATOR_TYPE</a> =  4,
57<a class="el" href="classDOMXPathResult.html#z206_0s5">ORDERED_NODE_ITERATOR_TYPE</a> =  5,
58<a class="el" href="classDOMXPathResult.html#z206_0s6">UNORDERED_NODE_SNAPSHOT_TYPE</a> =  6,
59<a class="el" href="classDOMXPathResult.html#z206_0s7">ORDERED_NODE_SNAPSHOT_TYPE</a> =  7,
60<br>
61&nbsp;&nbsp;<a class="el" href="classDOMXPathResult.html#z206_0s8">ANY_UNORDERED_NODE_TYPE</a> =  8,
62<a class="el" href="classDOMXPathResult.html#z206_0s9">FIRST_ORDERED_NODE_TYPE</a> =  9
63<br>
64 }</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>ANY_TYPE This code does not represent a specific type.</em> <a href="#z206_0">More...</a><em></em></font><br><br></td></tr>
66<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
67<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
68<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z205_0">~DOMXPathResult</a> ()</td></tr>
69<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z205_0">More...</a><em></em></font><br><br></td></tr>
70<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
71<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_0">getBooleanValue</a> () const=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Returns the boolean value of this result.</em> <a href="#z207_0">More...</a><em></em></font><br><br></td></tr>
73<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_1">getInvalidIteratorState</a> () const=0</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>Returns the state of the iterator.</em> <a href="#z207_1">More...</a><em></em></font><br><br></td></tr>
75<tr><td nowrap align=right valign=top>virtual double&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_2">getNumberValue</a> () const=0</td></tr>
76<tr><td>&nbsp;</td><td><font size=-1><em>Returns the number value of this result.</em> <a href="#z207_2">More...</a><em></em></font><br><br></td></tr>
77<tr><td nowrap align=right valign=top>virtual short&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_3">getResultType</a> () const=0</td></tr>
78<tr><td>&nbsp;</td><td><font size=-1><em>Returns the result type of this result.</em> <a href="#z207_3">More...</a><em></em></font><br><br></td></tr>
79<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_4">getSingleNodeValue</a> () const=0</td></tr>
80<tr><td>&nbsp;</td><td><font size=-1><em>Returns the single node value of this result.</em> <a href="#z207_4">More...</a><em></em></font><br><br></td></tr>
81<tr><td nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_5">getSnapshotLength</a> () const=0</td></tr>
82<tr><td>&nbsp;</td><td><font size=-1><em>Returns the snapshot length.</em> <a href="#z207_5">More...</a><em></em></font><br><br></td></tr>
83<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_6">getStringValue</a> () const=0</td></tr>
84<tr><td>&nbsp;</td><td><font size=-1><em>Returns the string value of this result.</em> <a href="#z207_6">More...</a><em></em></font><br><br></td></tr>
85<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_7">iterateNext</a> () const=0</td></tr>
86<tr><td>&nbsp;</td><td><font size=-1><em>Iterates and returns the next node from the node set or nullif there are no more nodes.</em> <a href="#z207_7">More...</a><em></em></font><br><br></td></tr>
87<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z207_8">snapshotItem</a> (unsigned long index) const=0</td></tr>
88<tr><td>&nbsp;</td><td><font size=-1><em>Returns the indexth item in the snapshot collection.</em> <a href="#z207_8">More...</a><em></em></font><br><br></td></tr>
89<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
90<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
91<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathResult.html#z203_0">DOMXPathResult</a> ()</td></tr>
92</table>
93<hr><a name="_details"></a><h2>Detailed Description</h2>
94The <code>DOMXPathResult</code> interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node.
95<p>
96Since 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 compact><dt><b>
97Since: </b><dd>
98DOM Level 3 </dl>
99<p>
100<hr><h2>Member Enumeration Documentation</h2>
101<a name="z206_0" doxytag="DOMXPathResult::resultType"></a><p>
102<table width="100%" cellpadding="2" cellspacing="0" border="0">
103  <tr>
104    <td class="md">
105      <table cellpadding="0" cellspacing="0" border="0">
106        <tr>
107          <td class="md" nowrap valign="top"> enum DOMXPathResult::resultType
108      </table>
109    </td>
110  </tr>
111</table>
112<table cellspacing=5 cellpadding=0 border=0>
113  <tr>
114    <td>
115      &nbsp;
116    </td>
117    <td>
118
119<p>
120ANY_TYPE This code does not represent a specific type.
121<p>
122An 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. ANY_UNORDERED_NODE_TYPE 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. BOOLEAN_TYPE 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. FIRST_ORDERED_NODE_TYPE 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. NUMBER_TYPE 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. ORDERED_NODE_ITERATOR_TYPE 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. ORDERED_NODE_SNAPSHOT_TYPE 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. STRING_TYPE 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. UNORDERED_NODE_ITERATOR_TYPE 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. UNORDERED_NODE_SNAPSHOT_TYPE 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>
123Enumeration values:</b><dd>
124<table border=0 cellspacing=2 cellpadding=0>
125<tr><td valign=top><em><a name="z206_0s0" doxytag="ANY_TYPE"></a><em>ANY_TYPE</em></em>&nbsp;</td><td>
126</td></tr>
127<tr><td valign=top><em><a name="z206_0s1" doxytag="NUMBER_TYPE"></a><em>NUMBER_TYPE</em></em>&nbsp;</td><td>
128</td></tr>
129<tr><td valign=top><em><a name="z206_0s2" doxytag="STRING_TYPE"></a><em>STRING_TYPE</em></em>&nbsp;</td><td>
130</td></tr>
131<tr><td valign=top><em><a name="z206_0s3" doxytag="BOOLEAN_TYPE"></a><em>BOOLEAN_TYPE</em></em>&nbsp;</td><td>
132</td></tr>
133<tr><td valign=top><em><a name="z206_0s4" doxytag="UNORDERED_NODE_ITERATOR_TYPE"></a><em>UNORDERED_NODE_ITERATOR_TYPE</em></em>&nbsp;</td><td>
134</td></tr>
135<tr><td valign=top><em><a name="z206_0s5" doxytag="ORDERED_NODE_ITERATOR_TYPE"></a><em>ORDERED_NODE_ITERATOR_TYPE</em></em>&nbsp;</td><td>
136</td></tr>
137<tr><td valign=top><em><a name="z206_0s6" doxytag="UNORDERED_NODE_SNAPSHOT_TYPE"></a><em>UNORDERED_NODE_SNAPSHOT_TYPE</em></em>&nbsp;</td><td>
138</td></tr>
139<tr><td valign=top><em><a name="z206_0s7" doxytag="ORDERED_NODE_SNAPSHOT_TYPE"></a><em>ORDERED_NODE_SNAPSHOT_TYPE</em></em>&nbsp;</td><td>
140</td></tr>
141<tr><td valign=top><em><a name="z206_0s8" doxytag="ANY_UNORDERED_NODE_TYPE"></a><em>ANY_UNORDERED_NODE_TYPE</em></em>&nbsp;</td><td>
142</td></tr>
143<tr><td valign=top><em><a name="z206_0s9" doxytag="FIRST_ORDERED_NODE_TYPE"></a><em>FIRST_ORDERED_NODE_TYPE</em></em>&nbsp;</td><td>
144</td></tr>
145</table>
146</dl>
147    </td>
148  </tr>
149</table>
150<hr><h2>Constructor &amp; Destructor Documentation</h2>
151<a name="z203_0" doxytag="DOMXPathResult::DOMXPathResult"></a><p>
152<table width="100%" cellpadding="2" cellspacing="0" border="0">
153  <tr>
154    <td class="md">
155      <table cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td class="md" nowrap valign="top"> DOMXPathResult::DOMXPathResult </td>
158          <td class="md" valign="top">(&nbsp;</td>
159          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
160          <td class="md" valign="top">)&nbsp;</td>
161          <td class="md" nowrap><code> [protected]</code></td>
162        </tr>
163
164      </table>
165    </td>
166  </tr>
167</table>
168<table cellspacing=5 cellpadding=0 border=0>
169  <tr>
170    <td>
171      &nbsp;
172    </td>
173    <td>
174
175<p>
176    </td>
177  </tr>
178</table>
179<a name="z205_0" doxytag="DOMXPathResult::~DOMXPathResult"></a><p>
180<table width="100%" cellpadding="2" cellspacing="0" border="0">
181  <tr>
182    <td class="md">
183      <table cellpadding="0" cellspacing="0" border="0">
184        <tr>
185          <td class="md" nowrap valign="top"> virtual DOMXPathResult::~DOMXPathResult </td>
186          <td class="md" valign="top">(&nbsp;</td>
187          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
188          <td class="md" valign="top">)&nbsp;</td>
189          <td class="md" nowrap><code> [virtual]</code></td>
190        </tr>
191
192      </table>
193    </td>
194  </tr>
195</table>
196<table cellspacing=5 cellpadding=0 border=0>
197  <tr>
198    <td>
199      &nbsp;
200    </td>
201    <td>
202
203<p>
204Destructor.
205<p>
206    </td>
207  </tr>
208</table>
209<hr><h2>Member Function Documentation</h2>
210<a name="z207_0" doxytag="DOMXPathResult::getBooleanValue"></a><p>
211<table width="100%" cellpadding="2" cellspacing="0" border="0">
212  <tr>
213    <td class="md">
214      <table cellpadding="0" cellspacing="0" border="0">
215        <tr>
216          <td class="md" nowrap valign="top"> virtual bool DOMXPathResult::getBooleanValue </td>
217          <td class="md" valign="top">(&nbsp;</td>
218          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
219          <td class="md" valign="top">)&nbsp;</td>
220          <td class="md" nowrap> const<code> [pure virtual]</code></td>
221        </tr>
222
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Returns the boolean value of this result.
236<p>
237<dl compact><dt><b>
238Returns: </b><dd>
239booleanValue of type boolean, readonly The value of this boolean result. </dl><dl compact><dt><b>
240Exceptions: </b><dd>
241<table border=0 cellspacing=2 cellpadding=0>
242<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
243 TYPE_ERR: raised if resultType is not BOOLEAN_TYPE. </td></tr>
244</table>
245</dl>    </td>
246  </tr>
247</table>
248<a name="z207_1" doxytag="DOMXPathResult::getInvalidIteratorState"></a><p>
249<table width="100%" cellpadding="2" cellspacing="0" border="0">
250  <tr>
251    <td class="md">
252      <table cellpadding="0" cellspacing="0" border="0">
253        <tr>
254          <td class="md" nowrap valign="top"> virtual bool DOMXPathResult::getInvalidIteratorState </td>
255          <td class="md" valign="top">(&nbsp;</td>
256          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
257          <td class="md" valign="top">)&nbsp;</td>
258          <td class="md" nowrap> const<code> [pure virtual]</code></td>
259        </tr>
260
261      </table>
262    </td>
263  </tr>
264</table>
265<table cellspacing=5 cellpadding=0 border=0>
266  <tr>
267    <td>
268      &nbsp;
269    </td>
270    <td>
271
272<p>
273Returns the state of the iterator.
274<p>
275<dl compact><dt><b>
276Returns: </b><dd>
277invalidIteratorState  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. </dl><dl compact><dt><b>
278Exceptions: </b><dd>
279<table border=0 cellspacing=2 cellpadding=0>
280<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
281  TYPE_ERR: raised if resultType is not NUMBER_TYPE. </td></tr>
282</table>
283</dl>    </td>
284  </tr>
285</table>
286<a name="z207_2" doxytag="DOMXPathResult::getNumberValue"></a><p>
287<table width="100%" cellpadding="2" cellspacing="0" border="0">
288  <tr>
289    <td class="md">
290      <table cellpadding="0" cellspacing="0" border="0">
291        <tr>
292          <td class="md" nowrap valign="top"> virtual double DOMXPathResult::getNumberValue </td>
293          <td class="md" valign="top">(&nbsp;</td>
294          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
295          <td class="md" valign="top">)&nbsp;</td>
296          <td class="md" nowrap> const<code> [pure virtual]</code></td>
297        </tr>
298
299      </table>
300    </td>
301  </tr>
302</table>
303<table cellspacing=5 cellpadding=0 border=0>
304  <tr>
305    <td>
306      &nbsp;
307    </td>
308    <td>
309
310<p>
311Returns the number value of this result.
312<p>
313<dl compact><dt><b>
314Returns: </b><dd>
315numberValue  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. </dl><dl compact><dt><b>
316Exceptions: </b><dd>
317<table border=0 cellspacing=2 cellpadding=0>
318<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
319 TYPE_ERR: raised if resultType is not NUMBER_TYPE. </td></tr>
320</table>
321</dl>    </td>
322  </tr>
323</table>
324<a name="z207_3" doxytag="DOMXPathResult::getResultType"></a><p>
325<table width="100%" cellpadding="2" cellspacing="0" border="0">
326  <tr>
327    <td class="md">
328      <table cellpadding="0" cellspacing="0" border="0">
329        <tr>
330          <td class="md" nowrap valign="top"> virtual short DOMXPathResult::getResultType </td>
331          <td class="md" valign="top">(&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
333          <td class="md" valign="top">)&nbsp;</td>
334          <td class="md" nowrap> const<code> [pure virtual]</code></td>
335        </tr>
336
337      </table>
338    </td>
339  </tr>
340</table>
341<table cellspacing=5 cellpadding=0 border=0>
342  <tr>
343    <td>
344      &nbsp;
345    </td>
346    <td>
347
348<p>
349Returns the result type of this result.
350<p>
351<dl compact><dt><b>
352Returns: </b><dd>
353resultType  A code representing the type of this result, as defined by the type constants.  </dl><dl compact><dt><b>
354Exceptions: </b><dd>
355<table border=0 cellspacing=2 cellpadding=0>
356<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
357 TYPE_ERR: raised if resultType is not ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE. </td></tr>
358</table>
359</dl>    </td>
360  </tr>
361</table>
362<a name="z207_4" doxytag="DOMXPathResult::getSingleNodeValue"></a><p>
363<table width="100%" cellpadding="2" cellspacing="0" border="0">
364  <tr>
365    <td class="md">
366      <table cellpadding="0" cellspacing="0" border="0">
367        <tr>
368          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::getSingleNodeValue </td>
369          <td class="md" valign="top">(&nbsp;</td>
370          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
371          <td class="md" valign="top">)&nbsp;</td>
372          <td class="md" nowrap> const<code> [pure virtual]</code></td>
373        </tr>
374
375      </table>
376    </td>
377  </tr>
378</table>
379<table cellspacing=5 cellpadding=0 border=0>
380  <tr>
381    <td>
382      &nbsp;
383    </td>
384    <td>
385
386<p>
387Returns the single node value of this result.
388<p>
389<dl compact><dt><b>
390Returns: </b><dd>
391singleNodeValue  The value of this single node result, which may be null. </dl><dl compact><dt><b>
392Exceptions: </b><dd>
393<table border=0 cellspacing=2 cellpadding=0>
394<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
395 TYPE_ERR: raised if resultType is not ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE. </td></tr>
396</table>
397</dl>    </td>
398  </tr>
399</table>
400<a name="z207_5" doxytag="DOMXPathResult::getSnapshotLength"></a><p>
401<table width="100%" cellpadding="2" cellspacing="0" border="0">
402  <tr>
403    <td class="md">
404      <table cellpadding="0" cellspacing="0" border="0">
405        <tr>
406          <td class="md" nowrap valign="top"> virtual unsigned long DOMXPathResult::getSnapshotLength </td>
407          <td class="md" valign="top">(&nbsp;</td>
408          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
409          <td class="md" valign="top">)&nbsp;</td>
410          <td class="md" nowrap> const<code> [pure virtual]</code></td>
411        </tr>
412
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Returns the snapshot length.
426<p>
427<dl compact><dt><b>
428Returns: </b><dd>
429snapshotLength  The number of nodes in the result snapshot. Valid values for snapshotItem indices  are 0 to snapshotLength-1 inclusive. </dl><dl compact><dt><b>
430Exceptions: </b><dd>
431<table border=0 cellspacing=2 cellpadding=0>
432<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
433 TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or  ORDERED_NODE_SNAPSHOT_TYPE. </td></tr>
434</table>
435</dl>    </td>
436  </tr>
437</table>
438<a name="z207_6" doxytag="DOMXPathResult::getStringValue"></a><p>
439<table width="100%" cellpadding="2" cellspacing="0" border="0">
440  <tr>
441    <td class="md">
442      <table cellpadding="0" cellspacing="0" border="0">
443        <tr>
444          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMXPathResult::getStringValue </td>
445          <td class="md" valign="top">(&nbsp;</td>
446          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
447          <td class="md" valign="top">)&nbsp;</td>
448          <td class="md" nowrap> const<code> [pure virtual]</code></td>
449        </tr>
450
451      </table>
452    </td>
453  </tr>
454</table>
455<table cellspacing=5 cellpadding=0 border=0>
456  <tr>
457    <td>
458      &nbsp;
459    </td>
460    <td>
461
462<p>
463Returns the string value of this result.
464<p>
465<dl compact><dt><b>
466Returns: </b><dd>
467stringValue  The value of this string result. </dl><dl compact><dt><b>
468Exceptions: </b><dd>
469<table border=0 cellspacing=2 cellpadding=0>
470<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
471 TYPE_ERR: raised if resultType is not STRING_TYPE. </td></tr>
472</table>
473</dl>    </td>
474  </tr>
475</table>
476<a name="z207_7" doxytag="DOMXPathResult::iterateNext"></a><p>
477<table width="100%" cellpadding="2" cellspacing="0" border="0">
478  <tr>
479    <td class="md">
480      <table cellpadding="0" cellspacing="0" border="0">
481        <tr>
482          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::iterateNext </td>
483          <td class="md" valign="top">(&nbsp;</td>
484          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
485          <td class="md" valign="top">)&nbsp;</td>
486          <td class="md" nowrap> const<code> [pure virtual]</code></td>
487        </tr>
488
489      </table>
490    </td>
491  </tr>
492</table>
493<table cellspacing=5 cellpadding=0 border=0>
494  <tr>
495    <td>
496      &nbsp;
497    </td>
498    <td>
499
500<p>
501Iterates and returns the next node from the node set or nullif there are no more nodes.
502<p>
503<dl compact><dt><b>
504Returns: </b><dd>
505the next node. </dl><dl compact><dt><b>
506Exceptions: </b><dd>
507<table border=0 cellspacing=2 cellpadding=0>
508<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
509 TYPE_ERR: raised if resultType is not UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE. </td></tr>
510<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
511 INVALID_STATE_ERR: The document has been mutated since the result was returned. </td></tr>
512</table>
513</dl>    </td>
514  </tr>
515</table>
516<a name="z207_8" doxytag="DOMXPathResult::snapshotItem"></a><p>
517<table width="100%" cellpadding="2" cellspacing="0" border="0">
518  <tr>
519    <td class="md">
520      <table cellpadding="0" cellspacing="0" border="0">
521        <tr>
522          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMXPathResult::snapshotItem </td>
523          <td class="md" valign="top">(&nbsp;</td>
524          <td class="md" nowrap valign="top">unsigned long&nbsp;</td>
525          <td class="mdname1" valign="top" nowrap>&nbsp; <em>index</em>          </td>
526          <td class="md" valign="top">)&nbsp;</td>
527          <td class="md" nowrap> const<code> [pure virtual]</code></td>
528        </tr>
529
530      </table>
531    </td>
532  </tr>
533</table>
534<table cellspacing=5 cellpadding=0 border=0>
535  <tr>
536    <td>
537      &nbsp;
538    </td>
539    <td>
540
541<p>
542Returns the indexth item in the snapshot collection.
543<p>
544If 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>
545Parameters: </b><dd>
546<table border=0 cellspacing=2 cellpadding=0>
547<tr><td valign=top><em>index</em>&nbsp;</td><td>
548of type unsigned long - Index into the snapshot collection. </td></tr>
549</table>
550</dl><dl compact><dt><b>
551Returns: </b><dd>
552The node at the indexth position in the NodeList, or null if that is not a valid index. </dl><dl compact><dt><b>
553Exceptions: </b><dd>
554<table border=0 cellspacing=2 cellpadding=0>
555<tr><td valign=top><em>XPathException</em>&nbsp;</td><td>
556 TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE. </td></tr>
557</table>
558</dl>    </td>
559  </tr>
560</table>
561<hr>The documentation for this class was generated from the following file:<ul>
562<li><a class="el" href="DOMXPathResult_8hpp-source.html">DOMXPathResult.hpp</a></ul>
563    </FONT></TD></TR></TABLE><BR>
564</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>
565              Copyright &copy; 1994-2004 The Apache Software Foundation.
566              All Rights Reserved.
567            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.