Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / old / xalan-c / apiDocs / XPathCAPI_8h.html
blob: d420c942ee5bd26ce4976120c5777bd850ac85d9 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<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>
<hr><h1>XPathCAPI.h File Reference</h1>
<p>
<a href="XPathCAPI_8h-source.html">Go to the source code of this file.</a><h2>Defines</h2>
<ul>
<li>#define <a class="el" href="XPathCAPI_8h.html#a0">XALAN_XPATHCAPI_HEADER_GUARD_1357924680</a>
<li>#define <a class="el" href="XPathCAPI_8h.html#a1">XALAN_XPATHCAPI_EXPORT</a>
<li>#define <a class="el" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(T)&nbsp;&nbsp;&nbsp;T
<li>#define <a class="el" href="XPathCAPI_8h.html#a3">XALAN_XPATH_API_SUCCESS</a>&nbsp;&nbsp;&nbsp;0
<dl class="el"><dd><font size=-1><em>This is a simple C interface for the class <a class="el" href="classXPathEvaluator.html">XPathEvaluator</a>.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>#define <a class="el" href="XPathCAPI_8h.html#a4">XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED</a>&nbsp;&nbsp;&nbsp;1
<li>#define <a class="el" href="XPathCAPI_8h.html#a5">XALAN_XPATH_API_ERROR_ALREADY_TERMINATED</a>&nbsp;&nbsp;&nbsp;2
<li>#define <a class="el" href="XPathCAPI_8h.html#a6">XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED</a>&nbsp;&nbsp;&nbsp;3
<li>#define <a class="el" href="XPathCAPI_8h.html#a7">XALAN_XPATH_API_ERROR_TERMINATION_FAILED</a>&nbsp;&nbsp;&nbsp;4
<li>#define <a class="el" href="XPathCAPI_8h.html#a8">XALAN_XPATH_API_ERROR_NOT_INITIALIZED</a>&nbsp;&nbsp;&nbsp;5
<li>#define <a class="el" href="XPathCAPI_8h.html#a9">XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE</a>&nbsp;&nbsp;&nbsp;6
<li>#define <a class="el" href="XPathCAPI_8h.html#a10">XALAN_XPATH_API_ERROR_INVALID_PARAMETER</a>&nbsp;&nbsp;&nbsp;7
<li>#define <a class="el" href="XPathCAPI_8h.html#a11">XALAN_XPATH_API_ERROR_INVALID_EXPRESSION</a>&nbsp;&nbsp;&nbsp;8
<li>#define <a class="el" href="XPathCAPI_8h.html#a12">XALAN_XPATH_API_ERROR_BAD_XML</a>&nbsp;&nbsp;&nbsp;9
<li>#define <a class="el" href="XPathCAPI_8h.html#a13">XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING</a>&nbsp;&nbsp;&nbsp;10
<li>#define <a class="el" href="XPathCAPI_8h.html#a14">XALAN_XPATH_API_ERROR_TRANSCODING</a>&nbsp;&nbsp;&nbsp;11
<li>#define <a class="el" href="XPathCAPI_8h.html#a15">XALAN_XPATH_API_ERROR_INVALID_XPATH</a>&nbsp;&nbsp;&nbsp;12
<li>#define <a class="el" href="XPathCAPI_8h.html#a16">XALAN_XPATH_API_ERROR_UNKNOWN</a>&nbsp;&nbsp;&nbsp;13
</ul>
<h2>Typedefs</h2>
<ul>
<li>typedef void* <a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a>
<dl class="el"><dd><font size=-1><em>Handle used to store the address of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance.</em> <a href="#a17">More...</a><em><br><br></em></font></dl><li>typedef void* <a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a>
<dl class="el"><dd><font size=-1><em>Handle used to store the address of compiled <a class="el" href="classXPath.html">XPath</a> instance.</em> <a href="#a18">More...</a><em><br><br></em></font></dl></ul>
<h2>Functions</h2>
<ul>
<li>int <a class="el" href="XPathCAPI_8h.html#a19">XalanXPathAPIInitialize</a> ()
<dl class="el"><dd><font size=-1><em>Initialize Xerces and the <a class="el" href="classXPath.html">XPath</a> API.</em> <a href="#a19">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a20">XalanXPathAPITerminate</a> ()
<dl class="el"><dd><font size=-1><em>Terminate Xerces and the <a class="el" href="classXPath.html">XPath</a> API.</em> <a href="#a20">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a21">XalanCreateXPathEvaluator</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> *theHandle)
<dl class="el"><dd><font size=-1><em>Create a XalanXPathEvaluator instance.</em> <a href="#a21">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a22">XalanDestroyXPathEvaluator</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> theXalanHandle)
<dl class="el"><dd><font size=-1><em>Destroy a XalanXPathEvaluator instance.</em> <a href="#a22">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a23">XalanCreateXPath</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, <a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> *theXPathHandle)
<dl class="el"><dd><font size=-1><em>Creates a compiled <a class="el" href="classXPath.html">XPath</a> instance.</em> <a href="#a23">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a24">XalanDestroyXPath</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> theXalanHandle, <a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> theXPathHandle)
<dl class="el"><dd><font size=-1><em>Destroys a compiled <a class="el" href="classXPath.html">XPath</a> instance.</em> <a href="#a24">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a25">XalanEvaluateXPathAsBoolean</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> theXalanHandle, <a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> theXPathHandle, const char *theXML, int *theResult)
<dl class="el"><dd><font size=-1><em>Evaluates a compiled <a class="el" href="classXPath.html">XPath</a> instance.</em> <a href="#a25">More...</a><em><br><br></em></font></dl><li>int <a class="el" href="XPathCAPI_8h.html#a26">XalanEvaluateXPathExpressionAsBoolean</a> (<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, const char *theXML, int *theResult)
<dl class="el"><dd><font size=-1><em>Evaluates an <a class="el" href="classXPath.html">XPath</a> expression.</em> <a href="#a26">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Define Documentation</h2>
<a name="a1" doxytag="XPathCAPI.h::XALAN_XPATHCAPI_EXPORT"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATHCAPI_EXPORT
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>
</pre></div> </td>
</tr>
</table>
<a name="a2" doxytag="XPathCAPI.h::XALAN_XPATHCAPI_EXPORT_FUNCTION"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATHCAPI_EXPORT_FUNCTION(
</b></td>
<td valign="bottom"><b>
T&nbsp;)&nbsp;&nbsp;&nbsp;T
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="XPathCAPI.h::XALAN_XPATHCAPI_HEADER_GUARD_1357924680"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATHCAPI_HEADER_GUARD_1357924680
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>
</pre></div> </td>
</tr>
</table>
<a name="a4" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED&nbsp;&nbsp;&nbsp;1
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_ALREADY_TERMINATED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED&nbsp;&nbsp;&nbsp;2
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a12" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_BAD_XML"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_BAD_XML&nbsp;&nbsp;&nbsp;9
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a9" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE&nbsp;&nbsp;&nbsp;6
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED&nbsp;&nbsp;&nbsp;3
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_EXPRESSION"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION&nbsp;&nbsp;&nbsp;8
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_PARAMETER"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_INVALID_PARAMETER&nbsp;&nbsp;&nbsp;7
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a15" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_XPATH"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_INVALID_XPATH&nbsp;&nbsp;&nbsp;12
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_NOT_INITIALIZED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_NOT_INITIALIZED&nbsp;&nbsp;&nbsp;5
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a7" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_TERMINATION_FAILED"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_TERMINATION_FAILED&nbsp;&nbsp;&nbsp;4
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a14" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_TRANSCODING"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_TRANSCODING&nbsp;&nbsp;&nbsp;11
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a16" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_UNKNOWN"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_UNKNOWN&nbsp;&nbsp;&nbsp;13
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="XPathCAPI.h::XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING&nbsp;&nbsp;&nbsp;10
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="XPathCAPI.h::XALAN_XPATH_API_SUCCESS"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
#define XALAN_XPATH_API_SUCCESS&nbsp;&nbsp;&nbsp;0
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This is a simple C interface for the class <a class="el" href="classXPathEvaluator.html">XPathEvaluator</a>.
<p>
It's the user's responsibility to call <a class="el" href="XPathCAPI_8h.html#a19">XalanXPathAPIInitialize</a>() before making any other API calls, and to call <a class="el" href="XPathCAPI_8h.html#a20">XalanXPathAPITerminate</a>() when finished with the API. </td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a name="a17" doxytag="XPathCAPI.h::XalanXPathEvaluatorHandle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef void * XalanXPathEvaluatorHandle
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Handle used to store the address of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance.
<p>
</td>
</tr>
</table>
<a name="a18" doxytag="XPathCAPI.h::XalanXPathHandle"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef void * XalanXPathHandle
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Handle used to store the address of compiled <a class="el" href="classXPath.html">XPath</a> instance.
<p>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a23" doxytag="XPathCAPI.h::XalanCreateXPath"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanCreateXPath (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> <em>theXalanHandle</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXPathExpression</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXPathExpressionEncoding</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> * <em>theXPathHandle</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Creates a compiled <a class="el" href="classXPath.html">XPath</a> instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
The handle of XalanXPathEvaluatorHandle instance. </td></tr>
<tr><td valign=top><em>theXPathExpression</em>
&nbsp;</td><td>
The expression to compile </td></tr>
<tr><td valign=top><em>theXPathExpressionEncoding</em>
&nbsp;</td><td>
The encoding of the expression. If NULL or an empty string, the local code page is assumed. </td></tr>
<tr><td valign=top><em>theXPathHandle</em>
&nbsp;</td><td>
A pointer to the handle for the new instance </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a21" doxytag="XPathCAPI.h::XalanCreateXPathEvaluator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanCreateXPathEvaluator (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> * <em>theHandle</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Create a XalanXPathEvaluator instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
A pointer to the handle for the new instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a24" doxytag="XPathCAPI.h::XalanDestroyXPath"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanDestroyXPath (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> <em>theXalanHandle</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> <em>theXPathHandle</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destroys a compiled <a class="el" href="classXPath.html">XPath</a> instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
The handle of XalanXPathEvaluatorHandle instance. </td></tr>
<tr><td valign=top><em>theXPathHandle</em>
&nbsp;</td><td>
The handle of <a class="el" href="classXPath.html">XPath</a> instance </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a22" doxytag="XPathCAPI.h::XalanDestroyXPathEvaluator"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanDestroyXPathEvaluator (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> <em>theXalanHandle</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Destroy a XalanXPathEvaluator instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
The handle of the instance to destroy. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a25" doxytag="XPathCAPI.h::XalanEvaluateXPathAsBoolean"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanEvaluateXPathAsBoolean (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> <em>theXalanHandle</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XPathCAPI_8h.html#a18">XalanXPathHandle</a> <em>theXPathHandle</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXML</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>theResult</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Evaluates a compiled <a class="el" href="classXPath.html">XPath</a> instance.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
The handle of XalanXPathEvaluatorHandle instance. </td></tr>
<tr><td valign=top><em>theXPathHandle</em>
&nbsp;</td><td>
The pointer to handle for instance </td></tr>
<tr><td valign=top><em>theXML</em>
&nbsp;</td><td>
The XML document to use for evaluating the <a class="el" href="classXPath.html">XPath</a> expression </td></tr>
<tr><td valign=top><em>theResult</em>
&nbsp;</td><td>
A pointer to an int to receive the result. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a26" doxytag="XPathCAPI.h::XalanEvaluateXPathExpressionAsBoolean"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanEvaluateXPathExpressionAsBoolean (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XPathCAPI_8h.html#a17">XalanXPathEvaluatorHandle</a> <em>theXalanHandle</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXPathExpression</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXPathExpressionEncoding</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const char * <em>theXML</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
int * <em>theResult</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Evaluates an <a class="el" href="classXPath.html">XPath</a> expression.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theXalanHandle</em>
&nbsp;</td><td>
The handle of XalanXPathEvaluatorHandle instance. </td></tr>
<tr><td valign=top><em>theXPathExpression</em>
&nbsp;</td><td>
The expression to evaluate </td></tr>
<tr><td valign=top><em>theXPathExpressionEncoding</em>
&nbsp;</td><td>
The encoding of the expression. If NULL or an empty string, the local code page is assumed. </td></tr>
<tr><td valign=top><em>theXML</em>
&nbsp;</td><td>
The XML document to use for evaluating the <a class="el" href="classXPath.html">XPath</a> expression </td></tr>
<tr><td valign=top><em>theResult</em>
&nbsp;</td><td>
A pointer to an int to receive the result. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a19" doxytag="XPathCAPI.h::XalanXPathAPIInitialize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanXPathAPIInitialize (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Initialize Xerces and the <a class="el" href="classXPath.html">XPath</a> API.
<p>
Should be called only once per process before making any other API calls.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<a name="a20" doxytag="XPathCAPI.h::XalanXPathAPITerminate"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
int XalanXPathAPITerminate (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Terminate Xerces and the <a class="el" href="classXPath.html">XPath</a> API.
<p>
Should be called only once per process after deleting all instances of XalanXPathEvaluator. Once a process has called this function, it cannot use the API for the remaining lifetime of the process.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
0 for success, or a non-zero error code upon failure </dl> </td>
</tr>
</table>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>