Google Git
Sign in
apache / logging-log4cxx / 64d2ac977e51344f76729b3f566dd9d426a4631f / . / xdocs / www / manual / group__LoggingMacros.html
blob: 5b1b8b647f256f41c99d8a367a030dfc29a1bbe0 [file] [log] [blame]
<html>
<head>
<title>
log4cxx - Documentation
</title>
<link href="../css/doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<!-- START Header table -->
<table border="0" cellspacing="0" width="90%">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://logging.apache.org">
<img src="http://logging.apache.org/images/ls-logo.jpg" align="left" border="0"/>
</a>
</td>
</tr>
</table>
<!-- END Header table -->
<!-- START main table -->
<table id="main" border="0" width="90%" cellspacing="2" cellpadding="0">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td id="navbar" valign="top">
<!-- ============================================================ -->
<table id="navbar" border="0" cellspacing="0" cellpadding="0">
<tr >
<td class="navbarHeader" nowrap="true">
<strong>Apache</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="http://www.apache.org">Apache Home</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="http://logging.apache.org/">Logging Services</a>
</small></td></tr>
<tr >
<td class="navbarHeader" nowrap="true">
<strong>log4cxx project</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="../index.html">About</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../news.html">News</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../team.html">Team</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../manual/index.html">Documentation</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../performance.html">Performance</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../download.html">Download</a>
</small></td></tr>
</table>
</td>
<td id="mainContents" align="left" valign="top">
<hr>
<!-- Generated by Doxygen 1.3.5 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
<h1>Logging macros</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga0">LOG4CXX_LOG</a>(logger, level, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga1">LOG4CXX_DEBUG</a>(logger, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga2">LOG4CXX_INFO</a>(logger, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga3">LOG4CXX_WARN</a>(logger, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga4">LOG4CXX_ERROR</a>(logger, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga5">LOG4CXX_FATAL</a>(logger, message)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga6">LOG4CXX_L7DLOG</a>(logger, level, key)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga7">LOG4CXX_L7DLOG1</a>(logger, level, key, p1)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga8">LOG4CXX_L7DLOG2</a>(logger, level, key, p1, p2)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="group__LoggingMacros.html#ga9">LOG4CXX_L7DLOG3</a>(logger, level, key, p1, p2, p3)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="ga1" doxytag="logger.h::LOG4CXX_DEBUG" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_DEBUG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isDebugEnabled()) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(::log4cxx::Level::DEBUG, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with the DEBUG level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga4" doxytag="logger.h::LOG4CXX_ERROR" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_ERROR</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isErrorEnabled()) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(::log4cxx::Level::ERROR, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with the ERROR level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga5" doxytag="logger.h::LOG4CXX_FATAL" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_FATAL</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isFatalEnabled()) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(::log4cxx::Level::FATAL, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with the FATAL level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga2" doxytag="logger.h::LOG4CXX_INFO" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_INFO</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isInfoEnabled()) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(::log4cxx::Level::INFO, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with the INFO level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga6" doxytag="logger.h::LOG4CXX_L7DLOG" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_L7DLOG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>level, <tr>
<td></td>
<td></td>
<td class="md" nowrap>key&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isEnabledFor(level)) {\
logger-&gt;l7dlog(level, key, __FILE__, __LINE__); }}
</pre></div>Logs a localized message with no parameter.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>the level to log. </td></tr>
<tr><td valign=top><em>key</em>&nbsp;</td><td>the key to be searched in the resourceBundle of the logger. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga7" doxytag="logger.h::LOG4CXX_L7DLOG1" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_L7DLOG1</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>level, <tr>
<td></td>
<td></td>
<td class="md" nowrap>key, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p1&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isEnabledFor(level)) {\
logger-&gt;l7dlog(level, key, __FILE__, __LINE__, p1); }}
</pre></div>Logs a localized message with one parameter.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>the level to log. </td></tr>
<tr><td valign=top><em>key</em>&nbsp;</td><td>the key to be searched in the resourceBundle of the logger. </td></tr>
<tr><td valign=top><em>p1</em>&nbsp;</td><td>the unique parameter. Must be of type (TCHAR *). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga8" doxytag="logger.h::LOG4CXX_L7DLOG2" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_L7DLOG2</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>level, <tr>
<td></td>
<td></td>
<td class="md" nowrap>key, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p1, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p2&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isEnabledFor(level)) {\
logger-&gt;l7dlog(level, key, __FILE__, __LINE__, p1, p2); }}
</pre></div>Logs a localized message with two parameters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>the level to log. </td></tr>
<tr><td valign=top><em>key</em>&nbsp;</td><td>the key to be searched in the resourceBundle of the logger. </td></tr>
<tr><td valign=top><em>p1</em>&nbsp;</td><td>the first parameter. Must be of type (TCHAR *). </td></tr>
<tr><td valign=top><em>p2</em>&nbsp;</td><td>the second parameter. Must be of type (TCHAR *). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga9" doxytag="logger.h::LOG4CXX_L7DLOG3" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_L7DLOG3</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>level, <tr>
<td></td>
<td></td>
<td class="md" nowrap>key, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p1, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p2, <tr>
<td></td>
<td></td>
<td class="md" nowrap>p3&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isEnabledFor(level)) {\
logger-&gt;l7dlog(level, key, __FILE__, __LINE__, p1, p2, p3); }}
</pre></div>Logs a localized message with three parameters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>the level to log. </td></tr>
<tr><td valign=top><em>key</em>&nbsp;</td><td>the key to be searched in the resourceBundle of the logger. </td></tr>
<tr><td valign=top><em>p1</em>&nbsp;</td><td>the first parameter. Must be of type (TCHAR *). </td></tr>
<tr><td valign=top><em>p2</em>&nbsp;</td><td>the second parameter. Must be of type (TCHAR *). </td></tr>
<tr><td valign=top><em>p3</em>&nbsp;</td><td>the third parameter. Must be of type (TCHAR *). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga0" doxytag="logger.h::LOG4CXX_LOG" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_LOG</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>level, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isEnabledFor(level)) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(level, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with a specified level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>the level to log. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga3" doxytag="logger.h::LOG4CXX_WARN" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> #define LOG4CXX_WARN</td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">logger, <tr>
<td></td>
<td></td>
<td class="md" nowrap>message&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre>{ \
<span class="keywordflow">if</span> (logger-&gt;isWarnEnabled()) {\
::log4cxx::StringBuffer oss; \
oss &lt;&lt; message; \
logger-&gt;forcedLog(::log4cxx::Level::WARN, oss.str(), __FILE__, __LINE__); }}
</pre></div>Logs a message to a specified logger with the WARN level.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>logger</em>&nbsp;</td><td>the logger to be used. </td></tr>
<tr><td valign=top><em>message</em>&nbsp;</td><td>the message string to log. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright &#169; 1999-2004, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
<!-- END main table -->
</body>
</html>
<!-- end the processing -->