189 lines
11 KiB
HTML
189 lines
11 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>XQilla DOM3 API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.5.1 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul></div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul></div>
|
|
<div class="nav">
|
|
<a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></div>
|
|
<h1>xercesc::DOMXPathExpression Class Reference</h1><!-- doxytag: class="xercesc::DOMXPathExpression" -->The <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code> interface represents a parsed and resolved XPath expression.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="DOMXPathExpression_8hpp-source.html">DOMXPathExpression.hpp</a>></code>
|
|
<p>
|
|
Inheritance diagram for xercesc::DOMXPathExpression:<p><center><img src="classxercesc_1_1DOMXPathExpression__inherit__graph.png" border="0" usemap="#xercesc_1_1DOMXPathExpression__inherit__map" alt="Inheritance graph"></center>
|
|
<map name="xercesc_1_1DOMXPathExpression__inherit__map">
|
|
<area href="classXQillaExpression.html" shape="rect" coords="52,81,185,105" alt="">
|
|
</map>
|
|
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1DOMXPathExpression-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 Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMXPathExpression.html#7eec9df5d8183f00d0bb969ab156f1c9">evaluate</a> (<a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *contextNode, unsigned short type, void *result) const=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Evaluates this XPath expression and returns a result. <a href="#7eec9df5d8183f00d0bb969ab156f1c9"></a><br></td></tr>
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
The <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code> interface represents a parsed and resolved XPath expression.
|
|
<p>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="7b3c3c32202f60035a8c808f1137d6e5"></a><!-- doxytag: member="xercesc::DOMXPathExpression::DOMXPathExpression" ref="7b3c3c32202f60035a8c808f1137d6e5" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMXPathExpression::DOMXPathExpression </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d0abb1c72444a5a0286b37e877a35bea"></a><!-- doxytag: member="xercesc::DOMXPathExpression::~DOMXPathExpression" ref="d0abb1c72444a5a0286b37e877a35bea" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMXPathExpression::~DOMXPathExpression </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="7b3c3c32202f60035a8c808f1137d6e5"></a><!-- doxytag: member="xercesc::DOMXPathExpression::DOMXPathExpression" ref="7b3c3c32202f60035a8c808f1137d6e5" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::DOMXPathExpression::DOMXPathExpression </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d0abb1c72444a5a0286b37e877a35bea"></a><!-- doxytag: member="xercesc::DOMXPathExpression::~DOMXPathExpression" ref="d0abb1c72444a5a0286b37e877a35bea" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::DOMXPathExpression::~DOMXPathExpression </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [inline, 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="7eec9df5d8183f00d0bb969ab156f1c9"></a><!-- doxytag: member="xercesc::DOMXPathExpression::evaluate" ref="7eec9df5d8183f00d0bb969ab156f1c9" args="(DOMNode *contextNode, unsigned short type, void *result) const=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* xercesc::DOMXPathExpression::evaluate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="paramname"> <em>contextNode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned short </td>
|
|
<td class="paramname"> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>result</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Evaluates this XPath expression and returns a result.
|
|
<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>contextNode</em> </td><td>of type <code><a class="el" href="classxercesc_1_1DOMNode.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="classxercesc_1_1DOMDocument.html">DOMDocument</a></code>, <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code>, <code>DOMAttribute</code>, <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code>, <code><a class="el" href="classxercesc_1_1DOMCDATASection.html">DOMCDATASection</a></code>, <code><a class="el" href="classxercesc_1_1DOMComment.html">DOMComment</a></code>, <code><a class="el" href="classxercesc_1_1DOMProcessingInstruction.html">DOMProcessingInstruction</a></code>, or <code>XPathNamespace</code>. If the context node is a <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> or a <code><a class="el" href="classxercesc_1_1DOMCDATASection.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>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>of 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>
|
|
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>of 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>
|
|
</table>
|
|
</dl>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>void* The result of the evaluation of the XPath expression. For XPath 1.0 results, this object will be of type <code>XPathResult</code>. </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><code>XPathException</code></em> </td><td>TYPE_ERR: Raised if the result cannot be converted to return the specified type. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em><code>DOMException</code></em> </td><td>WRONG_DOCUMENT_ERR: The <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> is from a document that is not supported by the <code>XPathEvaluator</code> that created this <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></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><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
<p>
|
|
Implemented in <a class="el" href="classXQillaExpression.html#b8a28b7fd9bde9a70354b15730286b8f">XQillaExpression</a>.
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DOMXPathExpression_8hpp-source.html">DOMXPathExpression.hpp</a></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 8 14:29:47 2008 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
|
|
</body>
|
|
</html>
|