<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>log4cpp: log4cpp::SimpleConfigurator Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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 class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</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 class="navpath"><a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1SimpleConfigurator.html">SimpleConfigurator</a> </div> </div> <div class="contents"> <h1>log4cpp::SimpleConfigurator Class Reference</h1><!-- doxytag: class="log4cpp::SimpleConfigurator" -->This class implements a simple Configurator for <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a>. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="SimpleConfigurator_8hh_source.html">SimpleConfigurator.hh</a>></code> <p> <p> <a href="classlog4cpp_1_1SimpleConfigurator-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SimpleConfigurator.html#6ef57d711227ccabb1f3f14ff46f5f1c">configure</a> (const std::string &initFileName) throw (ConfigureFailure)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> with the configuration in the given file. <a href="#6ef57d711227ccabb1f3f14ff46f5f1c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SimpleConfigurator.html#06ef5c2490108ca500433a33a420d0f1">configure</a> (std::istream &initFile) throw (ConfigureFailure)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> with the configuration in the given file. <a href="#06ef5c2490108ca500433a33a420d0f1"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This class implements a simple Configurator for <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a>. <p> It is a temporary hack with an undocumented configuration format. <dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>As of version 0.3.2 <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> includes a log4j format compatible <a class="el" href="classlog4cpp_1_1PropertyConfigurator.html" title="Property configurator will read a config file using the same (or similar) format...">PropertyConfigurator</a>, removing the need for <a class="el" href="classlog4cpp_1_1SimpleConfigurator.html" title="This class implements a simple Configurator for log4cpp.">SimpleConfigurator</a>. This class will be removed in 0.4.0. </dd></dl> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="06ef5c2490108ca500433a33a420d0f1"></a><!-- doxytag: member="log4cpp::SimpleConfigurator::configure" ref="06ef5c2490108ca500433a33a420d0f1" args="(std::istream &initFile)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::SimpleConfigurator::configure </td> <td>(</td> <td class="paramtype">std::istream & </td> <td class="paramname"> <em>initFile</em> </td> <td> ) </td> <td> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Configure <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> with the configuration in the given file. <p> NB. The configuration file format is undocumented and may change without notice. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.3.1 </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>initFile</em> </td><td>an input stream to the configuration file </td></tr> </table> </dl> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classlog4cpp_1_1ConfigureFailure.html" title="Exception class for configuration.">ConfigureFailure</a></em> </td><td>if the method encountered a read or syntax error. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="6ef57d711227ccabb1f3f14ff46f5f1c"></a><!-- doxytag: member="log4cpp::SimpleConfigurator::configure" ref="6ef57d711227ccabb1f3f14ff46f5f1c" args="(const std::string &initFileName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::SimpleConfigurator::configure </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>initFileName</em> </td> <td> ) </td> <td> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Configure <a class="el" href="namespacelog4cpp.html" title="The top level namespace for all 'Log for C++' types and classes.">log4cpp</a> with the configuration in the given file. <p> NB. The configuration file format is undocumented and may change without notice. <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.6 </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>initFileName</em> </td><td>name of the configuration file </td></tr> </table> </dl> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classlog4cpp_1_1ConfigureFailure.html" title="Exception class for configuration.">ConfigureFailure</a></em> </td><td>if the method encountered a read or syntax error. </td></tr> </table> </dl> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="SimpleConfigurator_8hh_source.html">SimpleConfigurator.hh</a><li><a class="el" href="SimpleConfigurator_8cpp.html">SimpleConfigurator.cpp</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 19:34:50 2009 for log4cpp by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>