/usr/share/doc/libdballe-doc/fortran_api/error_8cc.html is in libdballe-doc 5.18-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>libdballeFortranbindings: error.cc File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libdballeFortranbindings
 <span id="projectnumber">5.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">error.cc File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Error inspection functions for Dballe.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "handles.h"</code><br/>
<code>#include <wreport/error.h></code><br/>
<code>#include <stdint.h></code><br/>
<code>#include <cstring></code><br/>
<code>#include <cstdio></code><br/>
<code>#include <f77.h></code><br/>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea0bffe478318f476a4bedee63256b2c"></a><!-- doxytag: member="error.cc::MAX_CALLBACKS" ref="aea0bffe478318f476a4bedee63256b2c" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MAX_CALLBACKS</b>   50</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaee7c7b22ac3d4e626ba0a537be8f85b"></a><!-- doxytag: member="error.cc::error_init" ref="aaee7c7b22ac3d4e626ba0a537be8f85b" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>dballe::fortran::error_init</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85531fd6d7efbc18c7fea54a54a3844b"></a><!-- doxytag: member="error.cc::error" ref="a85531fd6d7efbc18c7fea54a54a3844b" args="(wreport::error &e)" -->
int </td><td class="memItemRight" valign="bottom"><b>dballe::fortran::error</b> (wreport::error &e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24f0ae9cf7b32dc46096e55ee7a80af3"></a><!-- doxytag: member="error.cc::success" ref="a24f0ae9cf7b32dc46096e55ee7a80af3" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>dballe::fortran::success</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a99eebf8b17d89442be3a806504f7dfe5">idba_error_code</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the error code for the last error that happened. <a href="#a99eebf8b17d89442be3a806504f7dfe5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a3877dba11358dbc37a4431fc31c103d9">idba_error_message</a> (character message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the error message for the last error that happened. <a href="#a3877dba11358dbc37a4431fc31c103d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a26570bd54bd8ef362541e56ca179cbf0">idba_error_context</a> (character message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing the context in which the error happened. <a href="#a26570bd54bd8ef362541e56ca179cbf0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">subroutine </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a042ce1ced867a6d69df7ad1eff5582cd">idba_error_details</a> (character message)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a string with additional details about the error. <a href="#a042ce1ced867a6d69df7ad1eff5582cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#afcf8e3f2980feb33c60ea3c8ce5d6613">idba_error_set_callback</a> (integer code, SUBROUTINE(func), integer data, integer handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a callback to be invoked when an error of a specific kind happens. <a href="#afcf8e3f2980feb33c60ea3c8ce5d6613"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a267e239a7757ba87eca162c7c88e19ed">idba_error_remove_callback</a> (integer handle)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a callback set previously. <a href="#a267e239a7757ba87eca162c7c88e19ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a59e5e1bbfc2780b5551b9d0aabd55c5a">idba_default_error_handler</a> (integer debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default callback that prints a message and exits. <a href="#a59e5e1bbfc2780b5551b9d0aabd55c5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a726f71c1901d2ad4f221ce9e47c3da6a"></a><!-- doxytag: member="error.cc::idba_default_error_handle" ref="a726f71c1901d2ad4f221ce9e47c3da6a" args="(integer debug)" -->
integer </td><td class="memItemRight" valign="bottom"><b>idba_default_error_handle</b> (integer debug)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">integer </td><td class="memItemRight" valign="bottom"><a class="el" href="error_8cc.html#a0b65182b1d6b690c94fe90c87ad21663">idba_error_handle_tolerating_overflows</a> (integer debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default callback that prints a message and exists, except in case of overflows. <a href="#a0b65182b1d6b690c94fe90c87ad21663"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Error inspection functions for Dballe. </p>
<p>These funtions closely wrap the Dballe functions in dba_error.h </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a59e5e1bbfc2780b5551b9d0aabd55c5a"></a><!-- doxytag: member="error.cc::idba_default_error_handler" ref="a59e5e1bbfc2780b5551b9d0aabd55c5a" args="(integer debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer <a class="el" href="error_8cc.html#a59e5e1bbfc2780b5551b9d0aabd55c5a">idba_default_error_handler</a> </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>debug</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default callback that prints a message and exits. </p>
<p>The message is printed only if a non-zero value is supplied as user data </p>
</div>
</div>
<a class="anchor" id="a99eebf8b17d89442be3a806504f7dfe5"></a><!-- doxytag: member="error.cc::idba_error_code" ref="a99eebf8b17d89442be3a806504f7dfe5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer <a class="el" href="error_8cc.html#a99eebf8b17d89442be3a806504f7dfe5">idba_error_code</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the error code for the last error that happened. </p>
<p>See dba_error_code()</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error code. Please see the documentation of ::dba_err_code for the possible values. </dd></dl>
</div>
</div>
<a class="anchor" id="a26570bd54bd8ef362541e56ca179cbf0"></a><!-- doxytag: member="error.cc::idba_error_context" ref="a26570bd54bd8ef362541e56ca179cbf0" args="(character message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine <a class="el" href="error_8cc.html#a26570bd54bd8ef362541e56ca179cbf0">idba_error_context</a> </td>
<td>(</td>
<td class="paramtype">character </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a string describing the context in which the error happened. </p>
<p>This string describes what the code that failed was trying to do.</p>
<p>See dba_error_context()</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The string holding the error context. If the string is not long enough, it will be truncated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a042ce1ced867a6d69df7ad1eff5582cd"></a><!-- doxytag: member="error.cc::idba_error_details" ref="a042ce1ced867a6d69df7ad1eff5582cd" args="(character message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine <a class="el" href="error_8cc.html#a042ce1ced867a6d69df7ad1eff5582cd">idba_error_details</a> </td>
<td>(</td>
<td class="paramtype">character </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a string with additional details about the error. </p>
<p>This string contains additional details about the error in case the code was able to get extra informations about it, for example by querying the error functions of an underlying module.</p>
<p>See dba_error_details()</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The string holding the error details. If the string is not long enough, it will be truncated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0b65182b1d6b690c94fe90c87ad21663"></a><!-- doxytag: member="error.cc::idba_error_handle_tolerating_overflows" ref="a0b65182b1d6b690c94fe90c87ad21663" args="(integer debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer <a class="el" href="error_8cc.html#a0b65182b1d6b690c94fe90c87ad21663">idba_error_handle_tolerating_overflows</a> </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>debug</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default callback that prints a message and exists, except in case of overflows. </p>
<p>In case of overflows it prints a warning and continues execution </p>
</div>
</div>
<a class="anchor" id="a3877dba11358dbc37a4431fc31c103d9"></a><!-- doxytag: member="error.cc::idba_error_message" ref="a3877dba11358dbc37a4431fc31c103d9" args="(character message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">subroutine <a class="el" href="error_8cc.html#a3877dba11358dbc37a4431fc31c103d9">idba_error_message</a> </td>
<td>(</td>
<td class="paramtype">character </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the error message for the last error that happened. </p>
<p>The error message is just a description of the error code. To see more details of the specific condition that caused the error, use fdba_error_context() and fdba_error_details()</p>
<p>See dba_error_message()</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">message</td><td>The string holding the error messag. If the string is not long enough, it will be truncated. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a267e239a7757ba87eca162c7c88e19ed"></a><!-- doxytag: member="error.cc::idba_error_remove_callback" ref="a267e239a7757ba87eca162c7c88e19ed" args="(integer handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer <a class="el" href="error_8cc.html#a267e239a7757ba87eca162c7c88e19ed">idba_error_remove_callback</a> </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a callback set previously. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle previously returned by idba_error_set_callback </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error indicator for the function </dd></dl>
</div>
</div>
<a class="anchor" id="afcf8e3f2980feb33c60ea3c8ce5d6613"></a><!-- doxytag: member="error.cc::idba_error_set_callback" ref="afcf8e3f2980feb33c60ea3c8ce5d6613" args="(integer code, SUBROUTINE(func), integer data, integer handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">integer <a class="el" href="error_8cc.html#afcf8e3f2980feb33c60ea3c8ce5d6613">idba_error_set_callback</a> </td>
<td>(</td>
<td class="paramtype">integer </td>
<td class="paramname"><em>code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">SUBROUTINE(func) </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer </td>
<td class="paramname"><em>handle</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a callback to be invoked when an error of a specific kind happens. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">code</td><td>The error code (See dba_err_code) of the error that triggers this callback. If DBA_ERR_NONE is used, then the callback is invoked on all errors. </td></tr>
<tr><td class="paramname">func</td><td>The function to be called. </td></tr>
<tr><td class="paramname">data</td><td>An arbitrary integer data that is passed verbatim to the callback function when invoked. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt><b>Return values:</b></dt><dd>
<table class="retval">
<tr><td class="paramname">handle</td><td>A handle that can be used to remove the callback </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The error indicator for the function </dd></dl>
</div>
</div>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 24 2012 21:04:21 for libdballeFortranbindings by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>
|