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

Revision 358, 19.8 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>DOMXPathExpression 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>DOMXPathExpression Class Reference</h1>The <code>DOMXPathExpression</code> interface represents a parsed and resolved XPath expression.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMXPathExpression-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
48<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
49<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
50<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathExpression.html#z192_0">~DOMXPathExpression</a> ()</td></tr>
51<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z192_0">More...</a><em></em></font><br><br></td></tr>
52<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
53<tr><td nowrap align=right valign=top>virtual void *&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathExpression.html#z193_0">evaluate</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *contextNode, unsigned short type, void *result) const=0</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>Evaluates this XPath expression and returns a result.</em> <a href="#z193_0">More...</a><em></em></font><br><br></td></tr>
55<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
56<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
57<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMXPathExpression.html#z190_0">DOMXPathExpression</a> ()</td></tr>
58</table>
59<hr><a name="_details"></a><h2>Detailed Description</h2>
60The <code>DOMXPathExpression</code> interface represents a parsed and resolved XPath expression.
61<p>
62<dl compact><dt><b>
63Since: </b><dd>
64DOM Level 3 </dl>
65<p>
66<hr><h2>Constructor &amp; Destructor Documentation</h2>
67<a name="z190_0" doxytag="DOMXPathExpression::DOMXPathExpression"></a><p>
68<table width="100%" cellpadding="2" cellspacing="0" border="0">
69  <tr>
70    <td class="md">
71      <table cellpadding="0" cellspacing="0" border="0">
72        <tr>
73          <td class="md" nowrap valign="top"> DOMXPathExpression::DOMXPathExpression </td>
74          <td class="md" valign="top">(&nbsp;</td>
75          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
76          <td class="md" valign="top">)&nbsp;</td>
77          <td class="md" nowrap><code> [protected]</code></td>
78        </tr>
79
80      </table>
81    </td>
82  </tr>
83</table>
84<table cellspacing=5 cellpadding=0 border=0>
85  <tr>
86    <td>
87      &nbsp;
88    </td>
89    <td>
90
91<p>
92    </td>
93  </tr>
94</table>
95<a name="z192_0" doxytag="DOMXPathExpression::~DOMXPathExpression"></a><p>
96<table width="100%" cellpadding="2" cellspacing="0" border="0">
97  <tr>
98    <td class="md">
99      <table cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td class="md" nowrap valign="top"> virtual DOMXPathExpression::~DOMXPathExpression </td>
102          <td class="md" valign="top">(&nbsp;</td>
103          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
104          <td class="md" valign="top">)&nbsp;</td>
105          <td class="md" nowrap><code> [virtual]</code></td>
106        </tr>
107
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>
120Destructor.
121<p>
122    </td>
123  </tr>
124</table>
125<hr><h2>Member Function Documentation</h2>
126<a name="z193_0" doxytag="DOMXPathExpression::evaluate"></a><p>
127<table width="100%" cellpadding="2" cellspacing="0" border="0">
128  <tr>
129    <td class="md">
130      <table cellpadding="0" cellspacing="0" border="0">
131        <tr>
132          <td class="md" nowrap valign="top"> virtual void* DOMXPathExpression::evaluate </td>
133          <td class="md" valign="top">(&nbsp;</td>
134          <td class="md" nowrap valign="top"><a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td>
135          <td class="mdname" nowrap>&nbsp; <em>contextNode</em>, </td>
136        </tr>
137        <tr>
138          <td></td>
139          <td></td>
140          <td class="md" nowrap>unsigned short&nbsp;</td>
141          <td class="mdname" nowrap>&nbsp; <em>type</em>, </td>
142        </tr>
143        <tr>
144          <td></td>
145          <td></td>
146          <td class="md" nowrap>void *&nbsp;</td>
147          <td class="mdname" nowrap>&nbsp; <em>result</em></td>
148        </tr>
149        <tr>
150          <td></td>
151          <td class="md">)&nbsp;</td>
152          <td class="md" colspan="2"> const<code> [pure virtual]</code></td>
153        </tr>
154
155      </table>
156    </td>
157  </tr>
158</table>
159<table cellspacing=5 cellpadding=0 border=0>
160  <tr>
161    <td>
162      &nbsp;
163    </td>
164    <td>
165
166<p>
167Evaluates this XPath expression and returns a result.
168<p>
169<dl compact><dt><b>
170Parameters: </b><dd>
171<table border=0 cellspacing=2 cellpadding=0>
172<tr><td valign=top><em>contextNode</em>&nbsp;</td><td>
173of type <code><a class="el" href="classDOMNode.html">DOMNode</a></code> The context is context node for the evaluation of this XPath expression. If the XPathEvaluator was obtained by casting the Document then this must  be owned by the same document and must be a <code><a class="el" href="classDOMDocument.html">DOMDocument</a></code>, <code><a class="el" href="classDOMElement.html">DOMElement</a></code>,  <code>DOMAttribute</code>, <code><a class="el" href="classDOMText.html">DOMText</a></code>, <code><a class="el" href="classDOMCDATASection.html">DOMCDATASection</a></code>,  <code><a class="el" href="classDOMComment.html">DOMComment</a></code>, <code><a class="el" href="classDOMProcessingInstruction.html">DOMProcessingInstruction</a></code>, or  <code>XPathNamespace</code>. If the context node is a <code><a class="el" href="classDOMText.html">DOMText</a></code> or a  <code><a class="el" href="classDOMCDATASection.html">DOMCDATASection</a></code>, then the context is interpreted as the whole logical text node as seen by XPath, unless the node is empty in which case it may not serve as the XPath context. </td></tr>
174<tr><td valign=top><em>type</em>&nbsp;</td><td>
175of type unsigned short If a specific type is specified, then the result will be coerced to return the specified type relying on XPath conversions and fail  if the desired coercion is not possible. This must be one of the type codes of <code>XPathResult</code>. </td></tr>
176<tr><td valign=top><em>result</em>&nbsp;</td><td>
177of type void* The result specifies a specific result object which may be reused and returned by this method. If this is specified as nullor the  implementation does not reuse the specified result, a new result object will be constructed and returned. For XPath 1.0 results, this object will be of type <code>XPathResult</code>. </td></tr>
178</table>
179</dl><dl compact><dt><b>
180Returns: </b><dd>
181void* The result of the evaluation of the XPath expression. For XPath 1.0 results, this object will be of type <code>XPathResult</code>. </dl><dl compact><dt><b>
182Exceptions: </b><dd>
183<table border=0 cellspacing=2 cellpadding=0>
184<tr><td valign=top><em>code</em>&nbsp;</td><td>
185&gt;XPathException</code> TYPE_ERR: Raised if the result cannot be converted to return the specified type. </td></tr>
186<tr><td valign=top><em>code</em>&nbsp;</td><td>
187&gt;<a class="el" href="classDOMException.html">DOMException</a></code> WRONG_DOCUMENT_ERR: The <code><a class="el" href="classDOMNode.html">DOMNode</a></code> is from a document that is not supported by  the <code>XPathEvaluator</code> that created this <code>DOMXPathExpression</code>. NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the  request type is not permitted by this <code>DOMXPathExpression</code>. </td></tr>
188</table>
189</dl>    </td>
190  </tr>
191</table>
192<hr>The documentation for this class was generated from the following file:<ul>
193<li><a class="el" href="DOMXPathExpression_8hpp-source.html">DOMXPathExpression.hpp</a></ul>
194    </FONT></TD></TR></TABLE><BR>
195</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>
196              Copyright &copy; 1994-2004 The Apache Software Foundation.
197              All Rights Reserved.
198            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.