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
|
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: HDF5 Library Java Interface</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>
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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.aa849f0</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___j_h5.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">HDF5 Library Java Interface</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This class is the Java interface for the HDF5 library.</p>
<p>This code is the called by Java programs to access the entry points of the HDF5 library. Each routine wraps a single HDF5 entry point, generally with the arguments and return codes analogous to the C interface.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classhdf_1_1hdf5lib_1_1_h5.html">H5</a>, C-API</dd>
<dd>
<a class="el" href="_h5__u_g.html">The HDF5 Library and Programming Model</a>, User Guide </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf9c0f205c18b7fbc0f651786181f83a8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gaf9c0f205c18b7fbc0f651786181f83a8">loadH5Lib</a> ()</td></tr>
<tr class="separator:gaf9c0f205c18b7fbc0f651786181f83a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadea4d5366be3ed84b465c30646bf55a8"><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gadea4d5366be3ed84b465c30646bf55a8">getOpenIDCount</a> ()</td></tr>
<tr class="separator:gadea4d5366be3ed84b465c30646bf55a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa50c8ad841195a98cd3c91e2703b299a"><td class="memItemLeft" align="right" valign="top">static final Collection< Long > </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gaa50c8ad841195a98cd3c91e2703b299a">getOpenIDs</a> ()</td></tr>
<tr class="separator:gaa50c8ad841195a98cd3c91e2703b299a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74ff3a8c9f3c24b63af2c6d8f0c5b55c"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga74ff3a8c9f3c24b63af2c6d8f0c5b55c">H5check_version</a> (int majnum, int minnum, int relnum)</td></tr>
<tr class="separator:ga74ff3a8c9f3c24b63af2c6d8f0c5b55c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad81ce9193f5c63cef4d66ad48bf29049"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gad81ce9193f5c63cef4d66ad48bf29049">H5close</a> () throws HDF5LibraryException</td></tr>
<tr class="separator:gad81ce9193f5c63cef4d66ad48bf29049"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga833fad7925ae765a6100a050b8c24ad6"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga833fad7925ae765a6100a050b8c24ad6">H5open</a> () throws HDF5LibraryException</td></tr>
<tr class="separator:ga833fad7925ae765a6100a050b8c24ad6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d32fbd2ef1197cd813a8fb04fad597b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga5d32fbd2ef1197cd813a8fb04fad597b">H5error_off</a> ()</td></tr>
<tr class="separator:ga5d32fbd2ef1197cd813a8fb04fad597b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0996c24dcb63216b942707d993e4f53"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gaf0996c24dcb63216b942707d993e4f53">H5error_on</a> ()</td></tr>
<tr class="separator:gaf0996c24dcb63216b942707d993e4f53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd2f2b344e59ed550aa8423cac557797"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gabd2f2b344e59ed550aa8423cac557797">H5garbage_collect</a> () throws HDF5LibraryException</td></tr>
<tr class="separator:gabd2f2b344e59ed550aa8423cac557797"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f90a4479f0296a4355f1f08aa88564f"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga9f90a4479f0296a4355f1f08aa88564f">H5get_libversion</a> (int[] libversion) throws HDF5LibraryException</td></tr>
<tr class="separator:ga9f90a4479f0296a4355f1f08aa88564f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae1529dd54abc5e191cb53b464e569f5"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gaae1529dd54abc5e191cb53b464e569f5">H5set_free_list_limits</a> (int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim) throws HDF5LibraryException</td></tr>
<tr class="separator:gaae1529dd54abc5e191cb53b464e569f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9be84065bef5bcc2d6408fd2fb55ab57"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga9be84065bef5bcc2d6408fd2fb55ab57">H5export_dataset</a> (String file_export_name, long file_id, String object_path, int binary_order) throws HDF5LibraryException</td></tr>
<tr class="separator:ga9be84065bef5bcc2d6408fd2fb55ab57"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f1556bb4c53e46c2c43c8608390b9f0"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga7f1556bb4c53e46c2c43c8608390b9f0">H5export_attribute</a> (String file_export_name, long dataset_id, String attribute_name, int binary_order) throws HDF5LibraryException</td></tr>
<tr class="separator:ga7f1556bb4c53e46c2c43c8608390b9f0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gaa6bbaf809e566319082311c2b9572489"><td class="memItemLeft" align="right" valign="top">static final int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#gaa6bbaf809e566319082311c2b9572489">LIB_VERSION</a> [] = {1, 15, 0}</td></tr>
<tr class="separator:gaa6bbaf809e566319082311c2b9572489"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga56bd6da6f5e5b5f06350022a4469699d"><td class="memItemLeft" align="right" valign="top">static final String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga56bd6da6f5e5b5f06350022a4469699d">H5PATH_PROPERTY_KEY</a> = "hdf.hdf5lib.H5.hdf5lib"</td></tr>
<tr class="separator:ga56bd6da6f5e5b5f06350022a4469699d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43b7d41cf2b9f89ccc6650ccc86dd2e0"><td class="memItemLeft" align="right" valign="top">static final String </td><td class="memItemRight" valign="bottom"><a class="el" href="group___j_h5.html#ga43b7d41cf2b9f89ccc6650ccc86dd2e0">H5_LIBRARY_NAME_PROPERTY_KEY</a> = "hdf.hdf5lib.H5.loadLibraryName"</td></tr>
<tr class="separator:ga43b7d41cf2b9f89ccc6650ccc86dd2e0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gadea4d5366be3ed84b465c30646bf55a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadea4d5366be3ed84b465c30646bf55a8">◆ </a></span>getOpenIDCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static final int getOpenIDCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get number of open IDs.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns a count of open IDs </dd></dl>
</div>
</div>
<a id="gaa50c8ad841195a98cd3c91e2703b299a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa50c8ad841195a98cd3c91e2703b299a">◆ </a></span>getOpenIDs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static final Collection<Long> getOpenIDs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the open IDs</p>
<dl class="section return"><dt>Returns</dt><dd>Returns a collection of open IDs </dd></dl>
</div>
</div>
<a id="ga74ff3a8c9f3c24b63af2c6d8f0c5b55c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga74ff3a8c9f3c24b63af2c6d8f0c5b55c">◆ </a></span>H5check_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5check_version </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>majnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>relnum</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5check_version verifies that the arguments match the version numbers compiled into the library.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">majnum</td><td>The major version of the library. </td></tr>
<tr><td class="paramname">minnum</td><td>The minor version of the library. </td></tr>
<tr><td class="paramname">relnum</td><td>The release number of the library. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful. Upon failure (when the versions do not match), this function causes the application to abort (i.e., crash)</dd></dl>
<p>See C API function: <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="el" href="group___h5.html#ga93525482e1168344f4c92470f99d88be" title="Verifies that HDF5 library versions are consistent.">H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)</a> </p>
</div>
</div>
<a id="gad81ce9193f5c63cef4d66ad48bf29049"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad81ce9193f5c63cef4d66ad48bf29049">◆ </a></span>H5close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library.</p>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga5d32fbd2ef1197cd813a8fb04fad597b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d32fbd2ef1197cd813a8fb04fad597b">◆ </a></span>H5error_off()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5error_off </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn off error handling. By default, the C library prints the error stack of the HDF5 C library on stdout. This behavior may be disabled by calling <a class="el" href="group___j_h5.html#ga5d32fbd2ef1197cd813a8fb04fad597b">H5error_off()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful </dd></dl>
</div>
</div>
<a id="gaf0996c24dcb63216b942707d993e4f53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0996c24dcb63216b942707d993e4f53">◆ </a></span>H5error_on()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5error_on </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Turn on error handling. By default, the C library prints the error stack of the HDF5 C library on stdout. This behavior may be re-enabled by calling <a class="el" href="group___j_h5.html#gaf0996c24dcb63216b942707d993e4f53">H5error_on()</a>. </p>
</div>
</div>
<a id="ga7f1556bb4c53e46c2c43c8608390b9f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f1556bb4c53e46c2c43c8608390b9f0">◆ </a></span>H5export_attribute()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5export_attribute </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>file_export_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>dataset_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>attribute_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>binary_order</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5export_attribute is a utility function to save data in a file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_export_name</td><td>The file name to export data into. </td></tr>
<tr><td class="paramname">dataset_id</td><td>The identifier of the dataset containing the attribute. </td></tr>
<tr><td class="paramname">attribute_name</td><td>The attribute to be exported. </td></tr>
<tr><td class="paramname">binary_order</td><td>99 - export data as text. 1 - export data as binary Native Order. 2 - export data as binary Little Endian. 3 - export data as binary Big Endian.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9be84065bef5bcc2d6408fd2fb55ab57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9be84065bef5bcc2d6408fd2fb55ab57">◆ </a></span>H5export_dataset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native void H5export_dataset </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>file_export_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>file_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>object_path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>binary_order</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5export_dataset is a utility function to save data in a file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_export_name</td><td>The file name to export data into. </td></tr>
<tr><td class="paramname">file_id</td><td>The identifier of the HDF5 file containing the dataset. </td></tr>
<tr><td class="paramname">object_path</td><td>The full path of the dataset to be exported. </td></tr>
<tr><td class="paramname">binary_order</td><td>99 - export data as text. 1 - export data as binary Native Order. 2 - export data as binary Little Endian. 3 - export data as binary Big Endian.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gabd2f2b344e59ed550aa8423cac557797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd2f2b344e59ed550aa8423cac557797">◆ </a></span>H5garbage_collect()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5garbage_collect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5garbage_collect collects on all free-lists of all types.</p>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9f90a4479f0296a4355f1f08aa88564f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f90a4479f0296a4355f1f08aa88564f">◆ </a></span>H5get_libversion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5get_libversion </td>
<td>(</td>
<td class="paramtype">int[] </td>
<td class="paramname"><em>libversion</em></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is linked to the application.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">libversion</td><td>The version information of the HDF library.</td></tr>
</table>
</dd>
</dl>
<pre>
libversion[0] = The major version of the library.
libversion[1] = The minor version of the library.
libversion[2] = The release number of the library.
</pre> <dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful, along with the version information.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga833fad7925ae765a6100a050b8c24ad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga833fad7925ae765a6100a050b8c24ad6">◆ </a></span>H5open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5open initialize the library.</p>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaae1529dd54abc5e191cb53b464e569f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae1529dd54abc5e191cb53b464e569f5">◆ </a></span>H5set_free_list_limits()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static synchronized native int H5set_free_list_limits </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>reg_global_lim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>reg_list_lim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>arr_global_lim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>arr_list_lim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>blk_global_lim</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>blk_list_lim</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>H5set_free_list_limits Sets limits on the different kinds of free lists. Setting a value of -1 for a limit means no limit of that type. These limits are global for the entire library. Each "global" limit only applies to free lists of that type, so if an application sets a limit of 1 MB on each of the global lists, up to 3 MB of total storage might be allocated (1MB on each of regular, array and block type lists).</p>
<p>The settings for block free lists are duplicated to factory free lists. Factory free list limits cannot be set independently currently.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reg_global_lim</td><td>The limit on all "regular" free list memory used </td></tr>
<tr><td class="paramname">reg_list_lim</td><td>The limit on memory used in each "regular" free list </td></tr>
<tr><td class="paramname">arr_global_lim</td><td>The limit on all "array" free list memory used </td></tr>
<tr><td class="paramname">arr_list_lim</td><td>The limit on memory used in each "array" free list </td></tr>
<tr><td class="paramname">blk_global_lim</td><td>The limit on all "block" free list memory used </td></tr>
<tr><td class="paramname">blk_list_lim</td><td>The limit on memory used in each "block" free list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-negative value if successful, along with the version information.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">HDF5LibraryException</td><td>Error from the HDF5 Library. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaf9c0f205c18b7fbc0f651786181f83a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9c0f205c18b7fbc0f651786181f83a8">◆ </a></span>loadH5Lib()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void loadH5Lib </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>load native library </p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ga43b7d41cf2b9f89ccc6650ccc86dd2e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga43b7d41cf2b9f89ccc6650ccc86dd2e0">◆ </a></span>H5_LIBRARY_NAME_PROPERTY_KEY</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final String H5_LIBRARY_NAME_PROPERTY_KEY = "hdf.hdf5lib.H5.loadLibraryName"</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>add system property to load library by name from library path, via System.loadLibrary() </p>
</div>
</div>
<a id="ga56bd6da6f5e5b5f06350022a4469699d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56bd6da6f5e5b5f06350022a4469699d">◆ </a></span>H5PATH_PROPERTY_KEY</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final String H5PATH_PROPERTY_KEY = "hdf.hdf5lib.H5.hdf5lib"</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>add system property to load library by path </p>
</div>
</div>
<a id="gaa6bbaf809e566319082311c2b9572489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6bbaf809e566319082311c2b9572489">◆ </a></span>LIB_VERSION</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">final int LIB_VERSION[] = {1, 15, 0}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The version number of the HDF5 library: </p><ul>
<li>
LIB_VERSION[0]: The major version of the library. </li>
<li>
LIB_VERSION[1]: The minor version of the library. </li>
<li>
LIB_VERSION[2]: The release number of the library. </li>
</ul>
<p>Make sure to update the versions number when a different library is used. </p>
</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 on Fri Sep 15 2023 00:30:31 for HDF5 by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>
|
