blob: 015ebf8384cefe7e430af7acb9182940b825c784 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>XalanFStreamOutputStream Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XalanFStreamOutputStream" --><!-- doxytag: inherits="XalanOutputStream" -->
<p><code>#include &lt;<a class="el" href="XalanFStreamOutputStream_8hpp_source.html">XalanFStreamOutputStream.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classXalanOutputStream.html">XalanOutputStream</a>.</p>
<div class="dynheader">
Collaboration diagram for XalanFStreamOutputStream:</div>
<div class="dyncontent">
<div class="center"><img src="classXalanFStreamOutputStream__coll__graph.png" border="0" usemap="#XalanFStreamOutputStream_coll__map" alt="Collaboration graph"/></div>
<map name="XalanFStreamOutputStream_coll__map" id="XalanFStreamOutputStream_coll__map">
<area shape="rect" id="node2" href="classXalanOutputStream.html" title="XalanOutputStream" alt="" coords="689,87,839,116"/><area shape="rect" id="node4" href="classXalanVector.html" title="XalanVector\&lt; char \&gt;" alt="" coords="341,5,499,35"/><area shape="rect" id="node6" href="classXalanOutputTranscoder.html" title="XalanOutputTranscoder" alt="" coords="333,59,507,88"/><area shape="rect" id="node8" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="356,177,484,207"/><area shape="rect" id="node10" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,140,233,169"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXalanFStreamOutputStream-members.html">List of all members.</a></p>
<h2><a name="nested-classes"></a>
Classes</h2>
<ul>
<li>class <a class="el" href="classXalanFStreamOutputStream_1_1XalanFStreamOutputStreamWriteException.html">XalanFStreamOutputStreamWriteException</a>
</ul>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>enum { <a class="el" href="classXalanFStreamOutputStream.html#aca92129ff6ef6237e5d04a58c8b99393aec9925b962470a7a74a823ec9ab3e546">eDefaultBufferSize</a> = 8192u
}
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXalanFStreamOutputStream.html#a9164732937886d3a5e0ca2ae08650896">XalanFStreamOutputStream</a> (FILE *theFileHandle, MemoryManager &amp;theManager, <a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferSize=eDefaultBufferSize)
<dl class="el"><dd class="mdescRight">Construct a <a class="el" href="classXalanFStreamOutputStream.html">XalanFStreamOutputStream</a> object. <a href="#a9164732937886d3a5e0ca2ae08650896"></a><br/></dl><li>virtual <a class="el" href="classXalanFStreamOutputStream.html#a501ef04f7276e8f6130bb49dd435790c">~XalanFStreamOutputStream</a> ()
</ul>
<h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classXalanFStreamOutputStream.html">XalanFStreamOutputStream</a> * <a class="el" href="classXalanFStreamOutputStream.html#a64614cd3584ce826acb7eadf3c18b0fd">create</a> (FILE *theFileHandle, MemoryManager &amp;theManager, <a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferSize=eDefaultBufferSize)
</ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual void <a class="el" href="classXalanFStreamOutputStream.html#a11bab1aa47aaac4e20eaf4d41a28ab9b">writeData</a> (const char *theBuffer, <a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a> theBufferLength)
<dl class="el"><dd class="mdescRight">Write the data in the buffer. <a href="#a11bab1aa47aaac4e20eaf4d41a28ab9b"></a><br/></dl><li>virtual void <a class="el" href="classXalanFStreamOutputStream.html#a4b441c443e3f303371b61a930f86e7c6">doFlush</a> ()
<dl class="el"><dd class="mdescRight">Flush the stream. <a href="#a4b441c443e3f303371b61a930f86e7c6"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XalanFStreamOutputStream_8hpp_source.html#l00043">43</a> of file <a class="el" href="XalanFStreamOutputStream_8hpp_source.html">XalanFStreamOutputStream.hpp</a>.</p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aca92129ff6ef6237e5d04a58c8b99393"></a><!-- doxytag: member="XalanFStreamOutputStream::@30" ref="aca92129ff6ef6237e5d04a58c8b99393" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aca92129ff6ef6237e5d04a58c8b99393aec9925b962470a7a74a823ec9ab3e546"></a><!-- doxytag: member="eDefaultBufferSize" ref="aca92129ff6ef6237e5d04a58c8b99393aec9925b962470a7a74a823ec9ab3e546" args="" -->eDefaultBufferSize</em>&nbsp;</td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="XalanFStreamOutputStream_8hpp_source.html#l00047">47</a> of file <a class="el" href="XalanFStreamOutputStream_8hpp_source.html">XalanFStreamOutputStream.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9164732937886d3a5e0ca2ae08650896"></a><!-- doxytag: member="XalanFStreamOutputStream::XalanFStreamOutputStream" ref="a9164732937886d3a5e0ca2ae08650896" args="(FILE *theFileHandle, MemoryManager &amp;theManager, size_type theBufferSize=eDefaultBufferSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanFStreamOutputStream::XalanFStreamOutputStream </td>
<td>(</td>
<td class="paramtype">FILE *&nbsp;</td>
<td class="paramname"> <em>theFileHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theBufferSize</em> = <code>eDefaultBufferSize</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classXalanFStreamOutputStream.html">XalanFStreamOutputStream</a> object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theHandle</em>&nbsp;</td><td>handle of file. Must not be null. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theBufferSize</em>&nbsp;</td><td>The size of the transcoding buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a501ef04f7276e8f6130bb49dd435790c"></a><!-- doxytag: member="XalanFStreamOutputStream::~XalanFStreamOutputStream" ref="a501ef04f7276e8f6130bb49dd435790c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XalanFStreamOutputStream::~XalanFStreamOutputStream </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a64614cd3584ce826acb7eadf3c18b0fd"></a><!-- doxytag: member="XalanFStreamOutputStream::create" ref="a64614cd3584ce826acb7eadf3c18b0fd" args="(FILE *theFileHandle, MemoryManager &amp;theManager, size_type theBufferSize=eDefaultBufferSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXalanFStreamOutputStream.html">XalanFStreamOutputStream</a>* XalanFStreamOutputStream::create </td>
<td>(</td>
<td class="paramtype">FILE *&nbsp;</td>
<td class="paramname"> <em>theFileHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theBufferSize</em> = <code>eDefaultBufferSize</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a4b441c443e3f303371b61a930f86e7c6"></a><!-- doxytag: member="XalanFStreamOutputStream::doFlush" ref="a4b441c443e3f303371b61a930f86e7c6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XalanFStreamOutputStream::doFlush </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flush the stream. </p>
<p>Implements <a class="el" href="classXalanOutputStream.html#af877c1e7589acbd180dbb112dc1512d1">XalanOutputStream</a>.</p>
</div>
</div>
<a class="anchor" id="a11bab1aa47aaac4e20eaf4d41a28ab9b"></a><!-- doxytag: member="XalanFStreamOutputStream::writeData" ref="a11bab1aa47aaac4e20eaf4d41a28ab9b" args="(const char *theBuffer, size_type theBufferLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XalanFStreamOutputStream::writeData </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>theBuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXalanOutputStream.html#a6313c6fbbdc5fd6bcf3040d4f596cf71">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theBufferLength</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write the data in the buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theBuffer</em>&nbsp;</td><td>The data to write </td></tr>
<tr><td valign="top"></td><td valign="top"><em>theBufferLength</em>&nbsp;</td><td>The length of theBuffer. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classXalanOutputStream.html#afd3ee66f24a4a20803546ffcd7092304">XalanOutputStream</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanFStreamOutputStream_8hpp_source.html">XalanFStreamOutputStream.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>