<!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: BasicConfigurator 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_basic_configurator.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>BasicConfigurator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::BasicConfigurator" -->
<p>Use this class to quickly configure the package.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1_basic_configurator-members.html">List of all members.</a></p>
<table class="memberdecls">
<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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_basic_configurator.html#a4f96a09e1372664e3556ce94ace4a70c">configure</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a <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> that uses <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string.">PatternLayout</a> using the PatternLayout::TTCC_CONVERSION_PATTERN and prints to <code>stdout</code> to the root logger. <a href="#a4f96a09e1372664e3556ce94ace4a70c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_basic_configurator.html#a675a6645a48efb59b84755bef08a4056">configure</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add <code>appender</code> to the root logger. <a href="#a675a6645a48efb59b84755bef08a4056"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1_basic_configurator.html#a5ea603fb2ec6652d788fa259d35f146e">resetConfiguration</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the default hierarchy to its defaut. <a href="#a5ea603fb2ec6652d788fa259d35f146e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected 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_basic_configurator.html#ac12152d81ec4cbed553ee3bd22423845">BasicConfigurator</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Use this class to quickly configure the package. </p>
<p>For file based configuration see <a class="el" href="classlog4cxx_1_1_property_configurator.html" title="Allows the configuration of log4cxx from an external file.">PropertyConfigurator</a>. For XML based configuration see DOMConfigurator. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac12152d81ec4cbed553ee3bd22423845"></a><!-- doxytag: member="log4cxx::BasicConfigurator::BasicConfigurator" ref="ac12152d81ec4cbed553ee3bd22423845" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_basic_configurator.html">BasicConfigurator</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4f96a09e1372664e3556ce94ace4a70c"></a><!-- doxytag: member="log4cxx::BasicConfigurator::configure" ref="a4f96a09e1372664e3556ce94ace4a70c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void configure </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a <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> that uses <a class="el" href="classlog4cxx_1_1_pattern_layout.html" title="A flexible layout configurable with pattern string.">PatternLayout</a> using the PatternLayout::TTCC_CONVERSION_PATTERN and prints to <code>stdout</code> to the root logger. </p>
</div>
</div>
<a class="anchor" id="a675a6645a48efb59b84755bef08a4056"></a><!-- doxytag: member="log4cxx::BasicConfigurator::configure" ref="a675a6645a48efb59b84755bef08a4056" args="(const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void configure </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="paramname"><em>appender</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add <code>appender</code> to the root logger. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appender</td><td>The appender to add to the root logger. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5ea603fb2ec6652d788fa259d35f146e"></a><!-- doxytag: member="log4cxx::BasicConfigurator::resetConfiguration" ref="a5ea603fb2ec6652d788fa259d35f146e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void resetConfiguration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset the default hierarchy to its defaut. </p>
<p>It is equivalent to calling <code>Logger::getDefaultHierarchy()-><a class="el" href="classlog4cxx_1_1_basic_configurator.html#a5ea603fb2ec6652d788fa259d35f146e" title="Reset the default hierarchy to its defaut.">resetConfiguration()</a></code>. See <a class="el" href="classlog4cxx_1_1_hierarchy.html#a9081872e9bdc07e4f5b1c28e86eafed7" title="Reset all values contained in this hierarchy instance to their default.">Hierarchy::resetConfiguration()</a> for more details. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="basicconfigurator_8h.html">basicconfigurator.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_basic_configurator.html">BasicConfigurator</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>
