| <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> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> |
| <hr><h1>XalanCAPI.h File Reference</h1> |
| <p> |
| Include dependency graph for XalanCAPI.h:<p><center><img src="XalanCAPI_8h__incl.gif" border="0" usemap="#XalanCAPI.h_map" alt="Include dependency graph"></center> |
| <map name="XalanCAPI.h_map"> |
| <area href="XalanTransformerDefinitions_8hpp.html" shape="rect" coords="33,192,390,168"> |
| <area href="PlatformDefinitions_8hpp.html" shape="rect" coords="7,117,244,93"> |
| <area href="XalanVersion_8hpp.html" shape="rect" coords="65,43,185,19"> |
| </map> |
| |
| <p> |
| <a href="XalanCAPI_8h-source.html">Go to the source code of this file.</a><h2>Defines</h2> |
| <ul> |
| <li>#define <a class="el" href="XalanCAPI_8h.html#a0">XALAN_CAPI_HEADER_GUARD_1357924680</a> |
| </ul> |
| <h2>Typedefs</h2> |
| <ul> |
| <li>typedef void* <a class="el" href="XalanCAPI_8h.html#a1">XalanHandle</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="#a1">More...</a><em><br><br></em></font></dl><li>typedef const void* <a class="el" href="XalanCAPI_8h.html#a2">XalanCSSHandle</a> |
| <dl class="el"><dd><font size=-1><em>Handle used to store the address of Compiled Stylesheet instance.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li>typedef const void* <a class="el" href="XalanCAPI_8h.html#a3">XalanPSHandle</a> |
| <dl class="el"><dd><font size=-1><em>Handle used to store the address of Parsed Source instance.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>typedef const char* <a class="el" href="XalanCAPI_8h.html#a4">XalanCCharPtr</a> |
| <dl class="el"><dd><font size=-1><em>This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>typedef unsigned short <a class="el" href="XalanCAPI_8h.html#a5">XalanUTF16Char</a> |
| <dl class="el"><dd><font size=-1><em>This is a typedef for characters encoded in UTF-16.</em> <a href="#a5">More...</a><em><br><br></em></font></dl></ul> |
| <h2>Functions</h2> |
| <ul> |
| <li><a class="el" href="XalanCAPI_8h.html#a6">XALAN_TRANSFORMER_EXPORT_FUNCTION</a> (int) XalanInitialize(void) |
| <dl class="el"><dd><font size=-1><em>Initialize Xerces and Xalan.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanCAPI_8h.html#a7">XALAN_TRANSFORMER_EXPORT_FUNCTION</a> (void) XalanTerminate(int fCleanUpICU) |
| <dl class="el"><dd><font size=-1><em>Terminate Xalan and Xerces.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanCAPI_8h.html#a8">XALAN_TRANSFORMER_EXPORT_FUNCTION</a> (<a class="el" href="XalanCAPI_8h.html#a1">XalanHandle</a>) CreateXalanTransformer() |
| <dl class="el"><dd><font size=-1><em>Create a <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanCAPI_8h.html#a9">XALAN_TRANSFORMER_EXPORT_FUNCTION</a> (int) XalanTransformToFile(const char *theXMLFileName, const char *theXSLFileName, const char *theOutFileName, <a class="el" href="XalanCAPI_8h.html#a1">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd><font size=-1><em>Transform the XML source tree to the given result file.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li><a class="el" href="XalanCAPI_8h.html#a10">XALAN_TRANSFORMER_EXPORT_FUNCTION</a> (void) XalanSetStylesheetParam(const char *key, const char *expression, <a class="el" href="XalanCAPI_8h.html#a1">XalanHandle</a> theXalanHandle) |
| <dl class="el"><dd><font size=-1><em>Set a top-level stylesheet parameter.</em> <a href="#a10">More...</a><em><br><br></em></font></dl></ul> |
| <hr><h2>Define Documentation</h2> |
| <a name="a0" doxytag="XalanCAPI.h::XALAN_CAPI_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_CAPI_HEADER_GUARD_1357924680 |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| <b>Value:</b><div class="fragment"><pre> |
| </pre></div> </td> |
| </tr> |
| </table> |
| <hr><h2>Typedef Documentation</h2> |
| <a name="a4" doxytag="XalanCAPI.h::XalanCCharPtr"></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 const char * XalanCCharPtr |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This is a typedef to work around limitations with the XALAN_TRANSFORMER_EXPORT_FUNCTION macro. |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="a2" doxytag="XalanCAPI.h::XalanCSSHandle"></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 const void * XalanCSSHandle |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Handle used to store the address of Compiled Stylesheet instance. |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="a1" doxytag="XalanCAPI.h::XalanHandle"></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 * XalanHandle |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </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="a3" doxytag="XalanCAPI.h::XalanPSHandle"></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 const void * XalanPSHandle |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Handle used to store the address of Parsed Source instance. |
| <p> |
| </td> |
| </tr> |
| </table> |
| <a name="a5" doxytag="XalanCAPI.h::XalanUTF16Char"></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 unsigned short XalanUTF16Char |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This is a typedef for characters encoded in UTF-16. |
| <p> |
| </td> |
| </tr> |
| </table> |
| <hr><h2>Function Documentation</h2> |
| <a name="a10" doxytag="XalanCAPI.h::XALAN_TRANSFORMER_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> |
| XALAN_TRANSFORMER_EXPORT_FUNCTION ( |
| </b></td> |
| <td valign="bottom"><b> |
| void ) const |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Set a top-level stylesheet parameter. |
| <p> |
| This value can be evaluated via xsl:param-variable.<dl compact><dt> |
| <b>Parameters: </b><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>key</em> |
| </td><td> |
| name of the param </td></tr> |
| <tr><td valign=top><em>expression</em> |
| </td><td> |
| expression that will be evaluated </td></tr> |
| <tr><td valign=top><em>theXalanHandle</em> |
| </td><td> |
| handle of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dl> </td> |
| </tr> |
| </table> |
| <a name="a9" doxytag="XalanCAPI.h::XALAN_TRANSFORMER_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> |
| XALAN_TRANSFORMER_EXPORT_FUNCTION ( |
| </b></td> |
| <td valign="bottom"><b> |
| int ) const |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Transform the XML source tree to the given result file. |
| <p> |
| The processor will apply the stylesheet file to the input file and write the transformation result to a new output file.<dl compact><dt> |
| <b>Parameters: </b><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>theXMLFileName</em> |
| </td><td> |
| filename of XML input source </td></tr> |
| <tr><td valign=top><em>theXSLFileName</em> |
| </td><td> |
| filename of stylesheet source </td></tr> |
| <tr><td valign=top><em>theOutFileName</em> |
| </td><td> |
| filename of output source </td></tr> |
| <tr><td valign=top><em>theXalanHandle</em> |
| </td><td> |
| handle of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance. </td></tr> |
| </table> |
| </dl><dl compact><dt> |
| <b>Returns: </b><dd> |
| 0 for success </dl> </td> |
| </tr> |
| </table> |
| <a name="a8" doxytag="XalanCAPI.h::XALAN_TRANSFORMER_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> |
| XALAN_TRANSFORMER_EXPORT_FUNCTION ( |
| </b></td> |
| <td valign="bottom"><b> |
| <a class="el" href="XalanCAPI_8h.html#a1">XalanHandle</a> ) |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Create a <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance. |
| <p> |
| <dl compact><dt> |
| <b>Returns: </b><dd> |
| the <a class="el" href="classXalanTransformer.html">XalanTransformer</a> handle </dl> </td> |
| </tr> |
| </table> |
| <a name="a7" doxytag="XalanCAPI.h::XALAN_TRANSFORMER_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> |
| XALAN_TRANSFORMER_EXPORT_FUNCTION ( |
| </b></td> |
| <td valign="bottom"><b> |
| void ) |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Terminate Xalan and Xerces. |
| <p> |
| Should be called only once per process after deleting all instances of <a class="el" href="classXalanTransformer.html">XalanTransformer</a>. |
| <p> |
| Once a process has called this function, it cannot use the API until another call to XalanInitialize has been made. |
| <p> |
| Optionally, if the ICU has been integrated, this will call the ICU clean up function. This must only be done if the ICU will no longer be used by the process, since the ICU will no longer be in a usable state. See the ICU documentation for more details. |
| <p> |
| This is handy when using leak-detection software, as all static data allocated by Xalan (and optionally, the ICU) will be freed.<dl compact><dt> |
| <b>Parameters: </b><dd> |
| <table border=0 cellspacing=2 cellpadding=0> |
| <tr><td valign=top><em>fCleanUpICU</em> |
| </td><td> |
| If true, call the ICU clean up function. </td></tr> |
| </table> |
| </dl> </td> |
| </tr> |
| </table> |
| <a name="a6" doxytag="XalanCAPI.h::XALAN_TRANSFORMER_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> |
| XALAN_TRANSFORMER_EXPORT_FUNCTION ( |
| </b></td> |
| <td valign="bottom"><b> |
| int ) |
| </b></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Initialize Xerces and Xalan. |
| <p> |
| Should be called only once per process before making any other API calls. |
| <p> |
| <dl compact><dt> |
| <b>Returns: </b><dd> |
| 0 if successful, -1 if initialization fails. </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 © 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>
|
