File: classlog4cpp_1_1Win32DebugAppender.html

package info (click to toggle)
log4cpp-doc 0.3.5-rc3-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 5,664 kB
  • ctags: 925
  • sloc: makefile: 34
file content (192 lines) | stat: -rw-r--r-- 10,002 bytes parent folder | download
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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<!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::Win32DebugAppender 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<div class="nav">
<a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1Win32DebugAppender.html">Win32DebugAppender</a></div>
<h1>log4cpp::Win32DebugAppender Class Reference</h1><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html">Win32DebugAppender</a> simply sends the log message to the default system debugger on Win32 systems.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Win32DebugAppender_8hh-source.html">Win32DebugAppender.hh</a>&gt;</code>
<p>
Inheritance diagram for log4cpp::Win32DebugAppender:<p><center><img src="classlog4cpp_1_1Win32DebugAppender__inherit__graph.png" border="0" usemap="#log4cpp_1_1Win32DebugAppender__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1Win32DebugAppender__inherit__map">
<area href="classlog4cpp_1_1LayoutAppender.html" shape="rect" coords="26,158,200,182" alt="">
<area href="classlog4cpp_1_1AppenderSkeleton.html" shape="rect" coords="21,84,205,108" alt="">
<area href="classlog4cpp_1_1Appender.html" shape="rect" coords="46,9,180,33" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for log4cpp::Win32DebugAppender:<p><center><img src="classlog4cpp_1_1Win32DebugAppender__coll__graph.png" border="0" usemap="#log4cpp_1_1Win32DebugAppender__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1Win32DebugAppender__coll__map">
<area href="classlog4cpp_1_1LayoutAppender.html" shape="rect" coords="148,190,321,214" alt="">
<area href="classlog4cpp_1_1AppenderSkeleton.html" shape="rect" coords="13,99,197,123" alt="">
<area href="classlog4cpp_1_1Appender.html" shape="rect" coords="8,9,141,33" alt="">
<area href="classlog4cpp_1_1Filter.html" shape="rect" coords="165,9,269,33" alt="">
<area href="classlog4cpp_1_1Layout.html" shape="rect" coords="221,99,336,123" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cpp_1_1Win32DebugAppender-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html#a0">Win32DebugAppender</a> (const std::string &amp;name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html#a1">~Win32DebugAppender</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html#a2">close</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close method.  <a href="#a2"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html#b0">_append</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &amp;event)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method that does the actual work.  <a href="#b0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classlog4cpp_1_1Win32DebugAppender.html">Win32DebugAppender</a> simply sends the log message to the default system debugger on Win32 systems. 
<p>
This is useful for users of MSVC and Borland because the log messages will show up in the debugger window.<br>
 <b>NB:</b> This class is only available on Win32 platforms. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cpp::Win32DebugAppender::Win32DebugAppender"></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">log4cpp::Win32DebugAppender::Win32DebugAppender           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const std::string &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>Name used by the base classes only. </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="log4cpp::Win32DebugAppender::~Win32DebugAppender"></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">log4cpp::Win32DebugAppender::~Win32DebugAppender           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Destructor. 
<p>
    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b0" doxytag="log4cpp::Win32DebugAppender::_append"></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::Win32DebugAppender::_append           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>event</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Method that does the actual work. 
<p>
In this case, it simply sets up the layout and calls the OutputDebugString API. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>Event for which we are logging. </td></tr>
  </table>
</dl>

<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#b1">log4cpp::AppenderSkeleton</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="log4cpp::Win32DebugAppender::close"></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::Win32DebugAppender::close           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Close method. 
<p>
This is called by the framework, but there is nothing to do for the OutputDebugString API, so it simply returns. 
<p>
Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#a3">log4cpp::AppenderSkeleton</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Win32DebugAppender_8hh-source.html">Win32DebugAppender.hh</a><li><a class="el" href="Win32DebugAppender_8cpp.html">Win32DebugAppender.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Fri Jul 29 14:12:56 2005 for log4cpp by&nbsp;
<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>