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=iso-8859-1">
<title>log4cpp: log4cpp::SimpleConfigurator Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></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>This class implements a simple Configurator for <a class="el" href="namespacelog4cpp.html">log4cpp</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="SimpleConfigurator_8hh-source.html">SimpleConfigurator.hh</a>></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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1SimpleConfigurator.html#e0">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">log4cpp</a> with the configuration in the given file. <a href="#e0"></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#e1">configure</a> (std::istream &initFile) throw (ConfigureFailure)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configure <a class="el" href="namespacelog4cpp.html">log4cpp</a> with the configuration in the given file. <a href="#e1"></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">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">log4cpp</a> includes a log4j format compatible <a class="el" href="classlog4cpp_1_1PropertyConfigurator.html">PropertyConfigurator</a>, removing the need for <a class="el" href="classlog4cpp_1_1SimpleConfigurator.html">SimpleConfigurator</a>.</dd></dl>
This class will be removed in 0.4.0.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e1" doxytag="log4cpp::SimpleConfigurator::configure"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::SimpleConfigurator::configure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">std::istream & </td>
<td class="mdname1" valign="top" nowrap> <em>initFile</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Configure <a class="el" href="namespacelog4cpp.html">log4cpp</a> with the configuration in the given file.
<p>
NB. The configuration file format is undocumented and may change without notice. <dl 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">ConfigureFailure</a></em> </td><td>if the method encountered a read or syntax error. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e0" doxytag="log4cpp::SimpleConfigurator::configure"></a><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void log4cpp::SimpleConfigurator::configure </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const std::string & </td>
<td class="mdname1" valign="top" nowrap> <em>initFileName</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classlog4cpp_1_1ConfigureFailure.html">ConfigureFailure</a>)<code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Configure <a class="el" href="namespacelog4cpp.html">log4cpp</a> with the configuration in the given file.
<p>
NB. The configuration file format is undocumented and may change without notice. <dl 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">ConfigureFailure</a></em> </td><td>if the method encountered a read or syntax error. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<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="align: right;"><small>Generated on Fri Jul 29 14:12:44 2005 for log4cpp by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
</body>
</html>
|
