File: group__LOGGING.html

package info (click to toggle)
epr-api 2.3~dev20150708-13
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,132 kB
  • sloc: ansic: 14,310; sh: 194; makefile: 145; xml: 125
file content (163 lines) | stat: -rw-r--r-- 8,002 bytes parent folder | download | duplicates (6)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ENVISAT Product Reader C API: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="custom.css" rel="stylesheet" type="text/css">
</head><body>
<table class="header">
    <tr class="header">
        <td class="header">&nbsp;
            ENVISAT Product Reader API for C
        </td>
        <td class="header" align="right">
            <a href="http://www.brockmann-consult.de/beam">
                <img src="../images/beam_header.gif" width="227" height="29" border="0">
            </a>
        </td>
    </tr>
</table>
<br>
<!--<div class="navigation">-->
  <!--<div class="tabs">-->
    <!--<ul>-->
      <!--<li class="current"><a href="index.html"><span>API&nbsp;Details</span></a></li>-->
      <!--<li><a href="overview_custom.html"><span>API&nbsp;Overview</span></a></li>-->
    <!--</ul>-->
  <!--</div>-->
<!--</div>-->
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Logging</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LOGGING.html#gaa63e66aa27bdd4330b928cd2fee9c17f">epr_set_log_level</a> (<a class="el" href="epr__api_8h.html#ab0666c645d9990bbd2b0692d228b5278">EPR_ELogLevel</a> log_level)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the log level for the ENVISAT API.  <a href="#gaa63e66aa27bdd4330b928cd2fee9c17f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LOGGING.html#gae786ef515b82cc57e3eca07b4b4ff87f">epr_set_log_handler</a> (<a class="el" href="epr__api_8h.html#abfbeade681f1bf11419c818a4b9af560">EPR_FLogHandler</a> log_handler)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the log handler for the ENVISAT API.  <a href="#gae786ef515b82cc57e3eca07b4b4ff87f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LOGGING.html#ga549effdf5a76ca9e609fd77fab51b4fd">epr_log_message</a> (<a class="el" href="epr__api_8h.html#ab0666c645d9990bbd2b0692d228b5278">EPR_ELogLevel</a> log_level, const char *log_message)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A default implementation for a logging function to be passed into the <code>epr_init()</code> function.  <a href="#ga549effdf5a76ca9e609fd77fab51b4fd"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa63e66aa27bdd4330b928cd2fee9c17f"></a><!-- doxytag: member="epr_api.h::epr_set_log_level" ref="gaa63e66aa27bdd4330b928cd2fee9c17f" args="(EPR_ELogLevel log_level)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int epr_set_log_level </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="epr__api_8h.html#ab0666c645d9990bbd2b0692d228b5278">EPR_ELogLevel</a>&nbsp;</td>
          <td class="paramname"> <em>log_level</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the log level for the ENVISAT API. </p>
<p>All logging messages with a log level lower than the given one, will be supressed, thus the log handler will not be called for such messages.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>log_level</em>&nbsp;</td><td>the new log level. All logging messages with a log level lower than the given one, will be supressed </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero for success, an error code otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="gae786ef515b82cc57e3eca07b4b4ff87f"></a><!-- doxytag: member="epr_api.h::epr_set_log_handler" ref="gae786ef515b82cc57e3eca07b4b4ff87f" args="(EPR_FLogHandler log_handler)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void epr_set_log_handler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="epr__api_8h.html#abfbeade681f1bf11419c818a4b9af560">EPR_FLogHandler</a>&nbsp;</td>
          <td class="paramname"> <em>log_handler</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the log handler for the ENVISAT API. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>log_handler</em>&nbsp;</td><td>the log handler function pointer which will be used for logging, can be NULL, if logging shall be disabled</td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__LOGGING.html#ga549effdf5a76ca9e609fd77fab51b4fd" title="A default implementation for a logging function to be passed into the epr_init()...">epr_log_message</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga549effdf5a76ca9e609fd77fab51b4fd"></a><!-- doxytag: member="epr_api.h::epr_log_message" ref="ga549effdf5a76ca9e609fd77fab51b4fd" args="(EPR_ELogLevel log_level, const char *log_message)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void epr_log_message </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="epr__api_8h.html#ab0666c645d9990bbd2b0692d228b5278">EPR_ELogLevel</a>&nbsp;</td>
          <td class="paramname"> <em>log_level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>log_message</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A default implementation for a logging function to be passed into the <code>epr_init()</code> function. </p>
<p>The function writes to <code>stdout</code>, the format is: <em>log_level date time log_message</em>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>log_level</em>&nbsp;</td><td>the log level </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>log_message</em>&nbsp;</td><td>the log message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div>
<hr>
<div align="center">
    <address>
        <p>Generated on Mon Aug 2 15:24:00 2010
        <p>ENVISAT Product Reader C API
        <p>Written by
        <a href="mailto:info@brockmann-consult.de">Brockmann Consult</a>,
        &copy;&nbsp;2002&nbsp;&nbsp;&nbsp;&nbsp;
        <a href="http://www.brockmann-consult.de/">
            <img src="../images/bc_logo.gif" alt="Brockmann Consult" align="bottom" border=0 width=18 height=18>
        </a>
        &nbsp;&nbsp;&nbsp;&nbsp;
        <a href="http://envisat.esa.int/">
            <img src="../images/esa_logo.gif" alt="Eropean Space Agency" align="bottom" border=0 width=50 height=18>
        </a>

    </address>
</div>
</body>
</html>