Google Git
Sign in
apache / xalan-site / 4279effacee2ebacf30f00b46c22db2aacb59b72 / . / old / xalan-c / apiDocs / classXalanFileOutputStream.html
blob: 8bd16d6a9a02878606ea2caef1128a9996a923f1 [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>XalanFileOutputStream Class Reference</h1><code>#include &lt;<a class="el" href="XalanFileOutputStream_8hpp-source.html">XalanFileOutputStream.hpp</a>&gt;</code>
<p>
Inheritance diagram for XalanFileOutputStream:<p><center><img src="classXalanFileOutputStream__inherit__graph.gif" border="0" usemap="#XalanFileOutputStream_inherit_map" alt="Inheritance graph"></center>
<map name="XalanFileOutputStream_inherit_map">
<area href="classXalanOutputStream.html" shape="rect" coords="17,42,150,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XalanFileOutputStream:<p><center><img src="classXalanFileOutputStream__coll__graph.gif" border="0" usemap="#XalanFileOutputStream_coll_map" alt="Collaboration graph"></center>
<map name="XalanFileOutputStream_coll_map">
<area href="classXalanOutputStream.html" shape="rect" coords="148,133,281,109">
<area href="classXalanDOMString.html" shape="rect" coords="6,43,124,19">
<area href="classXalanOutputTranscoder.html" shape="rect" coords="156,43,313,19">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXalanFileOutputStream-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef FILE* <a class="el" href="classXalanFileOutputStream.html#s0">HandleType</a>
<li>enum { <a class="el" href="classXalanFileOutputStream.html#s2s1">eDefaultBufferSize</a> = 8192
}
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXalanFileOutputStream.html#a0">XalanFileOutputStream</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theFileName, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, unsigned int theBufferSize=eDefaultBufferSize)
<dl class="el"><dd><font size=-1><em>Construct an XalanFileOutputStream object.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanFileOutputStream.html#a1">~XalanFileOutputStream</a> ()
</ul>
<h2>Static Public Methods</h2>
<ul>
<li>XalanFileOutputStream* <a class="el" href="classXalanFileOutputStream.html#d0">create</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theFileName, <a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, unsigned int theBufferSize=eDefaultBufferSize)
</ul>
<h2>Protected Methods</h2>
<ul>
<li>virtual void <a class="el" href="classXalanFileOutputStream.html#b0">writeData</a> (const char *theBuffer, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferLength)
<dl class="el"><dd><font size=-1><em>Write the data in the buffer.</em> <a href="#b0">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXalanFileOutputStream.html#b1">doFlush</a> ()
<dl class="el"><dd><font size=-1><em>Flush the stream.</em> <a href="#b1">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XalanFileOutputStream::HandleType"></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 FILE * XalanFileOutputStream::HandleType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s2" doxytag="XalanFileOutputStream::@12"></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>
anonymous enum
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s2s1" doxytag="eDefaultBufferSize"></a><em>eDefaultBufferSize</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XalanFileOutputStream::XalanFileOutputStream"></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>
XalanFileOutputStream::XalanFileOutputStream (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theFileName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned int <em>theBufferSize</em> = eDefaultBufferSize&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Construct an XalanFileOutputStream object.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theFileName</em>
&nbsp;</td><td>
name of file </td></tr>
<tr><td valign=top><em>theBufferSize</em>
&nbsp;</td><td>
The size of the transcoding buffer </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="XalanFileOutputStream::~XalanFileOutputStream"></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>
XalanFileOutputStream::~XalanFileOutputStream (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d0" doxytag="XalanFileOutputStream::create"></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>
XalanFileOutputStream * XalanFileOutputStream::create (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theFileName</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
unsigned int <em>theBufferSize</em> = eDefaultBufferSize&nbsp;)<code> [static]</code>
</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="b1" doxytag="XalanFileOutputStream::doFlush"></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>
void XalanFileOutputStream::doFlush (
</b></td>
<td valign="bottom"><b>
)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the stream.
<p>
<p>
Reimplemented from <a class="el" href="classXalanOutputStream.html#b2">XalanOutputStream</a>. </td>
</tr>
</table>
<a name="b0" doxytag="XalanFileOutputStream::writeData"></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>
void XalanFileOutputStream::writeData (
</b></td>
<td valign="bottom"><b>
const char * <em>theBuffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferLength</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write the data in the buffer.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
The data to write </td></tr>
<tr><td valign=top><em>theBufferLength</em>
&nbsp;</td><td>
The length of theBuffer. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classXalanOutputStream.html#b1">XalanOutputStream</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanFileOutputStream_8hpp-source.html">XalanFileOutputStream.hpp</a></ul>
<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>