File: group__INIT.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 (134 lines) | stat: -rw-r--r-- 6,434 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
<!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>API Initialisation</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__INIT.html#ga344c492638bd5b48cd7f0a2874a8384b">epr_init_api</a> (<a class="el" href="epr__api_8h.html#ab0666c645d9990bbd2b0692d228b5278">EPR_ELogLevel</a> log_level, <a class="el" href="epr__api_8h.html#abfbeade681f1bf11419c818a4b9af560">EPR_FLogHandler</a> log_handler, <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">Initializes the ENVISAT product reader API.  <a href="#ga344c492638bd5b48cd7f0a2874a8384b"></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__INIT.html#ga2fa6abbe9ea5f29c52227956177c2b5f">epr_close_api</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Closes the ENVISAT product reader API by releasing all resources allocated by the API.  <a href="#ga2fa6abbe9ea5f29c52227956177c2b5f"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga344c492638bd5b48cd7f0a2874a8384b"></a><!-- doxytag: member="epr_api.h::epr_init_api" ref="ga344c492638bd5b48cd7f0a2874a8384b" args="(EPR_ELogLevel log_level, EPR_FLogHandler log_handler, EPR_FErrHandler err_handler)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int epr_init_api </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"><a class="el" href="epr__api_8h.html#abfbeade681f1bf11419c818a4b9af560">EPR_FLogHandler</a>&nbsp;</td>
          <td class="paramname"> <em>log_handler</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></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;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the ENVISAT product reader 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_level</em>&nbsp;</td><td>the log level. All logging messages with a log level lower than the given one, will be supressed </td></tr>
    <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 <code>NULL</code>, if logging shall be disabled </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>err_handler</em>&nbsp;</td><td>the new error handler (function pointer), can be <code>NULL</code>, if errors shall not be reported </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>zero for success, an error code otherwise</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Norman Fomferra </dd></dl>

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

<p>Closes the ENVISAT product reader API by releasing all resources allocated by the API. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>Norman Fomferra </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>