Google Git
Sign in
apache / xalan-site / fc63e1a05362d8a54765634eed15aec345e1ef1d / . / content / old / xalan-c / apiDocs / XPathCAPI_8h-source.html
blob: 1518e77f3a11403244485c1a74b1925d931ef8ce [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</h1><a href="XPathCAPI_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(XALAN_XPATHCAPI_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XPathCAPI_8h.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATHCAPI_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019
00020
00021 <font class="preprocessor">#if defined(_MSC_VER)</font>
00022 <font class="preprocessor"></font>
00023 <font class="preprocessor">#if defined(XALAN_XPATHCAPI_BUILD_DLL)</font>
00024 <font class="preprocessor"></font>
00025 <font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT __declspec(dllexport)</font>
00026 <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllexport)</font>
00027 <font class="preprocessor"></font>
00028 <font class="preprocessor">#else</font>
00029 <font class="preprocessor"></font>
00030 <font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT __declspec(dllimport)</font>
00031 <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T __declspec(dllimport)</font>
00032 <font class="preprocessor"></font>
00033 <font class="preprocessor">#endif</font>
00034 <font class="preprocessor"></font>
00035 <font class="preprocessor">#else</font>
00036 <font class="preprocessor"></font>
<a name="l00037"></a><a class="code" href="XPathCAPI_8h.html#a1">00037</a> <font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT</font>
<a name="l00038"></a><a class="code" href="XPathCAPI_8h.html#a2">00038</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATHCAPI_EXPORT_FUNCTION(T) T</font>
00039 <font class="preprocessor"></font>
00040 <font class="preprocessor">#endif</font>
00041 <font class="preprocessor"></font>
00042
00043
00050 <font class="preprocessor">#if defined(__cplusplus)</font>
00051 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font>
00052 {
00053 <font class="preprocessor">#endif</font>
00054 <font class="preprocessor"></font>
<a name="l00055"></a><a class="code" href="XPathCAPI_8h.html#a3">00055</a> <font class="preprocessor">#define XALAN_XPATH_API_SUCCESS 0</font>
<a name="l00056"></a><a class="code" href="XPathCAPI_8h.html#a4">00056</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_ALREADY_INITIALIZED 1</font>
<a name="l00057"></a><a class="code" href="XPathCAPI_8h.html#a5">00057</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_ALREADY_TERMINATED 2</font>
<a name="l00058"></a><a class="code" href="XPathCAPI_8h.html#a6">00058</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_INITIALIZATION_FAILED 3</font>
<a name="l00059"></a><a class="code" href="XPathCAPI_8h.html#a7">00059</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_TERMINATION_FAILED 4</font>
<a name="l00060"></a><a class="code" href="XPathCAPI_8h.html#a8">00060</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_NOT_INITIALIZED 5</font>
<a name="l00061"></a><a class="code" href="XPathCAPI_8h.html#a9">00061</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_CANNOT_REINITIALIZE 6</font>
<a name="l00062"></a><a class="code" href="XPathCAPI_8h.html#a10">00062</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_INVALID_PARAMETER 7</font>
<a name="l00063"></a><a class="code" href="XPathCAPI_8h.html#a11">00063</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_INVALID_EXPRESSION 8</font>
<a name="l00064"></a><a class="code" href="XPathCAPI_8h.html#a12">00064</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_BAD_XML 9</font>
<a name="l00065"></a><a class="code" href="XPathCAPI_8h.html#a13">00065</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_UNSUPPORTED_ENCODING 10</font>
<a name="l00066"></a><a class="code" href="XPathCAPI_8h.html#a14">00066</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_TRANSCODING 11</font>
<a name="l00067"></a><a class="code" href="XPathCAPI_8h.html#a15">00067</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_INVALID_XPATH 12</font>
<a name="l00068"></a><a class="code" href="XPathCAPI_8h.html#a16">00068</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_XPATH_API_ERROR_UNKNOWN 13</font>
00069 <font class="preprocessor"></font>
00070
<a name="l00074"></a><a class="code" href="XPathCAPI_8h.html#a17">00074</a> <font class="keyword">typedef</font> <font class="keywordtype">void</font>* XalanXPathEvaluatorHandle;
00075
<a name="l00079"></a><a class="code" href="XPathCAPI_8h.html#a18">00079</a> <font class="keyword">typedef</font> <font class="keywordtype">void</font>* XalanXPathHandle;
00080
00081
00082 <font class="preprocessor">#if defined(OS390)</font>
00083 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanXPathAPIInitialize)</font>
00084 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanXPathAPITerminate)</font>
00085 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanCreateXPathEvaluator)</font>
00086 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanDestroyXPathEvaluator)</font>
00087 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanCreateXPath)</font>
00088 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanDestroyXPath)</font>
00089 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanEvaluateXPathAsBoolean)</font>
00090 <font class="preprocessor"></font><font class="preprocessor">#pragma export(XalanEvaluateXPathExpressionAsBoolean)</font>
00091 <font class="preprocessor"></font><font class="preprocessor">#endif</font>
00092 <font class="preprocessor"></font>
00101 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00102 <a class="code" href="XPathCAPI_8h.html#a19">XalanXPathAPIInitialize</a>();
00103
00114 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00115 <a class="code" href="XPathCAPI_8h.html#a20">XalanXPathAPITerminate</a>();
00116
00123 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00124 <a class="code" href="XPathCAPI_8h.html#a21">XalanCreateXPathEvaluator</a>(XalanXPathEvaluatorHandle* theHandle);
00125
00132 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00133 <a class="code" href="XPathCAPI_8h.html#a22">XalanDestroyXPathEvaluator</a>(XalanXPathEvaluatorHandle theXalanHandle);
00134
00144 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00145 <a class="code" href="XPathCAPI_8h.html#a23">XalanCreateXPath</a>(
00146 XalanXPathEvaluatorHandle theXalanHandle,
00147 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXPathExpression,
00148 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXPathExpressionEncoding,
00149 XalanXPathHandle* theXPathHandle);
00150
00158 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00159 <a class="code" href="XPathCAPI_8h.html#a24">XalanDestroyXPath</a>(
00160 XalanXPathEvaluatorHandle theXalanHandle,
00161 XalanXPathHandle theXPathHandle);
00162
00172 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00173 <a class="code" href="XPathCAPI_8h.html#a25">XalanEvaluateXPathAsBoolean</a>(
00174 XalanXPathEvaluatorHandle theXalanHandle,
00175 XalanXPathHandle theXPathHandle,
00176 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXML,
00177 <font class="keywordtype">int</font>* theResult);
00178
00189 <a class="code" href="XPathCAPI_8h.html#a2">XALAN_XPATHCAPI_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00190 <a class="code" href="XPathCAPI_8h.html#a26">XalanEvaluateXPathExpressionAsBoolean</a>(
00191 XalanXPathEvaluatorHandle theXalanHandle,
00192 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXPathExpression,
00193 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXPathExpressionEncoding,
00194 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXML,
00195 <font class="keywordtype">int</font>* theResult);
00196
00197 <font class="preprocessor">#if defined(__cplusplus)</font>
00198 <font class="preprocessor"></font>}
00199 <font class="preprocessor">#endif</font>
00200 <font class="preprocessor"></font>
00201
00202
00203 <font class="preprocessor">#endif</font>
</font></pre></div><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>