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
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
|
<!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: Java File (H5F) 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>
<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___j_h5_f.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="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Java File (H5F) Interface</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_f.html">Files (H5F)</a>, C-API</dd>
<dd>
<a class="el" href="_h5_f__u_g.html">The HDF5 File</a>, User Guide </dd></dl>
<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:gae2af8e1b3fcf6a3a98ab345ed3ff710f" id="r_gae2af8e1b3fcf6a3a98ab345ed3ff710f"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae2af8e1b3fcf6a3a98ab345ed3ff710f">H5Fclose</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a> </td></tr>
<tr class="separator:gae2af8e1b3fcf6a3a98ab345ed3ff710f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaceb23ca3aeaac704f563873d7d516913" id="r_gaceb23ca3aeaac704f563873d7d516913"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaceb23ca3aeaac704f563873d7d516913">H5Fopen</a> (String name, int flags, long access_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException </td></tr>
<tr class="separator:gaceb23ca3aeaac704f563873d7d516913"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c4aa7a37c3f96d5a030ab3db9ea6b3c" id="r_ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9c4aa7a37c3f96d5a030ab3db9ea6b3c">H5Freopen</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a> </td></tr>
<tr class="separator:ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabd29514d186d5ff99f1b7789168b7518" id="r_gabd29514d186d5ff99f1b7789168b7518"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabd29514d186d5ff99f1b7789168b7518">H5Fcreate</a> (String name, int flags, long create_id, long access_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException </td></tr>
<tr class="separator:gabd29514d186d5ff99f1b7789168b7518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68f2950e68242b5cf3f3f16665884098" id="r_ga68f2950e68242b5cf3f3f16665884098"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga68f2950e68242b5cf3f3f16665884098">H5Fflush</a> (long object_id, int scope) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga68f2950e68242b5cf3f3f16665884098"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae6816ee72c5becdedd1795f49302a61a" id="r_gae6816ee72c5becdedd1795f49302a61a"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae6816ee72c5becdedd1795f49302a61a">H5Fget_access_plist</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a> </td></tr>
<tr class="separator:gae6816ee72c5becdedd1795f49302a61a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf552de4e95ababd36503786aa95c5543" id="r_gaf552de4e95ababd36503786aa95c5543"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf552de4e95ababd36503786aa95c5543">H5Fget_create_plist</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a> </td></tr>
<tr class="separator:gaf552de4e95ababd36503786aa95c5543"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga93177de1e51f10dd4345af2b18d2ed0a" id="r_ga93177de1e51f10dd4345af2b18d2ed0a"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga93177de1e51f10dd4345af2b18d2ed0a">H5Fget_filesize</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga93177de1e51f10dd4345af2b18d2ed0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8eb3b2e26a9665716e3a4dd088c2a110" id="r_ga8eb3b2e26a9665716e3a4dd088c2a110"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8eb3b2e26a9665716e3a4dd088c2a110">H5Fget_freespace</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga8eb3b2e26a9665716e3a4dd088c2a110"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7fa39e49c4cc79c92417b7975647bce8" id="r_ga7fa39e49c4cc79c92417b7975647bce8"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7fa39e49c4cc79c92417b7975647bce8">H5Fget_intent</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga7fa39e49c4cc79c92417b7975647bce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0659bd74e6c36b5bcdbce58f435a2471" id="r_ga0659bd74e6c36b5bcdbce58f435a2471"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0659bd74e6c36b5bcdbce58f435a2471">H5Fget_fileno</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga0659bd74e6c36b5bcdbce58f435a2471"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga23c530eeff9347e8228838c01dd51bdb" id="r_ga23c530eeff9347e8228838c01dd51bdb"><td class="memItemLeft" align="right" valign="top">static synchronized native double </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga23c530eeff9347e8228838c01dd51bdb">H5Fget_mdc_hit_rate</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga23c530eeff9347e8228838c01dd51bdb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2401fec70096313cfa1f996a07ccb58b" id="r_ga2401fec70096313cfa1f996a07ccb58b"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2401fec70096313cfa1f996a07ccb58b">H5Fget_mdc_size</a> (long file_id, long[] metadata_cache) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</td></tr>
<tr class="separator:ga2401fec70096313cfa1f996a07ccb58b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9251e84d3f5e9519689a199e1ae233fb" id="r_ga9251e84d3f5e9519689a199e1ae233fb"><td class="memItemLeft" align="right" valign="top">static synchronized native String </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9251e84d3f5e9519689a199e1ae233fb">H5Fget_name</a> (long obj_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga9251e84d3f5e9519689a199e1ae233fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad94f5268aff34a268cc172bcdbe14a43" id="r_gad94f5268aff34a268cc172bcdbe14a43"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad94f5268aff34a268cc172bcdbe14a43">H5Fget_obj_count</a> (long file_id, int types) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gad94f5268aff34a268cc172bcdbe14a43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga70587e2bb55050ba6615ff21b14b563f" id="r_ga70587e2bb55050ba6615ff21b14b563f"><td class="memItemLeft" align="right" valign="top">static synchronized native long </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga70587e2bb55050ba6615ff21b14b563f">H5Fget_obj_ids</a> (long file_id, int types, long max_objs, long[] obj_id_list) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:ga70587e2bb55050ba6615ff21b14b563f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf78bae0122080a4500a7c04b7efe53c" id="r_gadf78bae0122080a4500a7c04b7efe53c"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadf78bae0122080a4500a7c04b7efe53c">H5Fis_hdf5</a> (String name) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:gadf78bae0122080a4500a7c04b7efe53c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga05b017fbde34c50d5ba660f3544287ca" id="r_ga05b017fbde34c50d5ba660f3544287ca"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga05b017fbde34c50d5ba660f3544287ca">H5Fis_accessible</a> (String name, long fapl_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:ga05b017fbde34c50d5ba660f3544287ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9332f0a150de188d9277a372f77d7c81" id="r_ga9332f0a150de188d9277a372f77d7c81"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9332f0a150de188d9277a372f77d7c81">H5Fmount</a> (long loc_id, String name, long child_id, long plist_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:ga9332f0a150de188d9277a372f77d7c81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f3ce0599852b2394154c803e91f98dd" id="r_ga0f3ce0599852b2394154c803e91f98dd"><td class="memItemLeft" align="right" valign="top">static synchronized native int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0f3ce0599852b2394154c803e91f98dd">H5Funmount</a> (long loc_id, String name) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:ga0f3ce0599852b2394154c803e91f98dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae886416abdeeaade8d3f1eb208553991" id="r_gae886416abdeeaade8d3f1eb208553991"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae886416abdeeaade8d3f1eb208553991">H5Freset_mdc_hit_rate_stats</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gae886416abdeeaade8d3f1eb208553991"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb08a4ebe8043343a33e75105a5675b9" id="r_gabb08a4ebe8043343a33e75105a5675b9"><td class="memItemLeft" align="right" valign="top">static synchronized native <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f__info2__t.html">H5F_info2_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabb08a4ebe8043343a33e75105a5675b9">H5Fget_info</a> (long obj_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gabb08a4ebe8043343a33e75105a5675b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7dd16adeb51a442715e5d9822792f22b" id="r_ga7dd16adeb51a442715e5d9822792f22b"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7dd16adeb51a442715e5d9822792f22b">H5Fclear_elink_file_cache</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga7dd16adeb51a442715e5d9822792f22b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4346b5b0ce21586754ae4915524713a2" id="r_ga4346b5b0ce21586754ae4915524713a2"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4346b5b0ce21586754ae4915524713a2">H5Fstart_swmr_write</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga4346b5b0ce21586754ae4915524713a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a0ba403100708152bf26f065961d57e" id="r_ga5a0ba403100708152bf26f065961d57e"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5a0ba403100708152bf26f065961d57e">H5Fstart_mdc_logging</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga5a0ba403100708152bf26f065961d57e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8018593595e4edd8e7a8a48c58183fbe" id="r_ga8018593595e4edd8e7a8a48c58183fbe"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8018593595e4edd8e7a8a48c58183fbe">H5Fstop_mdc_logging</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga8018593595e4edd8e7a8a48c58183fbe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe8dbd62c0bfd59381de2dec03605a2c" id="r_gafe8dbd62c0bfd59381de2dec03605a2c"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafe8dbd62c0bfd59381de2dec03605a2c">H5Fget_mdc_logging_status</a> (long file_id, boolean[] mdc_logging_status) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</td></tr>
<tr class="separator:gafe8dbd62c0bfd59381de2dec03605a2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bdded58e271dd3950d7ac765930b51c" id="r_ga7bdded58e271dd3950d7ac765930b51c"><td class="memItemLeft" align="right" valign="top">static synchronized native boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7bdded58e271dd3950d7ac765930b51c">H5Fget_dset_no_attrs_hint</a> (long file_id) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:ga7bdded58e271dd3950d7ac765930b51c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafdd3023ff5992ddfb76983bc3894894f" id="r_gafdd3023ff5992ddfb76983bc3894894f"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafdd3023ff5992ddfb76983bc3894894f">H5Fset_dset_no_attrs_hint</a> (long file_id, boolean minimize) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gafdd3023ff5992ddfb76983bc3894894f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabe7edf4d09ac71c4f8b1135594d691ea" id="r_gabe7edf4d09ac71c4f8b1135594d691ea"><td class="memItemLeft" align="right" valign="top">static synchronized native void </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabe7edf4d09ac71c4f8b1135594d691ea">H5Fset_libver_bounds</a> (long file_id, int low, int high) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a></td></tr>
<tr class="separator:gabe7edf4d09ac71c4f8b1135594d691ea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7dd16adeb51a442715e5d9822792f22b" name="ga7dd16adeb51a442715e5d9822792f22b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7dd16adeb51a442715e5d9822792f22b">◆ </a></span>H5Fclear_elink_file_cache()</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 H5Fclear_elink_file_cache </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fclear_elink_file_cache evicts all the cached child files in the specified file's external file cache, causing them to be closed if there is nothing else holding them open.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</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="gae2af8e1b3fcf6a3a98ab345ed3ff710f" name="gae2af8e1b3fcf6a3a98ab345ed3ff710f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae2af8e1b3fcf6a3a98ab345ed3ff710f">◆ </a></span>H5Fclose()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int H5Fclose </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fclose terminates access to an HDF5 file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>Identifier of a file to terminate access to.</td></tr>
</table>
</dd>
</dl>
<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="gabd29514d186d5ff99f1b7789168b7518" name="gabd29514d186d5ff99f1b7789168b7518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabd29514d186d5ff99f1b7789168b7518">◆ </a></span>H5Fcreate()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long H5Fcreate </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>flags</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>create_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>access_id</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fcreate is the primary function for creating HDF5 files.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the file to access. </td></tr>
<tr><td class="paramname">flags</td><td>File access flags. Possible values include: <ul>
<li>
<a class="el" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a> Allow read and write access to file. </li>
<li>
<a class="el" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a> Allow read-only access to file. </li>
<li>
<a class="el" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a> Truncate file, if it already exists, erasing all data previously stored in the file. </li>
<li>
<a class="el" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a> Fail if file already exists. </li>
<li>
<a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> Apply default file access and creation properties. </li>
</ul>
</td></tr>
<tr><td class="paramname">create_id</td><td>File creation property list identifier, used when modifying default file meta-data. Use H5P_DEFAULT for default access properties. </td></tr>
<tr><td class="paramname">access_id</td><td>File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the access_id (not supported in Java). Use H5P_DEFAULT for default access properties.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a file identifier 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>
<tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga68f2950e68242b5cf3f3f16665884098" name="ga68f2950e68242b5cf3f3f16665884098"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68f2950e68242b5cf3f3f16665884098">◆ </a></span>H5Fflush()</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 H5Fflush </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>object_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>scope</em></span> ) 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>H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without removing the data from the (memory) cache. </p>
<p>After this call completes, the file (or object) is in a consistent state and all data written to date is assured to be permanent.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object_id</td><td>Identifier of object used to identify the file. <b>object_id</b> can be any object associated with the file, including the file itself, a dataset, a group, an attribute, or a named data type. </td></tr>
<tr><td class="paramname">scope</td><td>specifies the scope of the flushing action, in the case that the HDF5 file is not a single physical file. </td></tr>
</table>
</dd>
</dl>
<p>Valid values are: </p><ul>
<li>
H5F_SCOPE_GLOBAL Flushes the entire virtual file. </li>
<li>
H5F_SCOPE_LOCAL Flushes only the specified file. </li>
</ul>
<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="gae6816ee72c5becdedd1795f49302a61a" name="gae6816ee72c5becdedd1795f49302a61a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6816ee72c5becdedd1795f49302a61a">◆ </a></span>H5Fget_access_plist()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long H5Fget_access_plist </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_access_plist returns the file access property list identifier of the specified file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>Identifier of file to get access property list of</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a file access property list identifier 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="gaf552de4e95ababd36503786aa95c5543" name="gaf552de4e95ababd36503786aa95c5543"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf552de4e95ababd36503786aa95c5543">◆ </a></span>H5Fget_create_plist()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long H5Fget_create_plist </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to create this file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>Identifier of the file to get creation property list</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a file creation property list identifier 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="ga7bdded58e271dd3950d7ac765930b51c" name="ga7bdded58e271dd3950d7ac765930b51c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7bdded58e271dd3950d7ac765930b51c">◆ </a></span>H5Fget_dset_no_attrs_hint()</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 boolean H5Fget_dset_no_attrs_hint </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_dset_no_attrs_hint gets the file-level setting to create minimized dataset object headers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the file-level is set to create minimized dataset object headers, false if not.</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="ga0659bd74e6c36b5bcdbce58f435a2471" name="ga0659bd74e6c36b5bcdbce58f435a2471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0659bd74e6c36b5bcdbce58f435a2471">◆ </a></span>H5Fget_fileno()</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 long H5Fget_fileno </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_fileno retrieves the "file number" for an open file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the unique file number for the file.</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="ga93177de1e51f10dd4345af2b18d2ed0a" name="ga93177de1e51f10dd4345af2b18d2ed0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93177de1e51f10dd4345af2b18d2ed0a">◆ </a></span>H5Fget_filesize()</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 long H5Fget_filesize </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_filesize retrieves the file size of the HDF5 file. This function is called after an existing file is opened in order to learn the true size of the underlying file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the file size of the HDF5 file</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="ga8eb3b2e26a9665716e3a4dd088c2a110" name="ga8eb3b2e26a9665716e3a4dd088c2a110"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8eb3b2e26a9665716e3a4dd088c2a110">◆ </a></span>H5Fget_freespace()</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 long H5Fget_freespace </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_freespace returns the amount of space that is unused by any objects in the file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the amount of free space in the file</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="gabb08a4ebe8043343a33e75105a5675b9" name="gabb08a4ebe8043343a33e75105a5675b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb08a4ebe8043343a33e75105a5675b9">◆ </a></span>H5Fget_info()</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 <a class="el" href="classhdf_1_1hdf5lib_1_1structs_1_1_h5_f__info2__t.html">H5F_info2_t</a> H5Fget_info </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>obj_id</em></span></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>H5Fget_info returns global information for the file associated with the object identifier obj_id.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj_id</td><td>IN: Object identifier for any object in the file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A buffer(H5F_info2_t) for current "global" information about file</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="ga7fa39e49c4cc79c92417b7975647bce8" name="ga7fa39e49c4cc79c92417b7975647bce8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fa39e49c4cc79c92417b7975647bce8">◆ </a></span>H5Fget_intent()</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 H5Fget_intent </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_intent retrieves the intended access mode flag passed with H5Fopen when the file was opened.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the intended access mode flag, as originally passed with H5Fopen.</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="ga23c530eeff9347e8228838c01dd51bdb" name="ga23c530eeff9347e8228838c01dd51bdb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23c530eeff9347e8228838c01dd51bdb">◆ </a></span>H5Fget_mdc_hit_rate()</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 double H5Fget_mdc_hit_rate </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fget_mdc_hit_rate queries the metadata cache of the target file to obtain its hit rate (cache hits / (cache hits + cache misses)) since the last time hit rate statistics were reset.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the double in which the hit rate is returned.</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="gafe8dbd62c0bfd59381de2dec03605a2c" name="gafe8dbd62c0bfd59381de2dec03605a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe8dbd62c0bfd59381de2dec03605a2c">◆ </a></span>H5Fget_mdc_logging_status()</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 H5Fget_mdc_logging_status </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean[]</td> <td class="paramname"><span class="paramname"><em>mdc_logging_status</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fget_mdc_logging_status gets the current metadata cache logging status.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</td></tr>
<tr><td class="paramname">mdc_logging_status</td><td>the status mdc_logging_status[0] = is_enabled, whether logging is enabled mdc_logging_status[1] = is_currently_logging, whether events are currently being logged</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>
<tr><td class="paramname">NullPointerException</td><td>mdc_logging_status is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga2401fec70096313cfa1f996a07ccb58b" name="ga2401fec70096313cfa1f996a07ccb58b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2401fec70096313cfa1f996a07ccb58b">◆ </a></span>H5Fget_mdc_size()</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 H5Fget_mdc_size </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long[]</td> <td class="paramname"><span class="paramname"><em>metadata_cache</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException, IllegalArgumentException</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>H5Fget_mdc_size queries the metadata cache of the target file for the desired size information.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr>
<tr><td class="paramname">metadata_cache</td><td>OUT: Current metadata cache information <ul>
<li>
metadata_cache[0] = max_size_ptr // current cache maximum size </li>
<li>
metadata_cache[1] = min_clean_size_ptr // current cache minimum clean size </li>
<li>
metadata_cache[2] = cur_size_ptr // current cache size </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current number of entries in the cache</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>
<tr><td class="paramname">NullPointerException</td><td>metadata_cache is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9251e84d3f5e9519689a199e1ae233fb" name="ga9251e84d3f5e9519689a199e1ae233fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9251e84d3f5e9519689a199e1ae233fb">◆ </a></span>H5Fget_name()</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 String H5Fget_name </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>obj_id</em></span></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>H5Fget_name retrieves the name of the file to which the object obj_id belongs.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">obj_id</td><td>IN: Identifier of the object for which the associated filename is sought.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the filename.</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="gad94f5268aff34a268cc172bcdbe14a43" name="gad94f5268aff34a268cc172bcdbe14a43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad94f5268aff34a268cc172bcdbe14a43">◆ </a></span>H5Fget_obj_count()</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 long H5Fget_obj_count </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>types</em></span> ) 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>H5Fget_obj_count returns the number of open object identifiers for the file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file </td></tr>
<tr><td class="paramname">types</td><td>IN: Type of object for which identifiers are to be returned. <ul>
<li>
H5F_OBJ_FILE Files only </li>
<li>
H5F_OBJ_DATASET Datasets only </li>
<li>
H5F_OBJ_GROUP Groups only </li>
<li>
H5F_OBJ_DATATYPE Named datatypes only </li>
<li>
H5F_OBJ_ATTR Attributes only </li>
<li>
H5F_OBJ_ALL All of the above </li>
<li>
H5F_OBJ_LOCAL Restrict search to objects opened through current file identifier. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of open objects.</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="ga70587e2bb55050ba6615ff21b14b563f" name="ga70587e2bb55050ba6615ff21b14b563f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70587e2bb55050ba6615ff21b14b563f">◆ </a></span>H5Fget_obj_ids()</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 long H5Fget_obj_ids </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>types</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>max_objs</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long[]</td> <td class="paramname"><span class="paramname"><em>obj_id_list</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fget_obj_ids returns the list of identifiers for all open HDF5 objects fitting the specified criteria.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: File identifier for a currently-open HDF5 file </td></tr>
<tr><td class="paramname">types</td><td>IN: Type of object for which identifiers are to be returned. </td></tr>
<tr><td class="paramname">max_objs</td><td>IN: Maximum number of object identifiers to place into obj_id_list. </td></tr>
<tr><td class="paramname">obj_id_list</td><td>OUT: Pointer to the returned list of open object identifiers.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of objects placed into obj_id_list.</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>
<tr><td class="paramname">NullPointerException</td><td>obj_id_list is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga05b017fbde34c50d5ba660f3544287ca" name="ga05b017fbde34c50d5ba660f3544287ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga05b017fbde34c50d5ba660f3544287ca">◆ </a></span>H5Fis_accessible()</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 boolean H5Fis_accessible </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>fapl_id</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fis_accessible determines if the file can be opened with the given fapl.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>IN: File name to check. </td></tr>
<tr><td class="paramname">fapl_id</td><td>IN: File access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if file is accessible, false if not.</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>
<tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gadf78bae0122080a4500a7c04b7efe53c" name="gadf78bae0122080a4500a7c04b7efe53c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf78bae0122080a4500a7c04b7efe53c">◆ </a></span>H5Fis_hdf5()</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 boolean H5Fis_hdf5 </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em></span></td><td>)</td>
<td> throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fis_hdf5 determines whether a file is in the HDF5 format.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>File name to check format.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if is HDF5, false if not.</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>
<tr><td class="paramname">NullPointerException</td><td>name is null.</td></tr>
</table>
</dd>
</dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated</a></b></dt><dd>As of HDF5 1.10.5 in favor of H5Fis_accessible. </dd></dl>
</div>
</div>
<a id="ga9332f0a150de188d9277a372f77d7c81" name="ga9332f0a150de188d9277a372f77d7c81"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9332f0a150de188d9277a372f77d7c81">◆ </a></span>H5Fmount()</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 H5Fmount </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>child_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>plist_id</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount properties plist_id.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc_id</td><td>The identifier for the group onto which the file specified by child_id is to be mounted. </td></tr>
<tr><td class="paramname">name</td><td>The name of the group onto which the file specified by child_id is to be mounted. </td></tr>
<tr><td class="paramname">child_id</td><td>The identifier of the file to be mounted. </td></tr>
<tr><td class="paramname">plist_id</td><td>The identifier of the property list to be used.</td></tr>
</table>
</dd>
</dl>
<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>
<tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gaceb23ca3aeaac704f563873d7d516913" name="gaceb23ca3aeaac704f563873d7d516913"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaceb23ca3aeaac704f563873d7d516913">◆ </a></span>H5Fopen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long H5Fopen </td>
<td>(</td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>flags</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>access_id</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the file to access. </td></tr>
<tr><td class="paramname">flags</td><td>File access flags. </td></tr>
<tr><td class="paramname">access_id</td><td>Identifier for the file access properties list.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a file identifier 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>
<tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9c4aa7a37c3f96d5a030ab3db9ea6b3c" name="ga9c4aa7a37c3f96d5a030ab3db9ea6b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c4aa7a37c3f96d5a030ab3db9ea6b3c">◆ </a></span>H5Freopen()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static long H5Freopen </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Freopen reopens an HDF5 file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>Identifier of a file to terminate and reopen access to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a new file identifier 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="gae886416abdeeaade8d3f1eb208553991" name="gae886416abdeeaade8d3f1eb208553991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae886416abdeeaade8d3f1eb208553991">◆ </a></span>H5Freset_mdc_hit_rate_stats()</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 H5Freset_mdc_hit_rate_stats </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Freset_mdc_hit_rate_stats resets the hit rate statistics counters in the metadata cache associated with the specified file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</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="gafdd3023ff5992ddfb76983bc3894894f" name="gafdd3023ff5992ddfb76983bc3894894f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafdd3023ff5992ddfb76983bc3894894f">◆ </a></span>H5Fset_dset_no_attrs_hint()</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 H5Fset_dset_no_attrs_hint </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean</td> <td class="paramname"><span class="paramname"><em>minimize</em></span> ) 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>H5Fset_dset_no_attrs_hint sets the file-level setting to create minimized dataset object headers.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr>
<tr><td class="paramname">minimize</td><td>the minimize hint setting</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="gabe7edf4d09ac71c4f8b1135594d691ea" name="gabe7edf4d09ac71c4f8b1135594d691ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe7edf4d09ac71c4f8b1135594d691ea">◆ </a></span>H5Fset_libver_bounds()</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 H5Fset_libver_bounds </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>low</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>high</em></span> ) 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>H5Fset_libver_bounds sets a different low and high bounds while a file is open.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file. </td></tr>
<tr><td class="paramname">low</td><td>IN: The earliest version of the library that will be used for writing objects </td></tr>
<tr><td class="paramname">high</td><td>IN: The latest version of the library that will be used for writing objects.</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="ga5a0ba403100708152bf26f065961d57e" name="ga5a0ba403100708152bf26f065961d57e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a0ba403100708152bf26f065961d57e">◆ </a></span>H5Fstart_mdc_logging()</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 H5Fstart_mdc_logging </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fstart_mdc_logging starts logging metadata cache events if logging was previously enabled.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</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="ga4346b5b0ce21586754ae4915524713a2" name="ga4346b5b0ce21586754ae4915524713a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4346b5b0ce21586754ae4915524713a2">◆ </a></span>H5Fstart_swmr_write()</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 H5Fstart_swmr_write </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fstart_swmr_write will activate SWMR writing mode for a file associated with file_id. This routine will prepare and ensure the file is safe for SWMR writing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</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="ga8018593595e4edd8e7a8a48c58183fbe" name="ga8018593595e4edd8e7a8a48c58183fbe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8018593595e4edd8e7a8a48c58183fbe">◆ </a></span>H5Fstop_mdc_logging()</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 H5Fstop_mdc_logging </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>file_id</em></span></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>H5Fstop_mdc_logging stops logging metadata cache events if logging was previously enabled and is currently ongoing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_id</td><td>IN: Identifier of the target file.</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="ga0f3ce0599852b2394154c803e91f98dd" name="ga0f3ce0599852b2394154c803e91f98dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0f3ce0599852b2394154c803e91f98dd">◆ </a></span>H5Funmount()</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 H5Funmount </td>
<td>(</td>
<td class="paramtype">long</td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String</td> <td class="paramname"><span class="paramname"><em>name</em></span> ) throws <a class="el" href="classhdf_1_1hdf5lib_1_1exceptions_1_1_h_d_f5_library_exception.html">HDF5LibraryException</a>, NullPointerException</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>Given a mount point, H5Funmount disassociates the mount point's file from the file mounted there.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">loc_id</td><td>The identifier for the location at which the specified file is to be unmounted. </td></tr>
<tr><td class="paramname">name</td><td>The name of the file to be unmounted.</td></tr>
</table>
</dd>
</dl>
<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>
<tr><td class="paramname">NullPointerException</td><td>name is null. </td></tr>
</table>
</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>
|
