<!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>Apache log4cxx: FileAppender Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1_file_appender.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>FileAppender Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::FileAppender" --><!-- doxytag: inherits="log4cxx::WriterAppender" -->
<p><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> appends log events to a file.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_writer_appender.html">log4cxx::WriterAppender</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html">RollingFileAppenderSkeleton</a>.</p>
<p><a href="classlog4cxx_1_1_file_appender-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a3d8fe210d6211cccc14aa2363753cffd">FileAppender</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor does not do anything. <a href="#a3d8fe210d6211cccc14aa2363753cffd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#acc7b3781f413f9be2a19980f3ceb4bf4">FileAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename, bool append, bool <a class="el" href="classlog4cxx_1_1_file_appender.html#a0b145f10827466b4822646865ce9f8fe">bufferedIO</a>, int <a class="el" href="classlog4cxx_1_1_file_appender.html#a8556d19b129aa550f5b2819ed0320e83">bufferSize</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <code><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a></code> and open the file designated by <code>filename</code>. <a href="#acc7b3781f413f9be2a19980f3ceb4bf4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a4a4d542375d6f4d71c9859208167d99b">FileAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename, bool append)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> and open the file designated by <code>filename</code>. <a href="#a4a4d542375d6f4d71c9859208167d99b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a80646ffb11365b0e9a8a7bdc0b3c5160">FileAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#af1f4e6a2229d95a18324c4e7fa71be65">layout</a>, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiate a <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> and open the file designated by <code>filename</code>. <a href="#a80646ffb11365b0e9a8a7bdc0b3c5160"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a82f3f9274e8fe0280b7f88ceb62f0a04">~FileAppender</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930">setFile</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &file)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></b> property takes a string value which should be the name of the file to append to. <a href="#a6a6c98222ccf2072dad5a434f9336930"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#aa4a716f4661cf85cdfde59b447654358">setFile</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &file, bool append, bool <a class="el" href="classlog4cxx_1_1_file_appender.html#a0b145f10827466b4822646865ce9f8fe">bufferedIO</a>, size_t <a class="el" href="classlog4cxx_1_1_file_appender.html#a8556d19b129aa550f5b2819ed0320e83">bufferSize</a>, <a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets and <em>opens</em> the file where the log output will go. <a href="#aa4a716f4661cf85cdfde59b447654358"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#af8cb171146140874fb651ca95e142805">getAppend</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b>Append</b> option. <a href="#af8cb171146140874fb651ca95e142805"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#afdf1897af9ae5c70308224d3a7d8f339">getFile</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the <b><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></b> option. <a href="#afdf1897af9ae5c70308224d3a7d8f339"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#ac1d269357907e0809687a2bec962e1c8">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#ac1d269357907e0809687a2bec962e1c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#ae251083c7609154002d8f798e6ffce17">getBufferedIO</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the <b>BufferedIO</b> option. <a href="#ae251083c7609154002d8f798e6ffce17"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a5f0ab7189f063f69cdd39cbf74d5aaf5">getBufferSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the IO buffer. <a href="#a5f0ab7189f063f69cdd39cbf74d5aaf5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a78ebca211ceb3a0b2960a48092089906">setAppend</a> (bool fileAppend1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>Append</b> option takes a boolean value. <a href="#a78ebca211ceb3a0b2960a48092089906"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a5e4b35c8c3fd337b6c9e3c4aea0ceede">setBufferedIO</a> (bool <a class="el" href="classlog4cxx_1_1_file_appender.html#a0b145f10827466b4822646865ce9f8fe">bufferedIO</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The <b>BufferedIO</b> option takes a boolean value. <a href="#a5e4b35c8c3fd337b6c9e3c4aea0ceede"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a6426a0a69cabf98da63f87a4849dffae">setBufferSize</a> (int bufferSize1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of the IO buffer. <a href="#a6426a0a69cabf98da63f87a4849dffae"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#ac5fea9e45f5a70c22c6d2d71b0666913">stripDuplicateBackslashes</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &<a class="el" href="classlog4cxx_1_1_appender_skeleton.html#a9de136310b76f5d0aa8b40848216b167">name</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces double backslashes with single backslashes for compatibility with paths from earlier XML configurations files. <a href="#ac5fea9e45f5a70c22c6d2d71b0666913"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#aa4cb3c72f0db3854c371ec3d12fb1132">fileAppend</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append to or truncate the file? The default value for this variable is <code>true</code>, meaning that by default a <code><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a></code> will append to an existing file and not truncate it. <a href="#aa4cb3c72f0db3854c371ec3d12fb1132"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a017826792cfaa215e4ae83bb3aef2681">fileName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the log file. <a href="#a017826792cfaa215e4ae83bb3aef2681"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a0b145f10827466b4822646865ce9f8fe">bufferedIO</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do we do bufferedIO? <a href="#a0b145f10827466b4822646865ce9f8fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_file_appender.html#a8556d19b129aa550f5b2819ed0320e83">bufferSize</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">How big should the IO buffer be? Default is 8K. <a href="#a8556d19b129aa550f5b2819ed0320e83"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> appends log events to a file. </p>
<p>Support for <code>java.io.Writer</code> and console appending has been deprecated and then removed. See the replacement solutions: <a class="el" href="classlog4cxx_1_1_writer_appender.html" title="WriterAppender appends log events to a standard output stream.">WriterAppender</a> and <a class="el" href="classlog4cxx_1_1_console_appender.html" title="ConsoleAppender appends log events to stdout or stderr using a layout specified by the user...">ConsoleAppender</a>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3d8fe210d6211cccc14aa2363753cffd"></a><!-- doxytag: member="log4cxx::FileAppender::FileAppender" ref="a3d8fe210d6211cccc14aa2363753cffd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor does not do anything. </p>
</div>
</div>
<a class="anchor" id="acc7b3781f413f9be2a19980f3ceb4bf4"></a><!-- doxytag: member="log4cxx::FileAppender::FileAppender" ref="acc7b3781f413f9be2a19980f3ceb4bf4" args="(const LayoutPtr &layout, const LogString &filename, bool append, bool bufferedIO, int bufferSize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>append</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bufferedIO</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>bufferSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a <code><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a></code> and open the file designated by <code>filename</code>. </p>
<p>The opened filename will become the output destination for this appender.</p>
<p>If the <code>append</code> parameter is true, the file will be appended to. Otherwise, the file designated by <code>filename</code> will be truncated before being opened.</p>
<p>If the <code>bufferedIO</code> parameter is <code>true</code>, then buffered IO will be used to write to the output file. </p>
</div>
</div>
<a class="anchor" id="a4a4d542375d6f4d71c9859208167d99b"></a><!-- doxytag: member="log4cxx::FileAppender::FileAppender" ref="a4a4d542375d6f4d71c9859208167d99b" args="(const LayoutPtr &layout, const LogString &filename, bool append)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>append</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> and open the file designated by <code>filename</code>. </p>
<p>The opened filename will become the output destination for this appender.</p>
<p>If the <code>append</code> parameter is true, the file will be appended to. Otherwise, the file designated by <code>filename</code> will be truncated before being opened. </p>
</div>
</div>
<a class="anchor" id="a80646ffb11365b0e9a8a7bdc0b3c5160"></a><!-- doxytag: member="log4cxx::FileAppender::FileAppender" ref="a80646ffb11365b0e9a8a7bdc0b3c5160" args="(const LayoutPtr &layout, const LogString &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LayoutPtr</a> & </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Instantiate a <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> and open the file designated by <code>filename</code>. </p>
<p>The opened filename will become the output destination for this appender.</p>
<p>The file will be appended to. </p>
</div>
</div>
<a class="anchor" id="a82f3f9274e8fe0280b7f88ceb62f0a04"></a><!-- doxytag: member="log4cxx::FileAppender::~FileAppender" ref="a82f3f9274e8fe0280b7f88ceb62f0a04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa3df68f8aae152299471992071e202f5"></a><!-- doxytag: member="log4cxx::FileAppender::activateOptions" ref="aa3df68f8aae152299471992071e202f5" args="(log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activateOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets and <em>opens</em> the file where the log output will go. The specified file must be writable.</p>
<p>If there was already an opened file, then the previous file is closed first. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_writer_appender.html#a9fe8531491720e83f1d25862d918a37d">WriterAppender</a>.</p>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#a580abdcb8fd42d07eaf679166f77bc34">DailyRollingFileAppender</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html#a580abdcb8fd42d07eaf679166f77bc34">RollingFileAppenderSkeleton</a>, and <a class="el" href="classlog4cxx_1_1_rolling_file_appender.html#a75035ac63aad24ddcbb340ddaba57f1c">RollingFileAppender</a>.</p>
</div>
</div>
<a class="anchor" id="af8cb171146140874fb651ca95e142805"></a><!-- doxytag: member="log4cxx::FileAppender::getAppend" ref="af8cb171146140874fb651ca95e142805" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getAppend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b>Append</b> option. </p>
</div>
</div>
<a class="anchor" id="ae251083c7609154002d8f798e6ffce17"></a><!-- doxytag: member="log4cxx::FileAppender::getBufferedIO" ref="ae251083c7609154002d8f798e6ffce17" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getBufferedIO </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of the <b>BufferedIO</b> option. </p>
<p>BufferedIO will significatnly increase performance on heavily loaded systems. </p>
</div>
</div>
<a class="anchor" id="a5f0ab7189f063f69cdd39cbf74d5aaf5"></a><!-- doxytag: member="log4cxx::FileAppender::getBufferSize" ref="a5f0ab7189f063f69cdd39cbf74d5aaf5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int getBufferSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the size of the IO buffer. </p>
</div>
</div>
<a class="anchor" id="afdf1897af9ae5c70308224d3a7d8f339"></a><!-- doxytag: member="log4cxx::FileAppender::getFile" ref="afdf1897af9ae5c70308224d3a7d8f339" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the <b><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></b> option. </p>
</div>
</div>
<a class="anchor" id="a78ebca211ceb3a0b2960a48092089906"></a><!-- doxytag: member="log4cxx::FileAppender::setAppend" ref="a78ebca211ceb3a0b2960a48092089906" args="(bool fileAppend1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setAppend </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>fileAppend1</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>Append</b> option takes a boolean value. </p>
<p>It is set to <code>true</code> by default. If true, then <code><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></code> will be opened in append mode by <a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930" title="The File property takes a string value which should be the name of the file to append to...">setFile</a> (see above). Otherwise, setFile will open <code><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></code> in truncate mode.</p>
<p>Note: Actual opening of the file is made when <a class="el" href="classlog4cxx_1_1_file_appender.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> is called, not when the options are set. </p>
</div>
</div>
<a class="anchor" id="a5e4b35c8c3fd337b6c9e3c4aea0ceede"></a><!-- doxytag: member="log4cxx::FileAppender::setBufferedIO" ref="a5e4b35c8c3fd337b6c9e3c4aea0ceede" args="(bool bufferedIO)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setBufferedIO </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bufferedIO</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b>BufferedIO</b> option takes a boolean value. </p>
<p>It is set to <code>false</code> by default. If true, then <code><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></code> will be opened in buffered mode.</p>
<p>BufferedIO will significantly increase performance on heavily loaded systems. </p>
</div>
</div>
<a class="anchor" id="a6426a0a69cabf98da63f87a4849dffae"></a><!-- doxytag: member="log4cxx::FileAppender::setBufferSize" ref="a6426a0a69cabf98da63f87a4849dffae" args="(int bufferSize1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setBufferSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>bufferSize1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the size of the IO buffer. </p>
</div>
</div>
<a class="anchor" id="a6a6c98222ccf2072dad5a434f9336930"></a><!-- doxytag: member="log4cxx::FileAppender::setFile" ref="a6a6c98222ccf2072dad5a434f9336930" args="(const LogString &file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The <b><a class="el" href="classlog4cxx_1_1_file.html" title="An abstract representation of file and directory path names.">File</a></b> property takes a string value which should be the name of the file to append to. </p>
<p><b>Note that the special values "System.out" or "System.err" are no longer honored.</b></p>
<p>Note: Actual opening of the file is made when <a class="el" href="classlog4cxx_1_1_file_appender.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> is called, not when the options are set. </p>
</div>
</div>
<a class="anchor" id="aa4a716f4661cf85cdfde59b447654358"></a><!-- doxytag: member="log4cxx::FileAppender::setFile" ref="aa4a716f4661cf85cdfde59b447654358" args="(const LogString &file, bool append, bool bufferedIO, size_t bufferSize, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>append</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>bufferedIO</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufferSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets and <em>opens</em> the file where the log output will go. </p>
<p>The specified file must be writable.</p>
<p>If there was already an opened file, then the previous file is closed first.</p>
<p><b>Do not use this method directly. To configure a <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> or one of its subclasses, set its properties one by one and then call activateOptions.</b></p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>The path to the log file. </td></tr>
<tr><td class="paramname">append</td><td>If true will append to fileName. Otherwise will truncate fileName. </td></tr>
<tr><td class="paramname">bufferedIO</td><td>Do we do bufferedIO? </td></tr>
<tr><td class="paramname">bufferSize</td><td>How big should the IO buffer be? </td></tr>
<tr><td class="paramname">p</td><td>memory pool for operation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a><!-- doxytag: member="log4cxx::FileAppender::setOption" ref="ac1d269357907e0809687a2bec962e1c8" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1_file_appender.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> is called. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_writer_appender.html#ac1d269357907e0809687a2bec962e1c8">WriterAppender</a>.</p>
<p>Reimplemented in <a class="el" href="classlog4cxx_1_1_daily_rolling_file_appender.html#ac1d269357907e0809687a2bec962e1c8">DailyRollingFileAppender</a>, and <a class="el" href="classlog4cxx_1_1_rolling_file_appender.html#aee5023c29cca9dc68164b22a01cb7c6e">RollingFileAppender</a>.</p>
</div>
</div>
<a class="anchor" id="ac5fea9e45f5a70c22c6d2d71b0666913"></a><!-- doxytag: member="log4cxx::FileAppender::stripDuplicateBackslashes" ref="ac5fea9e45f5a70c22c6d2d71b0666913" args="(const LogString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> stripDuplicateBackslashes </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replaces double backslashes with single backslashes for compatibility with paths from earlier XML configurations files. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>file name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>corrected file name </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0b145f10827466b4822646865ce9f8fe"></a><!-- doxytag: member="log4cxx::FileAppender::bufferedIO" ref="a0b145f10827466b4822646865ce9f8fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classlog4cxx_1_1_file_appender.html#a0b145f10827466b4822646865ce9f8fe">bufferedIO</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Do we do bufferedIO? </p>
</div>
</div>
<a class="anchor" id="a8556d19b129aa550f5b2819ed0320e83"></a><!-- doxytag: member="log4cxx::FileAppender::bufferSize" ref="a8556d19b129aa550f5b2819ed0320e83" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classlog4cxx_1_1_file_appender.html#a8556d19b129aa550f5b2819ed0320e83">bufferSize</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>How big should the IO buffer be? Default is 8K. </p>
</div>
</div>
<a class="anchor" id="aa4cb3c72f0db3854c371ec3d12fb1132"></a><!-- doxytag: member="log4cxx::FileAppender::fileAppend" ref="aa4cb3c72f0db3854c371ec3d12fb1132" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classlog4cxx_1_1_file_appender.html#aa4cb3c72f0db3854c371ec3d12fb1132">fileAppend</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append to or truncate the file? The default value for this variable is <code>true</code>, meaning that by default a <code><a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a></code> will append to an existing file and not truncate it. </p>
<p>This option is meaningful only if the <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> opens the file. </p>
</div>
</div>
<a class="anchor" id="a017826792cfaa215e4ae83bb3aef2681"></a><!-- doxytag: member="log4cxx::FileAppender::fileName" ref="a017826792cfaa215e4ae83bb3aef2681" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> <a class="el" href="classlog4cxx_1_1_file_appender.html#a017826792cfaa215e4ae83bb3aef2681">fileName</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the log file. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="fileappender_8h.html">fileappender.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1_file_appender.html">FileAppender</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
