blob: 98cb74a6ad8cec9cdf4993d3d2a56c0017a6c7fa [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>XalanCAPI.h</h1><a href="XalanCAPI_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_CAPI_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="XalanCAPI_8h.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define XALAN_CAPI_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019
00020
00021 <font class="preprocessor">#include &lt;<a class="code" href="XalanTransformerDefinitions_8hpp.html">xalanc/XalanTransformer/XalanTransformerDefinitions.hpp</a>&gt;</font>
00022
00023
00024
00035 <font class="preprocessor">#if defined(__cplusplus)</font>
00036 <font class="preprocessor"></font><font class="keyword">extern</font> <font class="stringliteral">"C"</font>
00037 {
00038 <font class="preprocessor">#endif</font>
00039 <font class="preprocessor"></font>
<a name="l00043"></a><a class="code" href="XalanCAPI_8h.html#a1">00043</a> <font class="keyword">typedef</font> <font class="keywordtype">void</font>* XalanHandle;
00044
<a name="l00048"></a><a class="code" href="XalanCAPI_8h.html#a2">00048</a> <font class="keyword">typedef</font> <font class="keyword">const</font> <font class="keywordtype">void</font>* XalanCSSHandle;
00049
<a name="l00053"></a><a class="code" href="XalanCAPI_8h.html#a3">00053</a> <font class="keyword">typedef</font> <font class="keyword">const</font> <font class="keywordtype">void</font>* XalanPSHandle;
00054
<a name="l00059"></a><a class="code" href="XalanCAPI_8h.html#a4">00059</a> <font class="keyword">typedef</font> <font class="keyword">const</font> <font class="keywordtype">char</font>* XalanCCharPtr;
00060
<a name="l00064"></a><a class="code" href="XalanCAPI_8h.html#a5">00064</a> <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">short</font> XalanUTF16Char;
00065
00074 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00075 <font class="preprocessor">#if defined(__cplusplus)</font>
00076 <font class="preprocessor"></font> XalanInitialize();
00077 <font class="preprocessor">#else</font>
00078 <font class="preprocessor"></font> XalanInitialize(<font class="keywordtype">void</font>);
00079 <font class="preprocessor">#endif</font>
00080 <font class="preprocessor"></font>
00102 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">void</font>)
00103 XalanTerminate(<font class="keywordtype">int</font> fCleanUpICU);
00104
00110 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(XalanHandle)
00111 CreateXalanTransformer();
00112
00113
00119 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">void</font>)
00120 DeleteXalanTransformer(XalanHandle theXalanHandle);
00121
00133 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00134 XalanTransformToFile(
00135 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXMLFileName,
00136 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXSLFileName,
00137 <font class="keyword">const</font> <font class="keywordtype">char</font>* theOutFileName,
00138 XalanHandle theXalanHandle);
00139
00151 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00152 XalanTransformToFilePrebuilt(
00153 XalanPSHandle theParsedSource,
00154 XalanCSSHandle theCSSHandle,
00155 <font class="keyword">const</font> <font class="keywordtype">char</font>* theOutFileName,
00156 XalanHandle theXalanHandle);
00157
00171 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00172 XalanTransformToData(
00173 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXMLFileName,
00174 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXSLFileName,
00175 <font class="keywordtype">char</font>** theOutput,
00176 XalanHandle theXalanHandle);
00177
00191 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00192 XalanTransformToDataPrebuilt(
00193 XalanPSHandle theParsedSource,
00194 XalanCSSHandle theCSSHandle,
00195 <font class="keywordtype">char</font>** theOutput,
00196 XalanHandle theXalanHandle);
00197
00204 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">void</font>)
00205 XalanFreeData(<font class="keywordtype">char</font>* theData);
00206
00227 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00228 XalanTransformToHandler(
00229 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXMLFileName,
00230 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXSLFileName,
00231 XalanHandle theXalanHandle,
00232 <font class="keywordtype">void</font>* theOutputHandle,
00233 XalanOutputHandlerType theOutputHandler,
00234 XalanFlushHandlerType theFlushHandler);
00235
00256 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00257 XalanTransformToHandlerPrebuilt(
00258 XalanPSHandle thePSHandle,
00259 XalanCSSHandle theCSSHandle,
00260 XalanHandle theXalanHandle,
00261 <font class="keywordtype">void</font>* theOutputHandle,
00262 XalanOutputHandlerType theOutputHandler,
00263 XalanFlushHandlerType theFlushHandler);
00264
00273 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00274 XalanCompileStylesheet(
00275 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXSLFileName,
00276 XalanHandle theXalanHandle,
00277 XalanCSSHandle* theCSSHandle);
00278
00288 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00289 XalanCompileStylesheetFromStream(
00290 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXSLStream,
00291 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> theXSLStreamLength,
00292 XalanHandle theXalanHandle,
00293 XalanCSSHandle* theCSSHandle);
00294
00302 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00303 XalanDestroyCompiledStylesheet(
00304 XalanCSSHandle theCSSHandle,
00305 XalanHandle theXalanHandle);
00306
00315 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00316 XalanParseSource(
00317 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXMLFileName,
00318 XalanHandle theXalanHandle,
00319 XalanPSHandle* thePSHandle);
00320
00330 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00331 XalanParseSourceFromStream(
00332 <font class="keyword">const</font> <font class="keywordtype">char</font>* theXMLStream,
00333 <font class="keywordtype">unsigned</font> <font class="keywordtype">long</font> theXMLStreamLength,
00334 XalanHandle theXalanHandle,
00335 XalanPSHandle* thePSHandle);
00336
00345 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">int</font>)
00346 XalanDestroyParsedSource(
00347 XalanPSHandle thePSHandle,
00348 XalanHandle theXalanHandle);
00349
00358 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">void</font>)
00359 XalanSetStylesheetParam(
00360 <font class="keyword">const</font> <font class="keywordtype">char</font>* key,
00361 <font class="keyword">const</font> <font class="keywordtype">char</font>* expression,
00362 XalanHandle theXalanHandle);
00363
00373 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(<font class="keywordtype">void</font>)
00374 XalanSetStylesheetParamUTF(
00375 <font class="keyword">const</font> XalanUTF16Char* key,
00376 <font class="keyword">const</font> XalanUTF16Char* expression,
00377 XalanHandle theXalanHandle);
00378
00389 <a class="code" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(XalanCCharPtr)
00390 XalanGetLastError(XalanHandle theXalanHandle);
00391
00392 <font class="preprocessor">#if defined(__cplusplus)</font>
00393 <font class="preprocessor"></font>}
00394 <font class="preprocessor">#endif</font>
00395 <font class="preprocessor"></font>
00396
00397
00398 <font class="preprocessor">#endif // XALAN_CAPI_HEADER_GUARD_1357924680</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>