File: classlog4cpp_1_1Win32DebugAppender.html

package info (click to toggle)
log4cpp-doc 1.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,528 kB
  • sloc: makefile: 10
file content (168 lines) | stat: -rw-r--r-- 11,367 bytes parent folder | download | duplicates (5)
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
<!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::Win32DebugAppender 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_1Win32DebugAppender.html">Win32DebugAppender</a></div>
<h1>log4cpp::Win32DebugAppender Class Reference</h1><!-- doxytag: class="log4cpp::Win32DebugAppender" --><!-- doxytag: inherits="log4cpp::LayoutAppender" --><a class="el" href="classlog4cpp_1_1Win32DebugAppender.html" title="Win32DebugAppender simply sends the log message to the default system debugger on...">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.gif" border="0" usemap="#log4cpp_1_1Win32DebugAppender__inherit__map" alt="Inheritance graph"></center>
<map name="log4cpp_1_1Win32DebugAppender__inherit__map">
<area shape="rect" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout." alt="" coords="21,155,184,181"><area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="17,80,188,107"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="41,5,164,32"></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.gif" border="0" usemap="#log4cpp_1_1Win32DebugAppender__coll__map" alt="Collaboration graph"></center>
<map name="log4cpp_1_1Win32DebugAppender__coll__map">
<area shape="rect" href="classlog4cpp_1_1LayoutAppender.html" title="LayoutAppender is a common superclass for all Appenders that require a Layout." alt="" coords="172,277,335,304"><area shape="rect" href="classlog4cpp_1_1AppenderSkeleton.html" title="AppenderSkeleton is a helper class, simplifying implementation of Appenders: it already..." alt="" coords="45,187,216,213"><area shape="rect" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements." alt="" coords="25,96,148,123"><area shape="rect" href="classlog4cpp_1_1threading_1_1Mutex.html" title="log4cpp::threading::Mutex" alt="" coords="5,5,168,32"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,28,91,36"><area shape="rect" title="_appenderMapMutex" alt="" coords="83,92,91,100"><area shape="rect" href="classlog4cpp_1_1Filter.html" title="Users should extend this class to implement customized logging event filtering." alt="" coords="172,96,271,123"><area shape="rect" title="_filter" alt="" coords="204,119,212,127"><area shape="rect" title="_filter" alt="" coords="140,183,148,191"><area shape="rect" title="_chainedFilter" alt="" coords="241,92,249,100"><area shape="rect" title="_chainedFilter" alt="" coords="241,119,249,127"><area shape="rect" href="classlog4cpp_1_1Layout.html" title="Extend this abstract class to create your own log layout format." alt="" coords="240,187,349,213"><area shape="rect" title="_layout" alt="" coords="284,209,292,217"><area shape="rect" title="_layout" alt="" coords="256,273,264,281"></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#d51a4363945a344ac13c30bf5cb0e81e">Win32DebugAppender</a> (const std::string &amp;name)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#d51a4363945a344ac13c30bf5cb0e81e"></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#96f9bc0645c85206a0404267f0718a5b">~Win32DebugAppender</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#96f9bc0645c85206a0404267f0718a5b"></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#ba78360b0f6b186ecca8496ac055348f">close</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close method.  <a href="#ba78360b0f6b186ecca8496ac055348f"></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#d0c0782825056ec8ee7d72d5361227d5">_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="#d0c0782825056ec8ee7d72d5361227d5"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classlog4cpp_1_1Win32DebugAppender.html" title="Win32DebugAppender simply sends the log message to the default system debugger on...">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="d51a4363945a344ac13c30bf5cb0e81e"></a><!-- doxytag: member="log4cpp::Win32DebugAppender::Win32DebugAppender" ref="d51a4363945a344ac13c30bf5cb0e81e" args="(const std::string &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">log4cpp::Win32DebugAppender::Win32DebugAppender           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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>

</div>
</div><p>
<a class="anchor" name="96f9bc0645c85206a0404267f0718a5b"></a><!-- doxytag: member="log4cpp::Win32DebugAppender::~Win32DebugAppender" ref="96f9bc0645c85206a0404267f0718a5b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">log4cpp::Win32DebugAppender::~Win32DebugAppender           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ba78360b0f6b186ecca8496ac055348f"></a><!-- doxytag: member="log4cpp::Win32DebugAppender::close" ref="ba78360b0f6b186ecca8496ac055348f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void log4cpp::Win32DebugAppender::close           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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#c62f94c6692fd146fcf37455d3e73439">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<a class="anchor" name="d0c0782825056ec8ee7d72d5361227d5"></a><!-- doxytag: member="log4cpp::Win32DebugAppender::_append" ref="d0c0782825056ec8ee7d72d5361227d5" args="(const LoggingEvent &amp;event)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void log4cpp::Win32DebugAppender::_append           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>event</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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#643fb2614192ea09b502a3feb27abe66">log4cpp::AppenderSkeleton</a>.
</div>
</div><p>
<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="text-align: right;"><small>Generated on Mon Sep 3 11:55:07 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>