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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
|
<!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"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Error Handling (H5E)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___h5_e.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Error Handling (H5E)</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaa088620ef0b6c4ac2abcf57d61c8cdb8" id="r_gaa088620ef0b6c4ac2abcf57d61c8cdb8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa088620ef0b6c4ac2abcf57d61c8cdb8">H5Eget_auto</a>   <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936">H5Eget_auto2</a></td></tr>
<tr class="separator:gaa088620ef0b6c4ac2abcf57d61c8cdb8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7e93cb96b399e5853721258872435a8" id="r_gaa7e93cb96b399e5853721258872435a8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa7e93cb96b399e5853721258872435a8">H5Eprint</a>   <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56">H5Eprint2</a></td></tr>
<tr class="separator:gaa7e93cb96b399e5853721258872435a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4a7d9ca6b4f7bf521d29c85bbc5b7941" id="r_ga4a7d9ca6b4f7bf521d29c85bbc5b7941"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4a7d9ca6b4f7bf521d29c85bbc5b7941">H5Epush</a>   <a class="el" href="#ga17c2790837a1c1ea7e56b65d3c00a920">H5Epush2</a></td></tr>
<tr class="separator:ga4a7d9ca6b4f7bf521d29c85bbc5b7941"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga245383d63fba5c4282ce8e9ef8488702" id="r_ga245383d63fba5c4282ce8e9ef8488702"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga245383d63fba5c4282ce8e9ef8488702">H5Eset_auto</a>   <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69">H5Eset_auto2</a></td></tr>
<tr class="separator:ga245383d63fba5c4282ce8e9ef8488702"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga565cd6c7b7a197f8954d821419aba0d0" id="r_ga565cd6c7b7a197f8954d821419aba0d0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga565cd6c7b7a197f8954d821419aba0d0">H5Ewalk</a>   <a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655">H5Ewalk2</a></td></tr>
<tr class="separator:ga565cd6c7b7a197f8954d821419aba0d0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga70ecfb35ab871ddb1cd2dfa0ac5f740c" id="r_ga70ecfb35ab871ddb1cd2dfa0ac5f740c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga70ecfb35ab871ddb1cd2dfa0ac5f740c">H5Eregister_class</a> (const char *cls_name, const char *lib_name, const char *version)</td></tr>
<tr class="memdesc:ga70ecfb35ab871ddb1cd2dfa0ac5f740c"><td class="mdescLeft"> </td><td class="mdescRight">Registers a client library or application program to the HDF5 error API. <br /></td></tr>
<tr class="separator:ga70ecfb35ab871ddb1cd2dfa0ac5f740c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0383710d3984d19d3d2006d1151b88a2" id="r_ga0383710d3984d19d3d2006d1151b88a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0383710d3984d19d3d2006d1151b88a2">H5Eunregister_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> class_id)</td></tr>
<tr class="memdesc:ga0383710d3984d19d3d2006d1151b88a2"><td class="mdescLeft"> </td><td class="mdescRight">Removes an error class. <br /></td></tr>
<tr class="separator:ga0383710d3984d19d3d2006d1151b88a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga65b660eb16b25cc008585ba8990e8b15" id="r_ga65b660eb16b25cc008585ba8990e8b15"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga65b660eb16b25cc008585ba8990e8b15">H5Eclose_msg</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_id)</td></tr>
<tr class="memdesc:ga65b660eb16b25cc008585ba8990e8b15"><td class="mdescLeft"> </td><td class="mdescRight">Closes an error message. <br /></td></tr>
<tr class="separator:ga65b660eb16b25cc008585ba8990e8b15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga99a705d98873dcdd1bb6f9d5eebc5afd" id="r_ga99a705d98873dcdd1bb6f9d5eebc5afd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga99a705d98873dcdd1bb6f9d5eebc5afd">H5Ecreate_msg</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cls, <a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3c">H5E_type_t</a> msg_type, const char *msg)</td></tr>
<tr class="memdesc:ga99a705d98873dcdd1bb6f9d5eebc5afd"><td class="mdescLeft"> </td><td class="mdescRight">Adds a major or minor error message to an error class. <br /></td></tr>
<tr class="separator:ga99a705d98873dcdd1bb6f9d5eebc5afd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8bfca811dc01e97b4ab0736dd8775b39" id="r_ga8bfca811dc01e97b4ab0736dd8775b39"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8bfca811dc01e97b4ab0736dd8775b39">H5Ecreate_stack</a> (void)</td></tr>
<tr class="memdesc:ga8bfca811dc01e97b4ab0736dd8775b39"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new, empty error stack. <br /></td></tr>
<tr class="separator:ga8bfca811dc01e97b4ab0736dd8775b39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac66c0955a6d821a472a3a408cdc95ae6" id="r_gac66c0955a6d821a472a3a408cdc95ae6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac66c0955a6d821a472a3a408cdc95ae6">H5Eget_current_stack</a> (void)</td></tr>
<tr class="memdesc:gac66c0955a6d821a472a3a408cdc95ae6"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of the current error stack. <br /></td></tr>
<tr class="separator:gac66c0955a6d821a472a3a408cdc95ae6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa35a1b27d704a90f2a933f9d41df35ec" id="r_gaa35a1b27d704a90f2a933f9d41df35ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa35a1b27d704a90f2a933f9d41df35ec">H5Eappend_stack</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_stack_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_stack_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> close_source_stack)</td></tr>
<tr class="memdesc:gaa35a1b27d704a90f2a933f9d41df35ec"><td class="mdescLeft"> </td><td class="mdescRight">Appends one error stack to another, optionally closing the source stack. <br /></td></tr>
<tr class="separator:gaa35a1b27d704a90f2a933f9d41df35ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga41c2ed13fd6aac6e413fe7383b9090fa" id="r_ga41c2ed13fd6aac6e413fe7383b9090fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga41c2ed13fd6aac6e413fe7383b9090fa">H5Eclose_stack</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> stack_id)</td></tr>
<tr class="memdesc:ga41c2ed13fd6aac6e413fe7383b9090fa"><td class="mdescLeft"> </td><td class="mdescRight">Closes an error stack handle. <br /></td></tr>
<tr class="separator:ga41c2ed13fd6aac6e413fe7383b9090fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf360b8e61728b421ee78438e4f57a001" id="r_gaf360b8e61728b421ee78438e4f57a001"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf360b8e61728b421ee78438e4f57a001">H5Eget_class_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> class_id, char *name, size_t size)</td></tr>
<tr class="memdesc:gaf360b8e61728b421ee78438e4f57a001"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves error class name. <br /></td></tr>
<tr class="separator:gaf360b8e61728b421ee78438e4f57a001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga155715dd456c2b62a0b567e970af3473" id="r_ga155715dd456c2b62a0b567e970af3473"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga155715dd456c2b62a0b567e970af3473">H5Eset_current_stack</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack_id)</td></tr>
<tr class="memdesc:ga155715dd456c2b62a0b567e970af3473"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the current error stack. <br /></td></tr>
<tr class="separator:ga155715dd456c2b62a0b567e970af3473"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga17c2790837a1c1ea7e56b65d3c00a920" id="r_ga17c2790837a1c1ea7e56b65d3c00a920"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga17c2790837a1c1ea7e56b65d3c00a920">H5Epush2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack, const char *file, const char *func, unsigned line, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cls_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> maj_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> min_id, const char *msg,...)</td></tr>
<tr class="memdesc:ga17c2790837a1c1ea7e56b65d3c00a920"><td class="mdescLeft"> </td><td class="mdescRight">Pushes a new error record onto an error stack. <br /></td></tr>
<tr class="separator:ga17c2790837a1c1ea7e56b65d3c00a920"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga818569ac92695fb1a7836c2389faa2ba" id="r_ga818569ac92695fb1a7836c2389faa2ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga818569ac92695fb1a7836c2389faa2ba">H5Epop</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack, size_t count)</td></tr>
<tr class="memdesc:ga818569ac92695fb1a7836c2389faa2ba"><td class="mdescLeft"> </td><td class="mdescRight">Deletes specified number of error messages from the error stack. <br /></td></tr>
<tr class="separator:ga818569ac92695fb1a7836c2389faa2ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae86ab32e85028412c731cf0f2b8d1f56" id="r_gae86ab32e85028412c731cf0f2b8d1f56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56">H5Eprint2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack, FILE *stream)</td></tr>
<tr class="memdesc:gae86ab32e85028412c731cf0f2b8d1f56"><td class="mdescLeft"> </td><td class="mdescRight">Prints the specified error stack in a default manner. <br /></td></tr>
<tr class="separator:gae86ab32e85028412c731cf0f2b8d1f56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ecc0f6a1ea5bb821373a5a7b8070655" id="r_ga4ecc0f6a1ea5bb821373a5a7b8070655"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655">H5Ewalk2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack, <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813">H5E_direction_t</a> direction, <a class="el" href="_h5_epublic_8h.html#aa0fc6445c613e4159a17d28ca61be825">H5E_walk2_t</a> func, void *client_data)</td></tr>
<tr class="memdesc:ga4ecc0f6a1ea5bb821373a5a7b8070655"><td class="mdescLeft"> </td><td class="mdescRight">Walks the specified error stack, calling the specified function. <br /></td></tr>
<tr class="separator:ga4ecc0f6a1ea5bb821373a5a7b8070655"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2eda33cbadd9be5bfddbaa91e863c936" id="r_ga2eda33cbadd9be5bfddbaa91e863c936"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936">H5Eget_auto2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> estack_id, <a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca">H5E_auto2_t</a> *func, void **client_data)</td></tr>
<tr class="memdesc:ga2eda33cbadd9be5bfddbaa91e863c936"><td class="mdescLeft"> </td><td class="mdescRight">Returns the settings for the automatic error stack traversal function and its data. <br /></td></tr>
<tr class="separator:ga2eda33cbadd9be5bfddbaa91e863c936"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0d6b18cd5160517fe5165b9a8443c69" id="r_gaf0d6b18cd5160517fe5165b9a8443c69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69">H5Eset_auto2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> estack_id, <a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca">H5E_auto2_t</a> func, void *client_data)</td></tr>
<tr class="memdesc:gaf0d6b18cd5160517fe5165b9a8443c69"><td class="mdescLeft"> </td><td class="mdescRight">Turns automatic error printing on or off. <br /></td></tr>
<tr class="separator:gaf0d6b18cd5160517fe5165b9a8443c69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac9d90679c7879f3c4ebce858aaa9dfb2" id="r_gac9d90679c7879f3c4ebce858aaa9dfb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac9d90679c7879f3c4ebce858aaa9dfb2">H5Eclear2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack)</td></tr>
<tr class="memdesc:gac9d90679c7879f3c4ebce858aaa9dfb2"><td class="mdescLeft"> </td><td class="mdescRight">Clears the specified error stack or the error stack for the current thread. <br /></td></tr>
<tr class="separator:gac9d90679c7879f3c4ebce858aaa9dfb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga031740bbe952c10272f7e43b87565d2f" id="r_ga031740bbe952c10272f7e43b87565d2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga031740bbe952c10272f7e43b87565d2f">H5Eauto_is_v2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> err_stack, unsigned *is_stack)</td></tr>
<tr class="memdesc:ga031740bbe952c10272f7e43b87565d2f"><td class="mdescLeft"> </td><td class="mdescRight">Determines the type of error stack. <br /></td></tr>
<tr class="separator:ga031740bbe952c10272f7e43b87565d2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64714effca13c23c4f95529256621fa0" id="r_ga64714effca13c23c4f95529256621fa0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga64714effca13c23c4f95529256621fa0">H5Eget_msg</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> msg_id, <a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3c">H5E_type_t</a> *type, char *msg, size_t size)</td></tr>
<tr class="memdesc:ga64714effca13c23c4f95529256621fa0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves an error message. <br /></td></tr>
<tr class="separator:ga64714effca13c23c4f95529256621fa0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c42673e2059c385a95ce3c597e0756d" id="r_ga5c42673e2059c385a95ce3c597e0756d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5c42673e2059c385a95ce3c597e0756d">H5Eget_num</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> error_stack_id)</td></tr>
<tr class="memdesc:ga5c42673e2059c385a95ce3c597e0756d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the number of error messages in an error stack. <br /></td></tr>
<tr class="separator:ga5c42673e2059c385a95ce3c597e0756d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f2ee26cbe35c5dde49d615fc31ea2f6" id="r_ga0f2ee26cbe35c5dde49d615fc31ea2f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0f2ee26cbe35c5dde49d615fc31ea2f6">H5Eclear1</a> (void)</td></tr>
<tr class="memdesc:ga0f2ee26cbe35c5dde49d615fc31ea2f6"><td class="mdescLeft"> </td><td class="mdescRight">Clears the error stack for the current thread. <br /></td></tr>
<tr class="separator:ga0f2ee26cbe35c5dde49d615fc31ea2f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ca4dd7ed560882a7da176a0e2325707" id="r_ga0ca4dd7ed560882a7da176a0e2325707"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707">H5Eget_auto1</a> (<a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e">H5E_auto1_t</a> *func, void **client_data)</td></tr>
<tr class="memdesc:ga0ca4dd7ed560882a7da176a0e2325707"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current settings for the automatic error stack traversal function and its data. <br /></td></tr>
<tr class="separator:ga0ca4dd7ed560882a7da176a0e2325707"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7e2d223ad3bf68fe35f343b97edf0e92" id="r_ga7e2d223ad3bf68fe35f343b97edf0e92"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7e2d223ad3bf68fe35f343b97edf0e92">H5Epush1</a> (const char *file, const char *func, unsigned line, <a class="el" href="_h5_epublic_8h.html#a8b643ee74952ccb3b401eb97407070a8">H5E_major_t</a> maj, <a class="el" href="_h5_epublic_8h.html#a6a5b9e5fcbb4cf4cdc5d347e34d4af0a">H5E_minor_t</a> min, const char *str)</td></tr>
<tr class="memdesc:ga7e2d223ad3bf68fe35f343b97edf0e92"><td class="mdescLeft"> </td><td class="mdescRight">Pushes a new error record onto the error stack. <br /></td></tr>
<tr class="separator:ga7e2d223ad3bf68fe35f343b97edf0e92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c71eb8e5b7261668e2e8926f1822365" id="r_ga9c71eb8e5b7261668e2e8926f1822365"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365">H5Eprint1</a> (FILE *stream)</td></tr>
<tr class="memdesc:ga9c71eb8e5b7261668e2e8926f1822365"><td class="mdescLeft"> </td><td class="mdescRight">Prints the current error stack in a default manner. <br /></td></tr>
<tr class="separator:ga9c71eb8e5b7261668e2e8926f1822365"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab7e1c2db4a0811b70227833b5462eea8" id="r_gab7e1c2db4a0811b70227833b5462eea8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8">H5Eset_auto1</a> (<a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e">H5E_auto1_t</a> func, void *client_data)</td></tr>
<tr class="memdesc:gab7e1c2db4a0811b70227833b5462eea8"><td class="mdescLeft"> </td><td class="mdescRight">Turns automatic error printing on or off. <br /></td></tr>
<tr class="separator:gab7e1c2db4a0811b70227833b5462eea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d54a0f62f9ea625bdeab8e5e0c894c4" id="r_ga8d54a0f62f9ea625bdeab8e5e0c894c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4">H5Ewalk1</a> (<a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813">H5E_direction_t</a> direction, <a class="el" href="_h5_epublic_8h.html#a2088c033647027f76172116e2da33293">H5E_walk1_t</a> func, void *client_data)</td></tr>
<tr class="memdesc:ga8d54a0f62f9ea625bdeab8e5e0c894c4"><td class="mdescLeft"> </td><td class="mdescRight">Walks the current error stack, calling the specified function. <br /></td></tr>
<tr class="separator:ga8d54a0f62f9ea625bdeab8e5e0c894c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91fa7fb56da6f08f9c293a6ce89c7819" id="r_ga91fa7fb56da6f08f9c293a6ce89c7819"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga91fa7fb56da6f08f9c293a6ce89c7819">H5Eget_major</a> (<a class="el" href="_h5_epublic_8h.html#a8b643ee74952ccb3b401eb97407070a8">H5E_major_t</a> maj)</td></tr>
<tr class="memdesc:ga91fa7fb56da6f08f9c293a6ce89c7819"><td class="mdescLeft"> </td><td class="mdescRight">Returns a character string describing an error specified by a major error number. <br /></td></tr>
<tr class="separator:ga91fa7fb56da6f08f9c293a6ce89c7819"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4975325db13bc5cf44d72d4ef0394034" id="r_ga4975325db13bc5cf44d72d4ef0394034"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4975325db13bc5cf44d72d4ef0394034">H5Eget_minor</a> (<a class="el" href="_h5_epublic_8h.html#a6a5b9e5fcbb4cf4cdc5d347e34d4af0a">H5E_minor_t</a> min)</td></tr>
<tr class="memdesc:ga4975325db13bc5cf44d72d4ef0394034"><td class="mdescLeft"> </td><td class="mdescRight">Returns a character string describing an error specified by a minor error number. <br /></td></tr>
<tr class="separator:ga4975325db13bc5cf44d72d4ef0394034"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaa088620ef0b6c4ac2abcf57d61c8cdb8" name="gaa088620ef0b6c4ac2abcf57d61c8cdb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa088620ef0b6c4ac2abcf57d61c8cdb8">◆ </a></span>H5Eget_auto</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Eget_auto   <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936">H5Eget_auto2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#gaa088620ef0b6c4ac2abcf57d61c8cdb8">H5Eget_auto()</a> is a macro that is mapped to either <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> or <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="gaa7e93cb96b399e5853721258872435a8" name="gaa7e93cb96b399e5853721258872435a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7e93cb96b399e5853721258872435a8">◆ </a></span>H5Eprint</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Eprint   <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56">H5Eprint2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#gaa7e93cb96b399e5853721258872435a8">H5Eprint()</a> is a macro that is mapped to either <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="ga4a7d9ca6b4f7bf521d29c85bbc5b7941" name="ga4a7d9ca6b4f7bf521d29c85bbc5b7941"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4a7d9ca6b4f7bf521d29c85bbc5b7941">◆ </a></span>H5Epush</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Epush   <a class="el" href="#ga17c2790837a1c1ea7e56b65d3c00a920">H5Epush2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga4a7d9ca6b4f7bf521d29c85bbc5b7941">H5Epush()</a> is a macro that is mapped to either <a class="el" href="#ga7e2d223ad3bf68fe35f343b97edf0e92" title="Pushes a new error record onto the error stack.">H5Epush1()</a> or <a class="el" href="#ga17c2790837a1c1ea7e56b65d3c00a920" title="Pushes a new error record onto an error stack.">H5Epush2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="ga245383d63fba5c4282ce8e9ef8488702" name="ga245383d63fba5c4282ce8e9ef8488702"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga245383d63fba5c4282ce8e9ef8488702">◆ </a></span>H5Eset_auto</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Eset_auto   <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69">H5Eset_auto2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga245383d63fba5c4282ce8e9ef8488702">H5Eset_auto()</a> is a macro that is mapped to either <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> or <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="ga565cd6c7b7a197f8954d821419aba0d0" name="ga565cd6c7b7a197f8954d821419aba0d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga565cd6c7b7a197f8954d821419aba0d0">◆ </a></span>H5Ewalk</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Ewalk   <a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655">H5Ewalk2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga565cd6c7b7a197f8954d821419aba0d0">H5Ewalk()</a> is a macro that is mapped to either <a class="el" href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4" title="Walks the current error stack, calling the specified function.">H5Ewalk1()</a> or <a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655" title="Walks the specified error stack, calling the specified function.">H5Ewalk2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa35a1b27d704a90f2a933f9d41df35ec" name="gaa35a1b27d704a90f2a933f9d41df35ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa35a1b27d704a90f2a933f9d41df35ec">◆ </a></span>H5Eappend_stack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eappend_stack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dst_stack_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_stack_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></td> <td class="paramname"><span class="paramname"><em>close_source_stack</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends one error stack to another, optionally closing the source stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dst_stack_id</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_stack_id</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">close_source_stack</td><td>Flag to indicate whether to close the source stack </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaa35a1b27d704a90f2a933f9d41df35ec" title="Appends one error stack to another, optionally closing the source stack.">H5Eappend_stack()</a> appends the messages from error stack <code>src_stack_id</code> to the error stack <code>dst_stack_id</code>. If <code>close_source_stack</code> is <code>true</code>, the source error stack will be closed.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
</div>
</div>
<a id="ga031740bbe952c10272f7e43b87565d2f" name="ga031740bbe952c10272f7e43b87565d2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga031740bbe952c10272f7e43b87565d2f">◆ </a></span>H5Eauto_is_v2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eauto_is_v2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>is_stack</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the type of error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">is_stack</td><td>A flag indicating which error stack <code>typedef</code> the specified error stack conforms to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga031740bbe952c10272f7e43b87565d2f" title="Determines the type of error stack.">H5Eauto_is_v2()</a> determines whether the error auto reporting function for an error stack conforms to the <a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca" title="Callback function for H5Eset_auto2()">H5E_auto2_t</a> <code>typedef</code> or the <a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e" title="Callback function for H5Eset_auto1()">H5E_auto1_t</a> <code>typedef</code>.</p>
<p>The <code>is_stack</code> parameter is set to 1 if the error stack conforms to <a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca" title="Callback function for H5Eset_auto2()">H5E_auto2_t</a> and 0 if it conforms to <a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e" title="Callback function for H5Eset_auto1()">H5E_auto1_t</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0f2ee26cbe35c5dde49d615fc31ea2f6" name="ga0f2ee26cbe35c5dde49d615fc31ea2f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0f2ee26cbe35c5dde49d615fc31ea2f6">◆ </a></span>H5Eclear1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eclear1 </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the error stack for the current thread. </p>
<hr />
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="_h5version_8h.html#ac4c79bee16d0ffe8a6017bfdb66c9916">H5Eclear()</a> renamed to <a class="el" href="#ga0f2ee26cbe35c5dde49d615fc31ea2f6" title="Clears the error stack for the current thread.">H5Eclear1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#ga0f2ee26cbe35c5dde49d615fc31ea2f6" title="Clears the error stack for the current thread.">H5Eclear1()</a> clears the error stack for the current thread.<br />
The stack is also cleared whenever an API function is called, with certain exceptions (for instance, <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a>).</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gac9d90679c7879f3c4ebce858aaa9dfb2" name="gac9d90679c7879f3c4ebce858aaa9dfb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac9d90679c7879f3c4ebce858aaa9dfb2">◆ </a></span>H5Eclear2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eclear2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the specified error stack or the error stack for the current thread. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gac9d90679c7879f3c4ebce858aaa9dfb2" title="Clears the specified error stack or the error stack for the current thread.">H5Eclear2()</a> clears the error stack specified by <code>err_stack</code>, or, if <code>err_stack</code> is set to <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a>, the error stack for the current thread.</p>
<p><code>err_stack</code> is an error stack identifier, such as that returned by <a class="el" href="#gac66c0955a6d821a472a3a408cdc95ae6" title="Returns a copy of the current error stack.">H5Eget_current_stack()</a>.</p>
<p>The current error stack is also cleared whenever an API function is called, with certain exceptions (for instance, <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>).</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga65b660eb16b25cc008585ba8990e8b15" name="ga65b660eb16b25cc008585ba8990e8b15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65b660eb16b25cc008585ba8990e8b15">◆ </a></span>H5Eclose_msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eclose_msg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes an error message. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_id</td><td>An error message identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga65b660eb16b25cc008585ba8990e8b15" title="Closes an error message.">H5Eclose_msg()</a> closes an error message identifier, which can be either a major or minor message.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga41c2ed13fd6aac6e413fe7383b9090fa" name="ga41c2ed13fd6aac6e413fe7383b9090fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga41c2ed13fd6aac6e413fe7383b9090fa">◆ </a></span>H5Eclose_stack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eclose_stack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>stack_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes an error stack handle. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stack_id</td><td>Error stack identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga41c2ed13fd6aac6e413fe7383b9090fa" title="Closes an error stack handle.">H5Eclose_stack()</a> closes the error stack handle <code>stack_id</code> and releases its resources. <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a> cannot be closed.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga99a705d98873dcdd1bb6f9d5eebc5afd" name="ga99a705d98873dcdd1bb6f9d5eebc5afd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga99a705d98873dcdd1bb6f9d5eebc5afd">◆ </a></span>H5Ecreate_msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Ecreate_msg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>cls</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3c">H5E_type_t</a></td> <td class="paramname"><span class="paramname"><em>msg_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>msg</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a major or minor error message to an error class. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cls</td><td>An error class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg_type</td><td>The type of the error message </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error message </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An error ID (success), H5I_INVALID_HID (failure)</dd></dl>
<p><a class="el" href="#ga99a705d98873dcdd1bb6f9d5eebc5afd" title="Adds a major or minor error message to an error class.">H5Ecreate_msg()</a> adds an error message to an error class defined by client library or application program. The error message can be either major or minor as indicated by the parameter <code>msg_type</code>.</p>
<p>Use <a class="el" href="#ga65b660eb16b25cc008585ba8990e8b15" title="Closes an error message.">H5Eclose_msg()</a> to close the message identifier returned by this function.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga8bfca811dc01e97b4ab0736dd8775b39" name="ga8bfca811dc01e97b4ab0736dd8775b39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8bfca811dc01e97b4ab0736dd8775b39">◆ </a></span>H5Ecreate_stack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Ecreate_stack </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new, empty error stack. </p>
<hr />
<dl class="section return"><dt>Returns</dt><dd>Returns an error stack identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga8bfca811dc01e97b4ab0736dd8775b39" title="Creates a new, empty error stack.">H5Ecreate_stack()</a> creates a new empty error stack and returns the new stack's identifier. Use <a class="el" href="#ga41c2ed13fd6aac6e413fe7383b9090fa" title="Closes an error stack handle.">H5Eclose_stack()</a> to close the error stack identifier returned by this function.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0ca4dd7ed560882a7da176a0e2325707" name="ga0ca4dd7ed560882a7da176a0e2325707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ca4dd7ed560882a7da176a0e2325707">◆ </a></span>H5Eget_auto1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eget_auto1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e">H5E_auto1_t</a> *</td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current settings for the automatic error stack traversal function and its data. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">func</td><td>Current setting for the function to be called upon an error condition </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">client_data</td><td>Current setting for the data passed to the error function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000020">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="#gaa088620ef0b6c4ac2abcf57d61c8cdb8">H5Eget_auto()</a> renamed to <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> returns the current settings for the automatic error stack traversal function, <code>func</code>, and its data, <code>client_data</code>. Either or both arguments may be <code>NULL</code>, in which case the value is not returned.</p>
<p>The library initializes its default error stack traversal functions to <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> and <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>. A call to <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> returns <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a> or the user-defined function passed in through <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a>. A call to <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> returns <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or the user-defined function passed in through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>. However, if the application passes in a user-defined function through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>, it should call <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> to query the traversal function. If the application passes in a user-defined function through <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a>, it should call <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> to query the traversal function.</p>
<p>Mixing the new style and the old style functions will cause a failure. For example, if the application sets a user-defined old-style traversal function through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>, a call to <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> will fail and will indicate that the application has mixed <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> and <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a>. On the other hand, mixing <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> and <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> will also cause a failure. But if the traversal functions are the library's default <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>, mixing <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> and <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> or mixing <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> and <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> does not fail.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga2eda33cbadd9be5bfddbaa91e863c936" name="ga2eda33cbadd9be5bfddbaa91e863c936"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2eda33cbadd9be5bfddbaa91e863c936">◆ </a></span>H5Eget_auto2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eget_auto2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>estack_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca">H5E_auto2_t</a> *</td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the settings for the automatic error stack traversal function and its data. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">estack_id</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">func</td><td>The function currently set to be called upon an error condition </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">client_data</td><td>Data currently set to be passed to the error function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> returns the settings for the automatic error stack traversal function, <code>func</code>, and its data, <code>client_data</code>, that are associated with the error stack specified by <code>estack_id</code>.</p>
<p>Either or both of the <code>func</code> and <code>client_data</code> arguments may be <code>NULL</code>, in which case the value is not returned.</p>
<p>The library initializes its default error stack traversal functions to <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> and <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>. A call to <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> returns <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a> or the user-defined function passed in through <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a>. A call to <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> returns <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or the user-defined function passed in through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>. However, if the application passes in a user-defined function through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>, it should call <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> to query the traversal function. If the application passes in a user-defined function through <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a>, it should call <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> to query the traversal function.</p>
<p>Mixing the new style and the old style functions will cause a failure. For example, if the application sets a user-defined old-style traversal function through <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a>, a call to <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> will fail and will indicate that the application has mixed <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> and <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a>. On the other hand, mixing <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> and <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> will also cause a failure. But if the traversal functions are the library's default <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> or <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a>, mixing <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> and <a class="el" href="#ga2eda33cbadd9be5bfddbaa91e863c936" title="Returns the settings for the automatic error stack traversal function and its data.">H5Eget_auto2()</a> or mixing <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> and <a class="el" href="#ga0ca4dd7ed560882a7da176a0e2325707" title="Returns the current settings for the automatic error stack traversal function and its data.">H5Eget_auto1()</a> does not fail.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaf360b8e61728b421ee78438e4f57a001" name="gaf360b8e61728b421ee78438e4f57a001"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf360b8e61728b421ee78438e4f57a001">◆ </a></span>H5Eget_class_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Eget_class_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>class_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves error class name. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">class_id</td><td>Error class identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Buffer for the error class name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The maximum number of characters of the class name to be returned by this function in <code>name</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns non-negative value as on success; otherwise returns negative value.</dd></dl>
<p><a class="el" href="#gaf360b8e61728b421ee78438e4f57a001" title="Retrieves error class name.">H5Eget_class_name()</a> retrieves the name of the error class specified by the class identifier. If a non-NULL pointer is passed in for <code>name</code> and <code>size</code> is greater than zero, the class name of <code>size</code> long is returned. The length of the error class name is also returned. If NULL is passed in as <code>name</code>, only the length of class name is returned. If zero is returned, it means no name. The user is responsible for allocating sufficient buffer space for the name.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gac66c0955a6d821a472a3a408cdc95ae6" name="gac66c0955a6d821a472a3a408cdc95ae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac66c0955a6d821a472a3a408cdc95ae6">◆ </a></span>H5Eget_current_stack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Eget_current_stack </td>
<td>(</td>
<td class="paramtype">void</td> <td class="paramname"><span class="paramname"></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of the current error stack. </p>
<hr />
<dl class="section return"><dt>Returns</dt><dd>Returns an error stack identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#gac66c0955a6d821a472a3a408cdc95ae6" title="Returns a copy of the current error stack.">H5Eget_current_stack()</a> copies the current error stack and returns an error stack identifier for the new copy.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga91fa7fb56da6f08f9c293a6ce89c7819" name="ga91fa7fb56da6f08f9c293a6ce89c7819"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga91fa7fb56da6f08f9c293a6ce89c7819">◆ </a></span>H5Eget_major()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * H5Eget_major </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a8b643ee74952ccb3b401eb97407070a8">H5E_major_t</a></td> <td class="paramname"><span class="paramname"><em>maj</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a character string describing an error specified by a major error number. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">maj</td><td>Major error number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the message (success), or NULL (failure)</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000025">Deprecated</a></b></dt><dd>1.8.0 Function deprecated in this release.</dd></dl>
<p><a class="el" href="#ga91fa7fb56da6f08f9c293a6ce89c7819" title="Returns a character string describing an error specified by a major error number.">H5Eget_major()</a> returns a constant character string that describes the error, given a major error number.</p>
<dl class="section attention"><dt>Attention</dt><dd>This function returns a dynamically allocated string (<code>char</code> array). An application calling this function must free the memory associated with the return value to prevent a memory leak.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga4975325db13bc5cf44d72d4ef0394034" name="ga4975325db13bc5cf44d72d4ef0394034"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4975325db13bc5cf44d72d4ef0394034">◆ </a></span>H5Eget_minor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * H5Eget_minor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a6a5b9e5fcbb4cf4cdc5d347e34d4af0a">H5E_minor_t</a></td> <td class="paramname"><span class="paramname"><em>min</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a character string describing an error specified by a minor error number. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>Minor error number </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the message (success), or NULL (failure)</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000026">Deprecated</a></b></dt><dd>1.8.0 Function deprecated and return type changed in this release.</dd></dl>
<p><a class="el" href="#ga4975325db13bc5cf44d72d4ef0394034" title="Returns a character string describing an error specified by a minor error number.">H5Eget_minor()</a> returns a constant character string that describes the error, given a minor error number.</p>
<dl class="section attention"><dt>Attention</dt><dd>In the Release 1.8.x series, <a class="el" href="#ga4975325db13bc5cf44d72d4ef0394034" title="Returns a character string describing an error specified by a minor error number.">H5Eget_minor()</a> returns a string of dynamic allocated <code>char</code> array. An application calling this function from an HDF5 library of Release 1.8.0 or later must free the memory associated with the return value to prevent a memory leak. This is a change from the 1.6.x release series.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga64714effca13c23c4f95529256621fa0" name="ga64714effca13c23c4f95529256621fa0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64714effca13c23c4f95529256621fa0">◆ </a></span>H5Eget_msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Eget_msg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>msg_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3c">H5E_type_t</a> *</td> <td class="paramname"><span class="paramname"><em>type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>msg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves an error message. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg_id</td><td>Error message identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>The type of the error message. Valid values are <a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3cab0e1bfd4dab03f69f9a884e9079d3acc">H5E_MAJOR</a> and <a class="el" href="_h5_epublic_8h.html#a415162f1ce9b31241977d0a5857caa3caabc45a68c0f04871387677c099abb338">H5E_MINOR</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Error message buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The length of error message to be returned by this function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the size of the error message in bytes on success; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga64714effca13c23c4f95529256621fa0" title="Retrieves an error message.">H5Eget_msg()</a> retrieves the error message including its length and type. The error message is specified by <code>msg_id</code>. The user is responsible for passing in sufficient buffer space for the message. If <code>msg</code> is not NULL and <code>size</code> is greater than zero, the error message of <code>size</code> long is returned. The length of the message is also returned. If NULL is passed in as <code>msg</code>, only the length and type of the message is returned. If the return value is zero, it means there is no message.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga5c42673e2059c385a95ce3c597e0756d" name="ga5c42673e2059c385a95ce3c597e0756d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c42673e2059c385a95ce3c597e0756d">◆ </a></span>H5Eget_num()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Eget_num </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>error_stack_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the number of error messages in an error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">error_stack_id</td><td>Error stack identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns number of error messages in an error stack on success; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga5c42673e2059c385a95ce3c597e0756d" title="Retrieves the number of error messages in an error stack.">H5Eget_num()</a> retrieves the number of error records in the error stack specified by <code>error_stack_id</code> (including major, minor messages and description).</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga818569ac92695fb1a7836c2389faa2ba" name="ga818569ac92695fb1a7836c2389faa2ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga818569ac92695fb1a7836c2389faa2ba">◆ </a></span>H5Epop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Epop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>count</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes specified number of error messages from the error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>The number of error messages to be deleted from the top of error stack </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga818569ac92695fb1a7836c2389faa2ba" title="Deletes specified number of error messages from the error stack.">H5Epop()</a> deletes the number of error records specified in <code>count</code> from the top of the error stack specified by <code>err_stack</code> (including major, minor messages and description). The number of error messages to be deleted is specified by <code>count</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga9c71eb8e5b7261668e2e8926f1822365" name="ga9c71eb8e5b7261668e2e8926f1822365"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c71eb8e5b7261668e2e8926f1822365">◆ </a></span>H5Eprint1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eprint1 </td>
<td>(</td>
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>stream</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints the current error stack in a default manner. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>File pointer, or <code>NULL</code> for <code>stderr</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000022">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="#gaa7e93cb96b399e5853721258872435a8">H5Eprint()</a> renamed to <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> prints the error stack for the current thread on the specified stream, <code>stream</code>. Even if the error stack is empty, a one-line message of the following form will be printed: </p><div class="fragment"><div class="line">HDF5-DIAG: Error detected in thread 0.</div>
</div><!-- fragment --><p> <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> is a convenience function for <a class="el" href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4" title="Walks the current error stack, calling the specified function.">H5Ewalk1()</a> with a function that prints error messages. Users are encouraged to write their own more specific error handlers.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gae86ab32e85028412c731cf0f2b8d1f56" name="gae86ab32e85028412c731cf0f2b8d1f56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae86ab32e85028412c731cf0f2b8d1f56">◆ </a></span>H5Eprint2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eprint2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE *</td> <td class="paramname"><span class="paramname"><em>stream</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Prints the specified error stack in a default manner. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">stream</td><td>File pointer, or <code>NULL</code> for <code>stderr</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a> prints the error stack specified by <code>err_stack</code> on the specified stream, <code>stream</code>. Even if the error stack is empty, a one-line message of the following form will be printed: </p><div class="fragment"><div class="line">HDF5-DIAG: Error detected in HDF5 library version: 1.5.62 thread 0.</div>
</div><!-- fragment --><p>A similar line will appear before the error messages of each error class stating the library name, library version number, and thread identifier.</p>
<p>If <code>err_stack</code> is <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a>, the current error stack will be printed.</p>
<p><a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a> is a convenience function for <a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655" title="Walks the specified error stack, calling the specified function.">H5Ewalk2()</a> with a function that prints error messages. Users are encouraged to write their own more specific error handlers.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga7e2d223ad3bf68fe35f343b97edf0e92" name="ga7e2d223ad3bf68fe35f343b97edf0e92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7e2d223ad3bf68fe35f343b97edf0e92">◆ </a></span>H5Epush1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Epush1 </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>line</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a8b643ee74952ccb3b401eb97407070a8">H5E_major_t</a></td> <td class="paramname"><span class="paramname"><em>maj</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a6a5b9e5fcbb4cf4cdc5d347e34d4af0a">H5E_minor_t</a></td> <td class="paramname"><span class="paramname"><em>min</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>str</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a new error record onto the error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Name of the file in which the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Name of the function in which the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line number in the file where the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maj</td><td>Major error identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">min</td><td>Minor error identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>Error description string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000021">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="#ga4a7d9ca6b4f7bf521d29c85bbc5b7941">H5Epush()</a> renamed to <a class="el" href="#ga7e2d223ad3bf68fe35f343b97edf0e92" title="Pushes a new error record onto the error stack.">H5Epush1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#ga7e2d223ad3bf68fe35f343b97edf0e92" title="Pushes a new error record onto the error stack.">H5Epush1()</a> pushes a new error record onto the error stack for the current thread.<br />
The error has major and minor numbers <code>maj_num</code> and <code>min_num</code>, the function <code>func</code> where the error was detected, the name of the file <code>file</code> where the error was detected, the line <code>line</code> within that file, and an error description string <code>str</code>.<br />
The function name, filename, and error description strings must be statically allocated.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga17c2790837a1c1ea7e56b65d3c00a920" name="ga17c2790837a1c1ea7e56b65d3c00a920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17c2790837a1c1ea7e56b65d3c00a920">◆ </a></span>H5Epush2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Epush2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>line</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>cls_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>maj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>min_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>msg</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>...</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pushes a new error record onto an error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier. If the identifier is <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a>, the error record will be pushed to the current stack. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>Name of the file in which the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Name of the function in which the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line number in the file where the error was detected </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cls_id</td><td>Error class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">maj_id</td><td>Major error identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">min_id</td><td>Minor error identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>Error description string </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga17c2790837a1c1ea7e56b65d3c00a920" title="Pushes a new error record onto an error stack.">H5Epush2()</a> pushes a new error record onto the error stack specified by <code>err_stack</code>.<br />
The error record contains the error class identifier <code>cls_id</code>, the major and minor message identifiers <code>maj_id</code> and <code>min_id</code>, the function name <code>func</code> where the error was detected, the file name <code>file</code> and line number <code>line</code> in the file where the error was detected, and an error description <code>msg</code>.<br />
The major and minor errors must be in the same error class.<br />
The function name, filename, and error description strings must be statically allocated.<br />
<code>msg</code> can be a format control string with additional arguments. This design of appending additional arguments is similar to the system and C functions printf() and fprintf().</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga70ecfb35ab871ddb1cd2dfa0ac5f740c" name="ga70ecfb35ab871ddb1cd2dfa0ac5f740c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70ecfb35ab871ddb1cd2dfa0ac5f740c">◆ </a></span>H5Eregister_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Eregister_class </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>cls_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>lib_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>version</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a client library or application program to the HDF5 error API. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cls_name</td><td>Name of the error class </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lib_name</td><td>Name of the client library or application to which the error class belongs </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">version</td><td>Version of the client library or application to which the error class belongs. It can be <code>NULL</code>. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a class identifier on success; otherwise returns H5I_INVALID_ID.</dd></dl>
<p><a class="el" href="#ga70ecfb35ab871ddb1cd2dfa0ac5f740c" title="Registers a client library or application program to the HDF5 error API.">H5Eregister_class()</a> registers a client library or application program to the HDF5 error API so that the client library or application program can report errors together with the HDF5 library. It receives an identifier for this error class for further error operations. The library name and version number will be printed out in the error message as a preamble.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gab7e1c2db4a0811b70227833b5462eea8" name="gab7e1c2db4a0811b70227833b5462eea8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab7e1c2db4a0811b70227833b5462eea8">◆ </a></span>H5Eset_auto1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eset_auto1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e">H5E_auto1_t</a></td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Turns automatic error printing on or off. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function to be called upon an error condition </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">client_data</td><td>Data passed to the error function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000023">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="#ga245383d63fba5c4282ce8e9ef8488702">H5Eset_auto()</a> renamed to <a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#gab7e1c2db4a0811b70227833b5462eea8" title="Turns automatic error printing on or off.">H5Eset_auto1()</a> turns on or off automatic printing of errors. When turned on (non-null <code>func</code> pointer), any API function which returns an error indication will first call <code>func</code>, passing it <code>client_data</code> as an argument.</p>
<p><code>func</code>, a function conforming to the <a class="el" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e" title="Callback function for H5Eset_auto1()">H5E_auto1_t</a> prototype, is defined in the <a class="el" href="_h5_epublic_8h.html">H5Epublic.h</a> source code file as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_epublic_8h.html#a54e242097ba2121788448b37579a107e">H5E_auto1_t</a>)(<span class="keywordtype">void</span> *client_data);</div>
</div><!-- fragment --><p>When the library is first initialized, the auto printing function is set to <a class="el" href="#ga9c71eb8e5b7261668e2e8926f1822365" title="Prints the current error stack in a default manner.">H5Eprint1()</a> (cast appropriately) and <code>client_data</code> is the standard error stream pointer, <code>stderr</code>.</p>
<p>Automatic stack traversal is always in the <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813ab0ba668f408b6c98dade64021973fb49">H5E_WALK_DOWNWARD</a> direction.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gaf0d6b18cd5160517fe5165b9a8443c69" name="gaf0d6b18cd5160517fe5165b9a8443c69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0d6b18cd5160517fe5165b9a8443c69">◆ </a></span>H5Eset_auto2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eset_auto2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>estack_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca">H5E_auto2_t</a></td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Turns automatic error printing on or off. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">estack_id</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function to be called upon an error condition </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">client_data</td><td>Data passed to the error function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> turns on or off automatic printing of errors for the error stack specified with <code>estack_id</code>. An <code>estack_id</code> value of <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a> indicates the current stack.</p>
<p>When automatic printing is turned on, by the use of a non-null <code>func</code> pointer, any API function which returns an error indication will first call <code>func</code>, passing it <code>client_data</code> as an argument.</p>
<p><code>func</code>, a function compliant with the <a class="el" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca" title="Callback function for H5Eset_auto2()">H5E_auto2_t</a> prototype, is defined in the <a class="el" href="_h5_epublic_8h.html">H5Epublic.h</a> source code file as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_epublic_8h.html#a0109c84ac574ac24abe6f7c7acab3fca">H5E_auto2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> estack, <span class="keywordtype">void</span> *client_data);</div>
</div><!-- fragment --><p>When the library is first initialized, the auto printing function is set to <a class="el" href="#gae86ab32e85028412c731cf0f2b8d1f56" title="Prints the specified error stack in a default manner.">H5Eprint2()</a> (cast appropriately) and <code>client_data</code> is the standard error stream pointer, <code>stderr</code>.</p>
<p>Automatic stack traversal is always in the <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813ab0ba668f408b6c98dade64021973fb49">H5E_WALK_DOWNWARD</a> direction.</p>
<p>Automatic error printing is turned off with a <a class="el" href="#gaf0d6b18cd5160517fe5165b9a8443c69" title="Turns automatic error printing on or off.">H5Eset_auto2()</a> call with a <code>NULL</code> <code>func</code> pointer.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga155715dd456c2b62a0b567e970af3473" name="ga155715dd456c2b62a0b567e970af3473"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga155715dd456c2b62a0b567e970af3473">◆ </a></span>H5Eset_current_stack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eset_current_stack </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replaces the current error stack. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack_id</td><td>Error stack identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga155715dd456c2b62a0b567e970af3473" title="Replaces the current error stack.">H5Eset_current_stack()</a> replaces the content of the current error stack with a copy of the content of the error stack specified by <code>err_stack_id</code>, and it closes the error stack specified by <code>err_stack_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0383710d3984d19d3d2006d1151b88a2" name="ga0383710d3984d19d3d2006d1151b88a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0383710d3984d19d3d2006d1151b88a2">◆ </a></span>H5Eunregister_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Eunregister_class </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>class_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes an error class. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">class_id</td><td>Error class identifier. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga0383710d3984d19d3d2006d1151b88a2" title="Removes an error class.">H5Eunregister_class()</a> removes the error class specified by <code>class_id</code>. All the major and minor errors in this class will also be closed.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga8d54a0f62f9ea625bdeab8e5e0c894c4" name="ga8d54a0f62f9ea625bdeab8e5e0c894c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4">◆ </a></span>H5Ewalk1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Ewalk1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813">H5E_direction_t</a></td> <td class="paramname"><span class="paramname"><em>direction</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#a2088c033647027f76172116e2da33293">H5E_walk1_t</a></td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Walks the current error stack, calling the specified function. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>Direction in which the error stack is to be walked </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function to be called for each error encountered </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">client_data</td><td>Data to be passed to <code>func</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000024">Deprecated</a></b></dt><dd>1.8.0 Function <a class="el" href="#ga565cd6c7b7a197f8954d821419aba0d0">H5Ewalk()</a> renamed to <a class="el" href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4" title="Walks the current error stack, calling the specified function.">H5Ewalk1()</a> and deprecated in this release.</dd></dl>
<p><a class="el" href="#ga8d54a0f62f9ea625bdeab8e5e0c894c4" title="Walks the current error stack, calling the specified function.">H5Ewalk1()</a> walks the error stack for the current thread and calls the function specified in <code>func</code> for each error along the way.</p>
<p><code>direction</code> specifies whether the stack is walked from the inside out or the outside in. A value of <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813abedac175e65559c32551f132a78e1861">H5E_WALK_UPWARD</a> means to begin with the most specific error and end at the API; a value of <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813ab0ba668f408b6c98dade64021973fb49">H5E_WALK_DOWNWARD</a> means to start at the API and end at the innermost function where the error was first detected.</p>
<p><code>func</code>, a function conforming to the <a class="el" href="_h5_epublic_8h.html#a2088c033647027f76172116e2da33293" title="Callback function for H5Ewalk1()">H5E_walk1_t</a> prototype, will be called for each error in the error stack. Its arguments will include an index number <code>n</code> (beginning at zero regardless of stack traversal direction), an error stack entry <code>err_desc</code>, and the <code>client_data</code> pointer passed to <a class="el" href="#gaa7e93cb96b399e5853721258872435a8">H5Eprint()</a>. The <a class="el" href="_h5_epublic_8h.html#a2088c033647027f76172116e2da33293" title="Callback function for H5Ewalk1()">H5E_walk1_t</a> prototype is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_epublic_8h.html#a2088c033647027f76172116e2da33293">H5E_walk1_t</a>)(<span class="keywordtype">int</span> n, <a class="code hl_struct" href="struct_h5_e__error1__t.html">H5E_error1_t</a> *err_desc, <span class="keywordtype">void</span> *client_data);</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga4ecc0f6a1ea5bb821373a5a7b8070655" name="ga4ecc0f6a1ea5bb821373a5a7b8070655"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ecc0f6a1ea5bb821373a5a7b8070655">◆ </a></span>H5Ewalk2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Ewalk2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>err_stack</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813">H5E_direction_t</a></td> <td class="paramname"><span class="paramname"><em>direction</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_epublic_8h.html#aa0fc6445c613e4159a17d28ca61be825">H5E_walk2_t</a></td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>client_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Walks the specified error stack, calling the specified function. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">err_stack</td><td>Error stack identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">direction</td><td>Direction in which the error stack is to be walked </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Function to be called for each error encountered </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">client_data</td><td>Data to be passed to <code>func</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655" title="Walks the specified error stack, calling the specified function.">H5Ewalk2()</a> walks the error stack specified by err_stack for the current thread and calls the function specified in <code>func</code> for each error along the way.</p>
<p>If the value of <code>err_stack</code> is <a class="el" href="_h5_epublic_8h.html#ad7ca07d2b387a59c7e8bcab22fa57455">H5E_DEFAULT</a>, then <a class="el" href="#ga4ecc0f6a1ea5bb821373a5a7b8070655" title="Walks the specified error stack, calling the specified function.">H5Ewalk2()</a> walks the current error stack.</p>
<p><code>direction</code> specifies whether the stack is walked from the inside out or the outside in. A value of <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813abedac175e65559c32551f132a78e1861">H5E_WALK_UPWARD</a> means to begin with the most specific error and end at the API; a value of <a class="el" href="_h5_epublic_8h.html#ae30cff307b364e94ce2d552edbca6813ab0ba668f408b6c98dade64021973fb49">H5E_WALK_DOWNWARD</a> means to start at the API and end at the innermost function where the error was first detected.</p>
<p><code>func</code>, a function conforming to the <a class="el" href="_h5_epublic_8h.html#aa0fc6445c613e4159a17d28ca61be825" title="Callback function for H5Ewalk2()">H5E_walk2_t</a> prototype, will be called for each error in the error stack. Its arguments will include an index number <code>n</code> (beginning at zero regardless of stack traversal direction), an error stack entry <code>err_desc</code>, and the <code>client_data</code> pointer passed to <a class="el" href="#gaa7e93cb96b399e5853721258872435a8">H5Eprint()</a>. The <a class="el" href="_h5_epublic_8h.html#aa0fc6445c613e4159a17d28ca61be825" title="Callback function for H5Ewalk2()">H5E_walk2_t</a> prototype is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_epublic_8h.html#aa0fc6445c613e4159a17d28ca61be825">H5E_walk2_t</a>)(<span class="keywordtype">unsigned</span> n, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_e__error2__t.html">H5E_error2_t</a> *err_desc, <span class="keywordtype">void</span> *client_data);</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
