Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / XalanTransformerDefinitions_8hpp.html
blob: 7eec7ed2a195cea487d5b78791f1eeb71ab44740 [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>XalanTransformerDefinitions.hpp File Reference</h1>
<p>
Include dependency graph for XalanTransformerDefinitions.hpp:<p><center><img src="XalanTransformerDefinitions_8hpp__incl.gif" border="0" usemap="#XalanTransformerDefinitions.hpp_map" alt="Include dependency graph"></center>
<map name="XalanTransformerDefinitions.hpp_map">
<area href="PlatformDefinitions_8hpp.html" shape="rect" coords="6,117,244,93">
<area href="XalanVersion_8hpp.html" shape="rect" coords="65,42,185,18">
</map>
<p>
This graph shows which files directly or indirectly include this file:<p><center><img src="XalanTransformerDefinitions_8hpp__dep__incl.gif" border="0" usemap="#XalanTransformerDefinitions.hppdep_map" alt="Included by dependency graph"></center>
<map name="XalanTransformerDefinitions.hppdep_map">
<area href="XalanCAPI_8h.html" shape="rect" coords="686,30,779,6">
<area href="XalanCompiledStylesheet_8hpp.html" shape="rect" coords="637,129,829,105">
<area href="XalanCompiledStylesheetDefault_8hpp.html" shape="rect" coords="306,105,538,81">
<area href="XalanDefaultDocumentBuilder_8hpp.html" shape="rect" coords="17,204,233,180">
<area href="XalanDocumentBuilder_8hpp.html" shape="rect" coords="334,229,510,205">
<area href="XalanDefaultParsedSource_8hpp.html" shape="rect" coords="322,293,522,269">
<area href="XalanParsedSource_8hpp.html" shape="rect" coords="653,379,813,355">
<area href="XalanSourceTreeWrapperParsedSource_8hpp.html" shape="rect" coords="282,366,562,342">
<area href="XercesDOMParsedSource_8hpp.html" shape="rect" coords="322,429,522,405">
<area href="XercesDOMWrapperParsedSource_8hpp.html" shape="rect" coords="297,478,548,454">
<area href="XalanTransformer_8hpp.html" shape="rect" coords="658,529,807,505">
<area href="XalanTransformerOutputStream_8hpp.html" shape="rect" coords="618,577,847,553">
<area href="XalanTransformerProblemListener_8hpp.html" shape="rect" coords="613,625,853,601">
</map>
<p>
<a href="XalanTransformerDefinitions_8hpp-source.html">Go to the source code of this file.</a><h2>Defines</h2>
<ul>
<li>#define <a class="el" href="XalanTransformerDefinitions_8hpp.html#a0">XALAN_TRANSFORMER_DEFINITIONS_HEADER_GUARD_1357924680</a>
<li>#define <a class="el" href="XalanTransformerDefinitions_8hpp.html#a1">XALAN_TRANSFORMER_EXPORT</a>&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT
<li>#define <a class="el" href="XalanTransformerDefinitions_8hpp.html#a2">XALAN_TRANSFORMER_EXPORT_FUNCTION</a>(T)&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT_FUNCTION(T)
</ul>
<h2>Typedefs</h2>
<ul>
<li>typedef size_t <a class="el" href="XalanTransformerDefinitions_8hpp.html#a3">CallbackSizeType</a>
<li>typedef <a class="el" href="XalanTransformerDefinitions_8hpp.html#a3">CallbackSizeType</a> (* <a class="el" href="XalanTransformerDefinitions_8hpp.html#a4">XalanOutputHandlerType</a> )(const char *, <a class="el" href="XalanTransformerDefinitions_8hpp.html#a3">CallbackSizeType</a>, void *)
<dl class="el"><dd><font size=-1><em>Callback function passed to the <a class="el" href="classXalanTransformer.html">XalanTransformer</a> APIs.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>typedef void (* <a class="el" href="XalanTransformerDefinitions_8hpp.html#a5">XalanFlushHandlerType</a> )(void *)
<dl class="el"><dd><font size=-1><em>Callback function passed to the <a class="el" href="classXalanTransformer.html">XalanTransformer</a> APIs.</em> <a href="#a5">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Define Documentation</h2>
<a name="a0" doxytag="XalanTransformerDefinitions.hpp::XALAN_TRANSFORMER_DEFINITIONS_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_TRANSFORMER_DEFINITIONS_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="a1" doxytag="XalanTransformerDefinitions.hpp::XALAN_TRANSFORMER_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_TRANSFORMER_EXPORT&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="XalanTransformerDefinitions.hpp::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>
#define XALAN_TRANSFORMER_EXPORT_FUNCTION(
</b></td>
<td valign="bottom"><b>
T&nbsp;)&nbsp;&nbsp;&nbsp;XALAN_PLATFORM_IMPORT_FUNCTION(T)
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a name="a3" doxytag="XalanTransformerDefinitions.hpp::CallbackSizeType"></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 size_t CallbackSizeType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="XalanTransformerDefinitions.hpp::XalanFlushHandlerType"></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(* XalanFlushHandlerType)(void *)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Callback function passed to the <a class="el" href="classXalanTransformer.html">XalanTransformer</a> APIs.
<p>
Used to flush the buffer once transform is completed.
<p>
static void xalanFlushHandler(const void *handle);<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>handle</em>
&nbsp;</td><td>
handle of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="XalanTransformerDefinitions.hpp::XalanOutputHandlerType"></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 <a class="el" href="XalanTransformerDefinitions_8hpp.html#a3">CallbackSizeType</a>(* XalanOutputHandlerType)(const char *, <a class="el" href="XalanTransformerDefinitions_8hpp.html#a3">CallbackSizeType</a>, void *)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Callback function passed to the <a class="el" href="classXalanTransformer.html">XalanTransformer</a> APIs.
<p>
Used to process transformation output in blocks of data. Caller is responsible for streaming or copying data to a user allocated buffer. Caller should not attempt to write to or free this data.
<p>
The callback should return the number of bytes written, and this number should match the length received. Otherwise the XalanTransformToHandler function terminates and returns an error status.
<p>
static unsigned long xalanOutputHandler(const void* data, unsigned long length, const void *handle);<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>data</em>
&nbsp;</td><td>
a block of data </td></tr>
<tr><td valign=top><em>length</em>
&nbsp;</td><td>
length of block </td></tr>
<tr><td valign=top><em>handle</em>
&nbsp;</td><td>
handle of <a class="el" href="classXalanTransformer.html">XalanTransformer</a> instance. </td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
number of bytes written </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>