File: classlog4cpp_1_1SimpleConfigurator.html

package info (click to toggle)
log4cpp-doc 1.0-2.1
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 8,528 kB
  • sloc: makefile: 10
file content (120 lines) | stat: -rw-r--r-- 8,110 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<!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="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</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>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</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 class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1SimpleConfigurator.html">SimpleConfigurator</a></div>
<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 &lt;<a class="el" href="SimpleConfigurator_8hh-source.html">SimpleConfigurator.hh</a>&gt;</code>
<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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SimpleConfigurator.html#6ef57d711227ccabb1f3f14ff46f5f1c">configure</a> (const std::string &amp;initFileName)  throw (ConfigureFailure)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SimpleConfigurator.html#06ef5c2490108ca500433a33a420d0f1">configure</a> (std::istream &amp;initFile)  throw (ConfigureFailure)</td></tr>

<tr><td class="mdescLeft">&nbsp;</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 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>

<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6ef57d711227ccabb1f3f14ff46f5f1c"></a><!-- doxytag: member="log4cpp::SimpleConfigurator::configure" ref="6ef57d711227ccabb1f3f14ff46f5f1c" args="(const std::string &amp;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 &amp;&nbsp;</td>
          <td class="paramname"> <em>initFileName</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">  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>&nbsp;</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>&nbsp;</td><td>if the method encountered a read or syntax error. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="06ef5c2490108ca500433a33a420d0f1"></a><!-- doxytag: member="log4cpp::SimpleConfigurator::configure" ref="06ef5c2490108ca500433a33a420d0f1" args="(std::istream &amp;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 &amp;&nbsp;</td>
          <td class="paramname"> <em>initFile</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%">  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>&nbsp;</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>&nbsp;</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>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 3 11:55:06 2007 for log4cpp by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>