File: group__ERROR.html

package info (click to toggle)
epr-api 2.3~dev20150708-8
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,132 kB
  • sloc: ansic: 14,310; sh: 194; makefile: 146; xml: 125
file content (159 lines) | stat: -rw-r--r-- 7,472 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
 
<!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>Error Handling</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">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERROR.html#gae056f20aba7ac82ccc87e0cef2887806">epr_set_err_handler</a> (<a class="el" href="epr__api_8h.html#a0b742f16d14549fe6900ce3a3942c5cb">EPR_FErrHandler</a> err_handler)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the error handler for the ENVISAT API.  <a href="#gae056f20aba7ac82ccc87e0cef2887806"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="epr__api_8h.html#a55da7083e9783dcf876d3ec8e1b5829a">EPR_EErrCode</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERROR.html#gac09b8e1333438c2a4d3260d41a059261">epr_get_last_err_code</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the error code of the error that occured during the last API function call.  <a href="#gac09b8e1333438c2a4d3260d41a059261"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ERROR.html#ga8265548c417091f77b4580c4bfd0a56b">epr_get_last_err_message</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the error message of the error that occured during the last API function call.  <a href="#ga8265548c417091f77b4580c4bfd0a56b"></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__ERROR.html#gabd11df99e8da1d03e9ec7017475a0e2e">epr_clear_err</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clears the last error.  <a href="#gabd11df99e8da1d03e9ec7017475a0e2e"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gae056f20aba7ac82ccc87e0cef2887806"></a><!-- doxytag: member="epr_api.h::epr_set_err_handler" ref="gae056f20aba7ac82ccc87e0cef2887806" args="(EPR_FErrHandler err_handler)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void epr_set_err_handler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="epr__api_8h.html#a0b742f16d14549fe6900ce3a3942c5cb">EPR_FErrHandler</a>&nbsp;</td>
          <td class="paramname"> <em>err_handler</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the error 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>err_handler</em>&nbsp;</td><td>the new error handler (function pointer), can be NULL, if errors shall not be reported </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="gac09b8e1333438c2a4d3260d41a059261"></a><!-- doxytag: member="epr_api.h::epr_get_last_err_code" ref="gac09b8e1333438c2a4d3260d41a059261" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="epr__api_8h.html#a55da7083e9783dcf876d3ec8e1b5829a">EPR_EErrCode</a> epr_get_last_err_code </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the error code of the error that occured during the last API function call. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the error code, <code>e_err_none</code> or zero if no error occured </dd></dl>

</div>
</div>
<a class="anchor" id="ga8265548c417091f77b4580c4bfd0a56b"></a><!-- doxytag: member="epr_api.h::epr_get_last_err_message" ref="ga8265548c417091f77b4580c4bfd0a56b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* epr_get_last_err_message </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the error message of the error that occured during the last API function call. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the error message, <code>NULL</code> if no error occured </dd></dl>

</div>
</div>
<a class="anchor" id="gabd11df99e8da1d03e9ec7017475a0e2e"></a><!-- doxytag: member="epr_api.h::epr_clear_err" ref="gabd11df99e8da1d03e9ec7017475a0e2e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void epr_clear_err </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Clears the last error. </p>
<p>After calling this function, calling <code>epr_get_last_err_code</code> returns <code>e_err_none</code> or zero and <code>epr_get_last_err_message</code> returns <code>NULL</code>. </p>

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