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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Error — HARP 1.16 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="next" title="General" href="libharp_general.html" />
<link rel="prev" title="Documentation" href="libharp_documentation.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> HARP
</a>
<div class="version">
1.16
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="conventions/index.html">Conventions</a></li>
<li class="toctree-l1"><a class="reference internal" href="algorithms/index.html">Algorithms</a></li>
<li class="toctree-l1"><a class="reference internal" href="operations.html">Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="ingestions/index.html">Ingestion definitions</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="libharp.html">C library</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="libharp.html#introduction">Introduction</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="libharp.html#modules">Modules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="libharp_collocation.html">Collocation</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_dataset.html">Dataset</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_documentation.html">Documentation</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Error</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_general.html">General</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_geometry.html">Geometry</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_product.html">Product</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_product_metadata.html">Product Metadata</a></li>
<li class="toctree-l3"><a class="reference internal" href="libharp_variable.html">Variable</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="idl.html">IDL interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="matlab.html">MATLAB interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="R.html">R interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="tools.html">Command line tools</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">HARP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="libharp.html">C library</a> »</li>
<li>Error</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="error">
<h1>Error</h1>
<dl>
<dt class="sig sig-object cpp">
<span class="target" id="group__harp__error"></span><em><span class="pre">group</span></em> <span class="sig-name descname"><span class="pre">harp_error</span></span></dt>
<dd><p>With a few exceptions almost all HARP functions return an integer that indicate whether the function was able to perform its operations successfully. The return value will be 0 on success and -1 otherwise. In case you get a -1 you can look at the global variable <a class="reference internal" href="#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a> for a precise error code. Each error code and its meaning is described in this section. You will also be able to retrieve a character string with an error description via the <a class="reference internal" href="#group__harp__error_1ga3e1f9afd3dbc79e6eda1ad0a3e4fab4c"><span class="std std-ref">harp_errno_to_string()</span></a> function. This function will return either the default error message for the error code, or a custom error message. A custom error message will only be returned if the error code you pass to <a class="reference internal" href="#group__harp__error_1ga3e1f9afd3dbc79e6eda1ad0a3e4fab4c"><span class="std std-ref">harp_errno_to_string()</span></a> is equal to the last error that occurred and if this last error was set with a custom error message. The HARP error state can be set with the <a class="reference internal" href="#group__harp__error_1ga4c4481ea12d137e0168fa578874cd13c"><span class="std std-ref">harp_set_error()</span></a> function.</p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-error-values">Error values</p>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_SUCCESS">
<span class="target" id="group__harp__error_1ga68059cea92b0f401f970fe20e3e60760"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_SUCCESS</span></span></span><br /></dt>
<dd><p>Success (no error). </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_OUT_OF_MEMORY">
<span class="target" id="group__harp__error_1gafb2ed30a8c793905d1af7a9f113bf825"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_OUT_OF_MEMORY</span></span></span><br /></dt>
<dd><p>Out of memory. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_HDF4">
<span class="target" id="group__harp__error_1ga30840307c6dc9e163e28a0477a592e32"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_HDF4</span></span></span><br /></dt>
<dd><p>An error occurred in the HDF4 library. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_NO_HDF4_SUPPORT">
<span class="target" id="group__harp__error_1ga4f2eeb016cae99fbfb573b38973c2d88"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_NO_HDF4_SUPPORT</span></span></span><br /></dt>
<dd><p>No HDF4 support built into HARP. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_HDF5">
<span class="target" id="group__harp__error_1ga73446b8fb543e9dc469104af96b7b150"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_HDF5</span></span></span><br /></dt>
<dd><p>An error occurred in the HDF5 library. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_NO_HDF5_SUPPORT">
<span class="target" id="group__harp__error_1ga1b576af480a680eb53d835d5e5704190"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_NO_HDF5_SUPPORT</span></span></span><br /></dt>
<dd><p>No HDF5 support built into HARP. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_NETCDF">
<span class="target" id="group__harp__error_1ga8e53473a3ebc01fa8baacb969f264a91"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_NETCDF</span></span></span><br /></dt>
<dd><p>An error occurred in the netCDF library. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_CODA">
<span class="target" id="group__harp__error_1ga74d08eca314d0b115b858a7e904f9e9a"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_CODA</span></span></span><br /></dt>
<dd><p>An error occurred in the CODA library. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_FILE_NOT_FOUND">
<span class="target" id="group__harp__error_1gab949a12a4d53f944ac775f62463d9f04"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_FILE_NOT_FOUND</span></span></span><br /></dt>
<dd><p>File not found. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_FILE_OPEN">
<span class="target" id="group__harp__error_1gab79d1488679667e3431b865470d5210f"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_FILE_OPEN</span></span></span><br /></dt>
<dd><p>Could not open file. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_FILE_CLOSE">
<span class="target" id="group__harp__error_1ga4872da77fbeaed2ab636a63646a9ddbe"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_FILE_CLOSE</span></span></span><br /></dt>
<dd><p>Could not close file. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_FILE_READ">
<span class="target" id="group__harp__error_1ga04fe3d66402eade8796f2709b32d1766"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_FILE_READ</span></span></span><br /></dt>
<dd><p>Could not read data from file. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_FILE_WRITE">
<span class="target" id="group__harp__error_1gab2707a58bbffd9131805ff81fc92d391"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_FILE_WRITE</span></span></span><br /></dt>
<dd><p>Could not write data to file. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_ARGUMENT">
<span class="target" id="group__harp__error_1gaeb49a79d8c6cb0d1573c4e97082378df"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_ARGUMENT</span></span></span><br /></dt>
<dd><p>Invalid argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_INDEX">
<span class="target" id="group__harp__error_1ga4b5ecb3852927fd11ece84e559111cb5"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_INDEX</span></span></span><br /></dt>
<dd><p>Invalid index argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_NAME">
<span class="target" id="group__harp__error_1ga2618a4af32fff0be062eb7027a5cdf59"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_NAME</span></span></span><br /></dt>
<dd><p>Invalid name argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_FORMAT">
<span class="target" id="group__harp__error_1gae5e46e4c93aabd1022ce70924e0f9e06"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_FORMAT</span></span></span><br /></dt>
<dd><p>Invalid format in argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_DATETIME">
<span class="target" id="group__harp__error_1ga96c77d8247a5a78da088004b3e93b17e"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_DATETIME</span></span></span><br /></dt>
<dd><p>Invalid date/time argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_TYPE">
<span class="target" id="group__harp__error_1ga635b4439f915292d6fb9aa8da1649a92"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_TYPE</span></span></span><br /></dt>
<dd><p>Invalid type. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_ARRAY_NUM_DIMS_MISMATCH">
<span class="target" id="group__harp__error_1ga3bd88e0fa224286d60c9d0bd05ce72fb"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_ARRAY_NUM_DIMS_MISMATCH</span></span></span><br /></dt>
<dd><p>Incorrect number of dimensions argument. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_ARRAY_OUT_OF_BOUNDS">
<span class="target" id="group__harp__error_1gae9f0f1a1d949f975176e005c49d4cd63"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_ARRAY_OUT_OF_BOUNDS</span></span></span><br /></dt>
<dd><p>Array index out of bounds. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_VARIABLE_NOT_FOUND">
<span class="target" id="group__harp__error_1ga3d403606b57bb610c3bcbc9b9d1fb731"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_VARIABLE_NOT_FOUND</span></span></span><br /></dt>
<dd><p>Variable not found. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_UNIT_CONVERSION">
<span class="target" id="group__harp__error_1ga49b46323ded4794283df45f729a34c41"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_UNIT_CONVERSION</span></span></span><br /></dt>
<dd><p>An error occurred in the unit conversion. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_OPERATION">
<span class="target" id="group__harp__error_1gaa97b53dbf98865a692206124ecea77a9"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_OPERATION</span></span></span><br /></dt>
<dd><p>There was an error detected in the product operations. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_OPERATION_SYNTAX">
<span class="target" id="group__harp__error_1gac52997dcb8953d62295f207f7ed432ba"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_OPERATION_SYNTAX</span></span></span><br /></dt>
<dd><p>There is a syntax error in the string defining the product operations. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_IMPORT">
<span class="target" id="group__harp__error_1gab1df5e2e4b0560e799e8fd309ccfcda8"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_IMPORT</span></span></span><br /></dt>
<dd><p>An error occurred during product import. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_EXPORT">
<span class="target" id="group__harp__error_1gafda54ca1cacf9d1ca9fbaa722925de11"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_EXPORT</span></span></span><br /></dt>
<dd><p>An error occurred during product export. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INGESTION">
<span class="target" id="group__harp__error_1ga96dcea1746335f81175e76af798f7f7b"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INGESTION</span></span></span><br /></dt>
<dd><p>There was an error in the ingestion of a data product. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INGESTION_OPTION_SYNTAX">
<span class="target" id="group__harp__error_1gad782800f47014699a4edc3fc836a86f6"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INGESTION_OPTION_SYNTAX</span></span></span><br /></dt>
<dd><p>There was a syntax error in the ingestion option. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_INGESTION_OPTION">
<span class="target" id="group__harp__error_1gaa5befae2c7cbbcd46a1acd51356d72f2"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_INGESTION_OPTION</span></span></span><br /></dt>
<dd><p>The ingestion option is not valid for this ingestion. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_INVALID_INGESTION_OPTION_VALUE">
<span class="target" id="group__harp__error_1gaff7c069d932321c3c5efd7520283e9b8"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_INVALID_INGESTION_OPTION_VALUE</span></span></span><br /></dt>
<dd><p>The ingestion option has value that is not valid for this option. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_UNSUPPORTED_PRODUCT">
<span class="target" id="group__harp__error_1ga8f380f771cbe87129a96533c96927715"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_UNSUPPORTED_PRODUCT</span></span></span><br /></dt>
<dd><p>The data product is not supported by the import or ingestion module. </p>
</dd></dl>
<dl class="cpp macro">
<dt class="sig sig-object cpp" id="c.HARP_ERROR_NO_DATA">
<span class="target" id="group__harp__error_1ga6436bd225741cc991f393d1ee0f7247b"></span><span class="sig-name descname"><span class="n"><span class="pre">HARP_ERROR_NO_DATA</span></span></span><br /></dt>
<dd><p>The operation resulted in an ‘empty’ product. </p>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-functions">Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv422harp_add_error_messagePKcz">
<span id="_CPPv322harp_add_error_messagePKcz"></span><span id="_CPPv222harp_add_error_messagePKcz"></span><span id="harp_add_error_message__cCP.z"></span><span class="target" id="group__harp__error_1gae96d94cb25a16e81133a7346c0a970bd"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_add_error_message</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">message</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Extend the current error message with additional information. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> – Error message using printf() format. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv414harp_set_erroriPKcz">
<span id="_CPPv314harp_set_erroriPKcz"></span><span id="_CPPv214harp_set_erroriPKcz"></span><span id="harp_set_error__i.cCP.z"></span><span class="target" id="group__harp__error_1ga4c4481ea12d137e0168fa578874cd13c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_error</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">err</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">message</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set the error value and optionally set a custom error message. If <em>message</em> is NULL then the default error message for the error number will be used. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>err</strong> – Value of <a class="reference internal" href="#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>. </p></li>
<li><p><strong>message</strong> – Optional error message using printf() format. </p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv420harp_errno_to_stringi">
<span id="_CPPv320harp_errno_to_stringi"></span><span id="_CPPv220harp_errno_to_stringi"></span><span id="harp_errno_to_string__i"></span><span class="target" id="group__harp__error_1ga3e1f9afd3dbc79e6eda1ad0a3e4fab4c"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">harp_errno_to_string</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">err</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Returns a string with the description of the HARP error. If <em>err</em> equals the current HARP error status then this function will return the error message that was last set using <a class="reference internal" href="#group__harp__error_1ga4c4481ea12d137e0168fa578874cd13c"><span class="std std-ref">harp_set_error()</span></a>. If the error message argument to <a class="reference internal" href="#group__harp__error_1ga4c4481ea12d137e0168fa578874cd13c"><span class="std std-ref">harp_set_error()</span></a> was NULL or if <em>err</em> does not equal the current HARP error status then the default error message for <em>err</em> will be returned. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>err</strong> – Value of <a class="reference internal" href="#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>String with a description of the HARP error. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv419harp_report_warningPKcz">
<span id="_CPPv319harp_report_warningPKcz"></span><span id="_CPPv219harp_report_warningPKcz"></span><span id="harp_report_warning__cCP.z"></span><span class="target" id="group__harp__error_1gaff834a64542a617684269b9512d957f4"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_report_warning</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">message</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Report a warning message The warning message will be passed on to the current warning handler that was set by <a class="reference internal" href="#group__harp__error_1ga88c982481989852993829a34cd310b7d"><span class="std std-ref">harp_set_warning_handler()</span></a>. If no warning handler was set, then this function will do nothing (and return the value 0). The convention is for warning messages to start with a non-capital letter and not contain end-of-line characters. This is similar to the error messages that can be set with <a class="reference internal" href="#group__harp__error_1ga4c4481ea12d137e0168fa578874cd13c"><span class="std std-ref">harp_set_error()</span></a>. Printing of line endings, if these are needed, should be performed by the warning handler. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>message</strong> – Warning message using printf() format. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Return code from the warning handler. </p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv424harp_get_warning_handlerPPFiPKc7va_listE">
<span id="_CPPv324harp_get_warning_handlerPPFiPKc7va_listE"></span><span id="_CPPv224harp_get_warning_handlerPPFiPKc7va_listE"></span><span class="target" id="group__harp__error_1ga81bc467879f19fd0083ae1c66b2552d0"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_get_warning_handler</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">print</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">ap</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Get a reference to the current handler for warning messages If no warning handler was set, the NULL pointer will be returned. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>print</strong> – Pointer to the variable in which the reference to the vprintf compatible function will be stored </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv424harp_set_warning_handlerPFiPKc7va_listE">
<span id="_CPPv324harp_set_warning_handlerPFiPKc7va_listE"></span><span id="_CPPv224harp_set_warning_handlerPFiPKc7va_listE"></span><span class="target" id="group__harp__error_1ga88c982481989852993829a34cd310b7d"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_set_warning_handler</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">print</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">(</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">ap</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><br /></dt>
<dd><p>Set handler for warning messages The <em>print</em> function parameter should be a function that resembles vprintf(). The most common case is to provide a function that prints a ‘WARNING’ prefix, prints the message, and adds a newline. For example: <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="nf">print_warning</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="kt">va_list</span><span class="w"> </span><span class="n">ap</span><span class="p">)</span><span class="w"></span>
<span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">result</span><span class="p">;</span><span class="w"></span>
<span class="w"> </span><span class="n">printf</span><span class="p">(</span><span class="s">"WARNING: "</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">vprintf</span><span class="p">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="n">ap</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">printf</span><span class="p">(</span><span class="s">"</span><span class="se">\n</span><span class="s">"</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">result</span><span class="p">;</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
<span class="n">harp_set_warning_handler</span><span class="p">(</span><span class="n">print_warning</span><span class="p">);</span><span class="w"></span>
</pre></div>
</div>
The handler function will get called whenever <a class="reference internal" href="#group__harp__error_1gaff834a64542a617684269b9512d957f4"><span class="std std-ref">harp_report_warning()</span></a> is called (several functions inside the HARP library may call <a class="reference internal" href="#group__harp__error_1gaff834a64542a617684269b9512d957f4"><span class="std std-ref">harp_report_warning()</span></a> to report on certain warning conditions). The warning handler can be set before a call to <a class="reference internal" href="libharp_general.html#group__harp__general_1gad1f344feb3bea74322283efca649a045"><span class="std std-ref">harp_init()</span></a> is made. </p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>print</strong> – Reference to a vprintf compatible function. </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">0</span></code>, Success. </p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">-1</span></code>, Error occurred (check <a class="reference internal" href="#group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"><span class="std std-ref">harp_errno</span></a>). </p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-variables">Variables</p>
<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv410harp_errno">
<span id="_CPPv310harp_errno"></span><span id="_CPPv210harp_errno"></span><span id="harp_errno__i"></span><span class="target" id="group__harp__error_1gab2eeb46528306c6799632d1e800c4c36"></span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">harp_errno</span></span></span><br /></dt>
<dd><p>Variable that contains the error type. If no error has occurred the variable contains <a class="reference internal" href="#group__harp__error_1ga68059cea92b0f401f970fe20e3e60760"><span class="std std-ref">HARP_SUCCESS</span></a> (0). </p>
</dd></dl>
</div>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="libharp_documentation.html" class="btn btn-neutral float-left" title="Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="libharp_general.html" class="btn btn-neutral float-right" title="General" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2015-2022 S[&]T, The Netherlands.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
