| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <title>Xalan-C++ API : Main Page</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| <!-- The head section is copied from Doxygen 1.7.1 generated default output --> |
| <body> |
| <h2 align="center">Xalan-C++ API Documentation</h2> |
| <h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3> |
| <hr/> |
| <!-- Generated by Doxygen 1.7.1 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="annotated.html"><span>Classes</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| <div class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>File Members</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Defines</a> | |
| <a href="#typedef-members">Typedefs</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <h1>XPathCAPI.h File Reference</h1> </div> |
| </div> |
| <div class="contents"> |
| |
| <p><a href="XPathCAPI_8h_source.html">Go to the source code of this file.</a></p> |
| <h2><a name="define-members"></a> |
| Defines</h2> |
| <ul> |
| <li>#define <a class="el" href="XPathCAPI_8h.html#aa6184e651a559b58abda2648c7b2ef24">XALAN_XPATHCAPI_EXPORT</a> |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a9f9293d731f78cbcc6880e9b2a717d49">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(T) T |
| <li>#define <a class="el" href="XPathCAPI_8h.html#ab0aea6458f3a6aa94b375a50e2170ed4">XALAN_XPATH_API_SUCCESS</a> 0 |
| <dl class="el"><dd class="mdescRight">This is a simple C interface for the class <a class="el" href="classXPathEvaluator.html">XPathEvaluator</a>. <a href="#ab0aea6458f3a6aa94b375a50e2170ed4"></a><br/></dl><li>#define <a class="el" href="XPathCAPI_8h.html#af863d3339a42b4115849b3feb0d3cce1">XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED</a> 1 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a14305196b35f9a8ebb0eb596ff7df249">XALAN_XPATH_API_ERROR_ALREADY_TERMINATED</a> 2 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a80cc1346c859b542c655824ca6c7496e">XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED</a> 3 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a2057441c54a973ccce27e9d4b0e71e04">XALAN_XPATH_API_ERROR_TERMINATION_FAILED</a> 4 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#ac39b4e5c459c8db6552d8b31f370221b">XALAN_XPATH_API_ERROR_NOT_INITIALIZED</a> 5 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#abb31774afe6d5a94fca5b64394d5a135">XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE</a> 6 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#aa09f0d3ce657ef9fc15d4486b0bc3bb9">XALAN_XPATH_API_ERROR_INVALID_PARAMETER</a> 7 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#ad7120896a7a31096cdc2ec2ed97bc955">XALAN_XPATH_API_ERROR_INVALID_EXPRESSION</a> 8 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#aa5bf15051f5550d4f45e6f09298e96ee">XALAN_XPATH_API_ERROR_BAD_XML</a> 9 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a85a47125e4ab568736bd43d9f72b1261">XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING</a> 10 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a2e672a9a69111847d7bb38dcdab86c42">XALAN_XPATH_API_ERROR_TRANSCODING</a> 11 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#a31c4602dfa44e2ca0779e237dea707d0">XALAN_XPATH_API_ERROR_INVALID_XPATH</a> 12 |
| <li>#define <a class="el" href="XPathCAPI_8h.html#aee288a35f68f89dadb7ef255c066d011">XALAN_XPATH_API_ERROR_UNKNOWN</a> 13 |
| </ul> |
| <h2><a name="typedef-members"></a> |
| Typedefs</h2> |
| <ul> |
| <li>typedef void * <a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> |
| <dl class="el"><dd class="mdescRight">Handle used to store the address of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. <a href="#a8b059ea19f08cf507bf245d410a56a03"></a><br/></dl><li>typedef void * <a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> |
| <dl class="el"><dd class="mdescRight">Handle used to store the address of compiled <a class="el" href="classXPath.html">XPath</a> instance. <a href="#a4835f5a9e2500951ef8778e3b7d3bab2"></a><br/></dl></ul> |
| <h2><a name="func-members"></a> |
| Functions</h2> |
| <ul> |
| <li>int <a class="el" href="XPathCAPI_8h.html#ad17c4b3687113265bc9821fe8105718c">XalanXPathAPIInitialize</a> () |
| <dl class="el"><dd class="mdescRight">Initialize Xerces and the <a class="el" href="classXPath.html">XPath</a> API. <a href="#ad17c4b3687113265bc9821fe8105718c"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#a8a7b053b0c494de5481800d3950f709b">XalanXPathAPITerminate</a> () |
| <dl class="el"><dd class="mdescRight">Terminate Xerces and the <a class="el" href="classXPath.html">XPath</a> API. <a href="#a8a7b053b0c494de5481800d3950f709b"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#ab5aa9462ce7045e5e11b3617d92edde2">XalanCreateXPathEvaluator</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> *theHandle) |
| <dl class="el"><dd class="mdescRight">Create a XalanXPathEvaluator instance. <a href="#ab5aa9462ce7045e5e11b3617d92edde2"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#a184778386cf41b54a109a0ba3628bd99">XalanDestroyXPathEvaluator</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> theXalanHandle) |
| <dl class="el"><dd class="mdescRight">Destroy a XalanXPathEvaluator instance. <a href="#a184778386cf41b54a109a0ba3628bd99"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#a7f22c4eed6d28bb86d9f35873edd428a">XalanCreateXPath</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, <a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> *theXPathHandle) |
| <dl class="el"><dd class="mdescRight">Creates a compiled <a class="el" href="classXPath.html">XPath</a> instance. <a href="#a7f22c4eed6d28bb86d9f35873edd428a"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#a9850a9f174cb79e89c944d2b01e0dcb8">XalanDestroyXPath</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> theXalanHandle, <a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> theXPathHandle) |
| <dl class="el"><dd class="mdescRight">Destroys a compiled <a class="el" href="classXPath.html">XPath</a> instance. <a href="#a9850a9f174cb79e89c944d2b01e0dcb8"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#abc0df2957dfd41348499edb70eb26100">XalanEvaluateXPathAsBoolean</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> theXalanHandle, <a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> theXPathHandle, const char *theXML, int *<a class="el" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>) |
| <dl class="el"><dd class="mdescRight">Evaluates a compiled <a class="el" href="classXPath.html">XPath</a> instance. <a href="#abc0df2957dfd41348499edb70eb26100"></a><br/></dl><li>int <a class="el" href="XPathCAPI_8h.html#a24ec6a07fd35de6b38103a0f57f16959">XalanEvaluateXPathExpressionAsBoolean</a> (<a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, const char *theXML, int *<a class="el" href="XalanDOMString_8hpp.html#ad0987a2085caff760532b7f16b5c6f2e">theResult</a>) |
| <dl class="el"><dd class="mdescRight">Evaluates an <a class="el" href="classXPath.html">XPath</a> expression. <a href="#a24ec6a07fd35de6b38103a0f57f16959"></a><br/></dl></ul> |
| <hr/><h2>Define Documentation</h2> |
| <a class="anchor" id="af863d3339a42b4115849b3feb0d3cce1"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED" ref="af863d3339a42b4115849b3feb0d3cce1" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED 1</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00058">58</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a14305196b35f9a8ebb0eb596ff7df249"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_ALREADY_TERMINATED" ref="a14305196b35f9a8ebb0eb596ff7df249" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED 2</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00059">59</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa5bf15051f5550d4f45e6f09298e96ee"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_BAD_XML" ref="aa5bf15051f5550d4f45e6f09298e96ee" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_BAD_XML 9</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00066">66</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abb31774afe6d5a94fca5b64394d5a135"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE" ref="abb31774afe6d5a94fca5b64394d5a135" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE 6</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00063">63</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a80cc1346c859b542c655824ca6c7496e"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED" ref="a80cc1346c859b542c655824ca6c7496e" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED 3</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00060">60</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad7120896a7a31096cdc2ec2ed97bc955"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_EXPRESSION" ref="ad7120896a7a31096cdc2ec2ed97bc955" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION 8</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00065">65</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa09f0d3ce657ef9fc15d4486b0bc3bb9"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_PARAMETER" ref="aa09f0d3ce657ef9fc15d4486b0bc3bb9" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_INVALID_PARAMETER 7</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00064">64</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a31c4602dfa44e2ca0779e237dea707d0"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_INVALID_XPATH" ref="a31c4602dfa44e2ca0779e237dea707d0" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_INVALID_XPATH 12</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00069">69</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac39b4e5c459c8db6552d8b31f370221b"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_NOT_INITIALIZED" ref="ac39b4e5c459c8db6552d8b31f370221b" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_NOT_INITIALIZED 5</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00062">62</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2057441c54a973ccce27e9d4b0e71e04"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_TERMINATION_FAILED" ref="a2057441c54a973ccce27e9d4b0e71e04" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_TERMINATION_FAILED 4</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00061">61</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2e672a9a69111847d7bb38dcdab86c42"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_TRANSCODING" ref="a2e672a9a69111847d7bb38dcdab86c42" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_TRANSCODING 11</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00068">68</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aee288a35f68f89dadb7ef255c066d011"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_UNKNOWN" ref="aee288a35f68f89dadb7ef255c066d011" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_UNKNOWN 13</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00070">70</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a85a47125e4ab568736bd43d9f72b1261"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING" ref="a85a47125e4ab568736bd43d9f72b1261" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING 10</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00067">67</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab0aea6458f3a6aa94b375a50e2170ed4"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATH_API_SUCCESS" ref="ab0aea6458f3a6aa94b375a50e2170ed4" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATH_API_SUCCESS 0</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>This is a simple C interface for the class <a class="el" href="classXPathEvaluator.html">XPathEvaluator</a>. </p> |
| <p>It's the user's responsibility to call <a class="el" href="XPathCAPI_8h.html#ad17c4b3687113265bc9821fe8105718c" title="Initialize Xerces and the XPath API.">XalanXPathAPIInitialize()</a> before making any other API calls, and to call <a class="el" href="XPathCAPI_8h.html#a8a7b053b0c494de5481800d3950f709b" title="Terminate Xerces and the XPath API.">XalanXPathAPITerminate()</a> when finished with the API. </p> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00057">57</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa6184e651a559b58abda2648c7b2ef24"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATHCAPI_EXPORT" ref="aa6184e651a559b58abda2648c7b2ef24" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATHCAPI_EXPORT</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00039">39</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9f9293d731f78cbcc6880e9b2a717d49"></a><!-- doxytag: member="XPathCAPI.h::XALAN_XPATHCAPI_EXPORT_FUNCTION" ref="a9f9293d731f78cbcc6880e9b2a717d49" args="(T)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define XALAN_XPATHCAPI_EXPORT_FUNCTION</td> |
| <td>(</td> |
| <td class="paramtype"> </td> |
| <td class="paramname">T</td> |
| <td> ) </td> |
| <td> T</td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00040">40</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Typedef Documentation</h2> |
| <a class="anchor" id="a8b059ea19f08cf507bf245d410a56a03"></a><!-- doxytag: member="XPathCAPI.h::XalanXPathEvaluatorHandle" ref="a8b059ea19f08cf507bf245d410a56a03" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void* <a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Handle used to store the address of <a class="el" href="classXalanTransformer.html" title="This is a simple C++ interface for some common usage patterns.">XalanTransformer</a> instance. </p> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00076">76</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4835f5a9e2500951ef8778e3b7d3bab2"></a><!-- doxytag: member="XPathCAPI.h::XalanXPathHandle" ref="a4835f5a9e2500951ef8778e3b7d3bab2" args="" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">typedef void* <a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Handle used to store the address of compiled <a class="el" href="classXPath.html">XPath</a> instance. </p> |
| |
| <p>Definition at line <a class="el" href="XPathCAPI_8h_source.html#l00081">81</a> of file <a class="el" href="XPathCAPI_8h_source.html">XPathCAPI.h</a>.</p> |
| |
| </div> |
| </div> |
| <hr/><h2>Function Documentation</h2> |
| <a class="anchor" id="a7f22c4eed6d28bb86d9f35873edd428a"></a><!-- doxytag: member="XPathCAPI.h::XalanCreateXPath" ref="a7f22c4eed6d28bb86d9f35873edd428a" args="(XalanXPathEvaluatorHandle theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, XalanXPathHandle *theXPathHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanCreateXPath </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXPathExpression</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXPathExpressionEncoding</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> * </td> |
| <td class="paramname"> <em>theXPathHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Creates a compiled <a class="el" href="classXPath.html">XPath</a> instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of XalanXPathEvaluatorHandle instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathExpression</em> </td><td>The expression to compile </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathExpressionEncoding</em> </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"></td><td valign="top"><em>theXPathHandle</em> </td><td>A pointer to the handle for the new instance </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab5aa9462ce7045e5e11b3617d92edde2"></a><!-- doxytag: member="XPathCAPI.h::XalanCreateXPathEvaluator" ref="ab5aa9462ce7045e5e11b3617d92edde2" args="(XalanXPathEvaluatorHandle *theHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanCreateXPathEvaluator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> * </td> |
| <td class="paramname"> <em>theHandle</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Create a XalanXPathEvaluator instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>A pointer to the handle for the new instance. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9850a9f174cb79e89c944d2b01e0dcb8"></a><!-- doxytag: member="XPathCAPI.h::XalanDestroyXPath" ref="a9850a9f174cb79e89c944d2b01e0dcb8" args="(XalanXPathEvaluatorHandle theXalanHandle, XalanXPathHandle theXPathHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanDestroyXPath </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> </td> |
| <td class="paramname"> <em>theXPathHandle</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Destroys a compiled <a class="el" href="classXPath.html">XPath</a> instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of XalanXPathEvaluatorHandle instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathHandle</em> </td><td>The handle of <a class="el" href="classXPath.html">XPath</a> instance </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a184778386cf41b54a109a0ba3628bd99"></a><!-- doxytag: member="XPathCAPI.h::XalanDestroyXPathEvaluator" ref="a184778386cf41b54a109a0ba3628bd99" args="(XalanXPathEvaluatorHandle theXalanHandle)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanDestroyXPathEvaluator </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Destroy a XalanXPathEvaluator instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of the instance to destroy. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="abc0df2957dfd41348499edb70eb26100"></a><!-- doxytag: member="XPathCAPI.h::XalanEvaluateXPathAsBoolean" ref="abc0df2957dfd41348499edb70eb26100" args="(XalanXPathEvaluatorHandle theXalanHandle, XalanXPathHandle theXPathHandle, const char *theXML, int *theResult)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanEvaluateXPathAsBoolean </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a4835f5a9e2500951ef8778e3b7d3bab2">XalanXPathHandle</a> </td> |
| <td class="paramname"> <em>theXPathHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXML</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int * </td> |
| <td class="paramname"> <em>theResult</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Evaluates a compiled <a class="el" href="classXPath.html">XPath</a> instance. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of XalanXPathEvaluatorHandle instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathHandle</em> </td><td>The pointer to handle for instance </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXML</em> </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"></td><td valign="top"><em>theResult</em> </td><td>A pointer to an int to receive the result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a24ec6a07fd35de6b38103a0f57f16959"></a><!-- doxytag: member="XPathCAPI.h::XalanEvaluateXPathExpressionAsBoolean" ref="a24ec6a07fd35de6b38103a0f57f16959" args="(XalanXPathEvaluatorHandle theXalanHandle, const char *theXPathExpression, const char *theXPathExpressionEncoding, const char *theXML, int *theResult)" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanEvaluateXPathExpressionAsBoolean </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="XPathCAPI_8h.html#a8b059ea19f08cf507bf245d410a56a03">XalanXPathEvaluatorHandle</a> </td> |
| <td class="paramname"> <em>theXalanHandle</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXPathExpression</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXPathExpressionEncoding</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"> <em>theXML</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int * </td> |
| <td class="paramname"> <em>theResult</em></td><td> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td><td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Evaluates an <a class="el" href="classXPath.html">XPath</a> expression. </p> |
| <dl><dt><b>Parameters:</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"></td><td valign="top"><em>theXalanHandle</em> </td><td>The handle of XalanXPathEvaluatorHandle instance. </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathExpression</em> </td><td>The expression to evaluate </td></tr> |
| <tr><td valign="top"></td><td valign="top"><em>theXPathExpressionEncoding</em> </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"></td><td valign="top"><em>theXML</em> </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"></td><td valign="top"><em>theResult</em> </td><td>A pointer to an int to receive the result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad17c4b3687113265bc9821fe8105718c"></a><!-- doxytag: member="XPathCAPI.h::XalanXPathAPIInitialize" ref="ad17c4b3687113265bc9821fe8105718c" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanXPathAPIInitialize </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Initialize Xerces and the <a class="el" href="classXPath.html">XPath</a> API. </p> |
| <p>Should be called only once per process before making any other API calls.</p> |
| <dl class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8a7b053b0c494de5481800d3950f709b"></a><!-- doxytag: member="XPathCAPI.h::XalanXPathAPITerminate" ref="a8a7b053b0c494de5481800d3950f709b" args="()" --> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int XalanXPathAPITerminate </td> |
| <td>(</td> |
| <td class="paramname"></td> |
| <td> ) </td> |
| <td></td> |
| </tr> |
| </table> |
| </div> |
| <div class="memdoc"> |
| |
| <p>Terminate Xerces and the <a class="el" href="classXPath.html">XPath</a> API. </p> |
| <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 class="return"><dt><b>Returns:</b></dt><dd>0 for success, or a non-zero error code upon failure </dd></dl> |
| |
| </div> |
| </div> |
| </div> |
| <p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p> |
| <p><font color="#000000" face="arial,helvetica,sanserif" size="-1"> |
| <i><a href="http://www.doxygen.org/">Doxygen</a> and |
| <a href="http://www.graphviz.org/">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="80%"> |
| <tr> |
| <td width="80%" valign="top"> |
| <p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/> |
| Copyright © 1999-2012 The Apache Software Foundation.<br/> |
| All Rights Reserved.</p> |
| </td> |
| </tr> |
| <tr> |
| <td width="100%"> |
| <p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo"> |
| </td> |
| </tr> |
| </table> |
| </body> |
| </html> |
