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
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
|
<html>
<head><title>
HDF5/H5F API Specification
</title>
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>
<body bgcolor="#FFFFFF">
<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5im.html">H5IM</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5lt.html">H5LT</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5pt.html">H5PT</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5tb.html">H5TB</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<a href="RM_H5P.html">H5P</a>
<br>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><center>
<h1>H5F: File Interface</h1>
</center>
<h2>File API Functions</h2>
These functions are designed to provide file-level access to HDF5 files.
Further manipulation of objects inside a file is performed through one of APIs
documented below.
<p>
<strong>The C Interfaces:</strong>
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#File-Create">H5Fcreate</a>
<li><a href="#File-Open">H5Fopen</a>
<li><a href="#File-Reopen">H5Freopen</a>
<li><a href="#File-Close">H5Fclose</a>
<li><a href="#File-Flush">H5Fflush</a>
<li><a href="#File-IsHDF5">H5Fis_hdf5</a>
<li><a href="#File-Mount">H5Fmount</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#File-Unmount">H5Funmount</a>
<li><a href="#File-GetVfdHandle">H5Fget_vfd_handle</a>
<li><a href="#File-GetFilesize">H5Fget_filesize</a>
<li><a href="#File-GetCreatePlist">H5Fget_create_plist</a>
<li><a href="#File-GetAccessPlist">H5Fget_access_plist</a>
<li><a href="#File-GetName">H5Fget_name</a>
<li><a href="#File-GetObjCount">H5Fget_obj_count</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#File-GetObjIDs">H5Fget_obj_ids</a>
<li><a href="#File-GetFreeSpace">H5Fget_freespace</a>
<li><a href="#File-GetMdcConfig">H5Fget_mdc_config</a>
<li><a href="#File-GetMdcHitRate">H5Fget_mdc_hit_rate</a>
<li><a href="#File-GetMdcSize">H5Fget_mdc_size</a>
<li><a href="#File-ResetMdcHitRateStats">H5Freset_mdc_hit_rate_stats</a>
<li><a href="#File-SetMdcConfig">H5Fset_mdc_config</a>
</ul>
</td></tr>
</table>
<br>
<i>Alphabetical Listing</i>
<table border="0">
<tr>
<td valign="top">
<ul>
<li><a href="#File-Close">H5Fclose</a>
<li><a href="#File-Create">H5Fcreate</a>
<li><a href="#File-Flush">H5Fflush</a>
<li><a href="#File-GetAccessPlist">H5Fget_access_plist</a>
<li><a href="#File-GetCreatePlist">H5Fget_create_plist</a>
<li><a href="#File-GetFilesize">H5Fget_filesize</a>
<li><a href="#File-GetFreeSpace">H5Fget_freespace</a>
</ul>
</td>
<td> </td>
<td valign="top">
<ul>
<li><a href="#File-GetMdcConfig">H5Fget_mdc_config</a>
<li><a href="#File-GetMdcHitRate">H5Fget_mdc_hit_rate</a>
<li><a href="#File-GetMdcSize">H5Fget_mdc_size</a>
<li><a href="#File-GetName">H5Fget_name</a>
<li><a href="#File-GetObjCount">H5Fget_obj_count</a>
<li><a href="#File-GetObjIDs">H5Fget_obj_ids</a>
<li><a href="#File-GetVfdHandle">H5Fget_vfd_handle</a>
</ul>
</td>
<td> </td>
<td valign="top">
<ul>
<li><a href="#File-IsHDF5">H5Fis_hdf5</a>
<li><a href="#File-Mount">H5Fmount</a>
<li><a href="#File-Open">H5Fopen</a>
<li><a href="#File-Reopen">H5Freopen</a>
<li><a href="#File-ResetMdcHitRateStats">H5Freset_mdc_hit_rate_stats</a>
<li><a href="#File-SetMdcConfig">H5Fset_mdc_config</a>
<li><a href="#File-Unmount">H5Funmount</a>
</ul>
</td>
</tr>
</table>
<br>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function.
<br>
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#File-Create">h5fcreate_f</a>
<li><a href="#File-Open">h5fopen_f</a>
<li><a href="#File-Reopen">h5freopen_f</a>
<li><a href="#File-Close">h5fclose_f</a>
<li><a href="#File-Flush">h5fflush_f</a>
<li><a href="#File-IsHDF5">h5fis_hdf5_f</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#File-Mount">h5fmount_f</a>
<li><a href="#File-Unmount">h5funmount_f</a>
<li><a href="#File-GetVfdHandle">h5fget_vfd_handle_f</a>
<li><a href="#File-GetFilesize">h5fget_filesize_f</a>
<li><a href="#File-GetFreespace">h5fget_freespace_f</a>
</ul>
</td><td> </td><td valign=top>
<ul>
<li><a href="#File-GetCreatePlist">h5fget_create_plist_f</a>
<li><a href="#File-GetAccessPlist">h5fget_access_plist_f</a>
<li><a href="#File-GetName">h5fget_name_f</a>
<li><a href="#File-GetObjCount">h5fget_obj_count_f</a>
<li><a href="#File-GetObjIDs">h5fget_obj_ids_f</a>
<!--<li><a href="#File-GetMdcConfig">H5Fget_mdc_config_f</a> -->
<!--<li><a href="#File-GetMdcHitRate">H5Fget_mdc_hit_rate_f</a> -->
<!--<li><a href="#File-GetMdcSize">H5Fget_mdc_size_f</a> -->
<!--<li><a href="#File-ResetMdcHitRateStats">H5Freset_mdc_hit_rate_stats_f</a> -->
<!--<li><a href="#File-SetMdcConfig">H5Fset_mdc_config_f</a> -->
</ul>
</td></tr>
</table>
<!-- NEW PAGE -->
<!-- HEADER RIGHT " " -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fclose" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Close">H5Fclose</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Fclose</code>(<em>hid_t</em> <code>file_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Terminates access to an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Fclose</code> terminates access to an HDF5 file
by flushing all data to storage and terminating access
to the file through <code>file_id</code>.
<p>
If this is the last file identifier open for the file
and no other access identifier is open (e.g., a dataset
identifier, group identifier, or shared datatype identifier),
the file will be fully closed and access will end.
<p>
<strong>Delayed close:</strong>
<br>
Note the following deviation from the above-described behavior.
If <code>H5Fclose</code> is called for a file but one or more
objects within the file remain open, those objects will remain
accessible until they are individually closed.
Thus, if the dataset <code>data_sample</code> is open when
<code>H5Fclose</code> is called for the file containing it,
<code>data_sample</code> will remain open and accessible
(including writable) until it is explicitely closed.
The file will be automatically closed once all objects in the
file have been closed.
<p>
Be warned, hoever, that there are circumstances where it is
not possible to delay closing a file.
For example, an MPI-IO file close is a collective call; all of
the processes that opened the file must close it collectively.
The file cannot be closed at some time in the future by each
process in an independent fashion.
Another example is that an application using an AFS token-based
file access privilage may destroy its AFS token after
<code>H5Fclose</code> has returned successfully.
This would make any future access to the file, or any object
within it, illegal.
<p>
In such situations, applications must close all open objects
in a file before calling <code>H5Fclose</code>.
It is generally recommended to do so in all cases.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of a file to terminate access to.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fclose_f
<dd>
<pre>
SUBROUTINE h5fclose_f(file_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fclose_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fcreate" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Create">H5Fcreate</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Fcreate</code>(<em>const char *</em><code>name</code>,
<em>unsigned</em> <code>flags</code>,
<em>hid_t</em> <code>create_id</code>,
<em>hid_t</em> <code>access_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates HDF5 files.
<dt><strong>Description:</strong>
<dd><code>H5Fcreate</code> is the primary function for creating
HDF5 files .
<p>
The <code>flags</code> parameter determines whether an
existing file will be overwritten. All newly created files
are opened for both reading and writing. All flags may be
combined with the bit-wise OR operator (`|') to change
the behavior of the <code>H5Fcreate</code> call.
<p>
The more complex behaviors of file creation and access
are controlled through the file-creation and file-access
property lists. The value of <code>H5P_DEFAULT</code> for
a property list value indicates that the library should use
the default values for the appropriate property list.
<p>
The return value is a file identifier for the newly-created file;
this file identifier should be closed by calling
<code>H5Fclose</code> when it is no longer needed.
<p>
<b>Special case -- File creation in the case of an
already-open file:</b>
<br>
If a file being created is already opened, by either a
previous <code>H5Fopen</code> or <code>H5Fcreate</code> call,
the HDF5 library may or may not detect that the open file and
the new file are the same physical file.
(See <a href="#File-Open"><code>H5Fopen</code></a> regarding
the limitations in detecting the re-opening of an already-open
file.)
<p>
If the library detects that the file is already opened,
<code>H5Fcreate</code> will return a failure, regardless
of the use of <code>H5F_ACC_TRUNC</code>.
<p>
If the library does not detect that the file is already opened
and <code>H5F_ACC_TRUNC</code> is not used,
<code>H5Fcreate</code> will return a failure because the file
already exists. Note that this is correct behavior.
<p>
But if the library does not detect that the file is already
opened and <code>H5F_ACC_TRUNC</code> is used,
<code>H5Fcreate</code> will truncate the existing file
and return a valid file identifier.
Such a truncation of a currently-opened file will almost
certainly result in errors.
While unlikely, the HDF5 library may not be able to detect,
and thus report, such errors.
<p>
Applications should avoid calling <code>H5Fcreate</code>
with an already opened file.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>const char *</em><code>name </code></td>
<td valign="top">IN: Name of the file to access.</td></tr>
<tr>
<td valign="top"><em>uintn</em> <code>flags</code></td>
<td valign="top">IN: File access flags. Allowable values are:
<ul><dl>
<dt><code>H5F_ACC_TRUNC</code>
<dd>Truncate file, if it already exists,
erasing all data previously stored in the file.
<dt><code>H5F_ACC_EXCL</code>
<dd>Fail if file already exists.
</dl></ul>
<li><code>H5F_ACC_TRUNC</code> and <code>H5F_ACC_EXCL</code>
are mutually exclusive; use exactly one.
<li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints
debug information. This flag is used only by HDF5 library
developers; <i>it is neither tested nor supported</i>
for use in applications.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>create_id </code></td>
<td valign="top">IN: File creation property list identifier, used when modifying
default file meta-data.
Use <code>H5P_DEFAULT</code> for default file creation properties.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>access_id</code></td>
<td valign="top">IN: File access property list identifier.
If parallel file access is desired, this is a collective
call according to the communicator stored in the
<code>access_id</code>.
Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a file identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fcreate_f
<dd>
<pre>
SUBROUTINE h5fcreate_f(name, access_flags, file_id, hdferr, &
creation_prp, access_prp)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
INTEGER, INTENT(IN) :: access_flag ! File access flags
! Possible values are:
! H5F_ACC_RDWR_F
! H5F_ACC_RDONLY_F
! H5F_ACC_TRUNC_F
! H5F_ACC_EXCL_F
! H5F_ACC_DEBUG_F
INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: creation_prp
! File creation propertly
! list identifier, if not
! specified its value is
! H5P_DEFAULT_F
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
! File access property list
! identifier, if not
! specified its value is
! H5P_DEFAULT_F
END SUBROUTINE h5fcreate_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fflush" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Fflush</code>(<em>hid_t </em><code>object_id</code>,
<em>H5F_scope_t</em> <code>scope</code>
)
<dt><strong>Purpose:</strong>
<dd>Flushes all buffers associated with a file to disk.
<dt><strong>Description:</strong>
<dd><code>H5Fflush</code> causes all buffers associated with a
file to be immediately flushed to disk without removing the
data from the cache.
<p>
<code>object_id</code> can be any object associated with the file,
including the file itself, a dataset, a group, an attribute, or
a named data type.
<p>
<code>scope</code> specifies whether the scope of the flushing
action is global or local. Valid values are
<center>
<table border=0>
<tr><td align=left valign=top><code>H5F_SCOPE_GLOBAL</code></td>
<td> </td>
<td align=left valign=top>Flushes the entire virtual file.</td></tr>
<tr><td align=left valign=top><code>H5F_SCOPE_LOCAL</code></td>
<td></td>
<td align=left valign=top>Flushes only the specified file.</td></tr>
</table>
</center>
<dt><strong>Note:</strong>
<dd>HDF5 does not possess full control over buffering.
<code>H5Fflush</code> flushes the internal HDF5 buffers then
asks the operating system (the OS) to flush the system buffers for the
open files. After that, the OS is responsible for ensuring that
the data is actually flushed to disk.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t </em><code>object_id</code></td>
<td valign="top">IN: Identifier of object used to identify the file.</td></tr>
<tr>
<td valign="top"><em>H5F_scope_t</em> <code>scope </code></td>
<td valign="top">IN: Specifies the scope of the flushing action.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fflush_f
<dd>
<pre>
SUBROUTINE h5fflush_f(obj_id, new_file_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
INTEGER, INTENT(IN) :: scope ! Flag with two possible values:
! H5F_SCOPE_GLOBAL_F
! H5F_SCOPE_LOCAL_F
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fflush_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_access_plist" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetAccessPlist">H5Fget_access_plist</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Fget_access_plist</code>(<em>hid_t</em> <code>file_id</code>)
<dt><strong>Purpose:</strong>
<dd>Returns a file access property list identifier.
<dt><strong>Description:</strong>
<dd><code>H5Fget_access_plist</code> returns the
file access property list identifier of the specified file.
<p>
See "File Access Properties" in
<a href="RM_H5P.html">H5P: Property List Interface</a>
in this reference manual and
"File Access Property Lists"
in <a href="Files.html"><cite>Files</cite></a> in the
<cite>HDF5 User's Guide</cite> for
additional information and related functions.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of file to get access property list of</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a file access property list identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_access_plist_f
<dd>
<pre>
SUBROUTINE h5fget_access_plist_f(file_id, fcpl_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER(HID_T), INTENT(OUT) :: fapl_id ! File access property list identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_access_plist_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_create_plist" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetCreatePlist">H5Fget_create_plist</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Fget_create_plist</code>(<em>hid_t</em> <code>file_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns a file creation property list identifier.
<dt><strong>Description:</strong>
<dd><code>H5Fget_create_plist</code> returns a file creation
property list identifier identifying the creation properties
used to create this file. This function is useful for
duplicating properties when creating another file.
<p>
See "File Creation Properties" in
<a href="RM_H5P.html">H5P: Property List Interface</a>
in this reference manual and
"File Creation Properties"
in <a href="Files.html"><cite>Files</cite></a> in the
<cite>HDF5 User's Guide</cite> for
additional information and related functions.
<dt><strong>Parameters:</strong>
<ul><table>
<dt>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of the file to get creation property list of</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a file creation property list identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_create_plist_f
<dd>
<pre>
SUBROUTINE h5fget_create_plist_f(file_id, fcpl_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER(HID_T), INTENT(OUT) :: fcpl_id ! File creation property list
! identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_create_plist_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_filesize" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetFilesize">H5Fget_filesize</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Fget_filesize</code>(<em>hid_t</em> <code>file_id</code>,
<em>hsize_t *</em><code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the size of an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Fget_filesize</code> returns the size
of the HDF5 file specified by <code>file_id</code>.
<p>
The returned size is that of the entire file,
as opposed to only the HDF5 portion of the file.
I.e., <code>size</code> includes the user block, if any,
the HDF5 portion of the file, and
any data that may have been appended
beyond the data written through the HDF5 Library.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>file_id</code>
<dd>IN: Identifier of a currently-open HDF5 file
<dt><em>hsize_t *</em><code>size</code>
<dd>OUT: Size of the file, in bytes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_freespace_f
<dd>
<pre>
SUBROUTINE h5fget_filesize_f(file_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! file identifier
INTEGER(HSIZE_T), INTENT(OUT) :: size ! Size of the file
INTEGER, INTENT(OUT) :: hdferr ! Error code: 0 on success,
! -1 if fail
END SUBROUTINE h5fget_filesize_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_freespace" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetFreeSpace">H5Fget_freespace</a>
<dt><strong>Signature:</strong>
<dd><em>hssize_t </em><code>H5Fget_freespace</code>(<em>hid_t</em> <code>file_id</code>)
<dt><strong>Purpose:</strong>
<dd>Returns the amount of free space in a file.
<dt><strong>Description:</strong>
<dd>Given the identifier of an open file, <code>file_id</code>,
<code>H5Fget_freespace</code> returns the amount of space that is
unused by any objects in the file.
<p>
Currently, the HDF5 library only tracks free space in a file from a
file open or create until that file is closed, so this routine will
only report the free space that has been created during that
interval.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of a currently-open HDF5 file</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a the amount of free space in the file if successful;
otherwise returns a negative value.
<dt><strong>Returns:</strong>
<dd>Returns a file creation property list identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_freespace_f
<dd>
<pre>
SUBROUTINE h5fget_freespace_f(file_id, free_space, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER(HSSIZE_T), INTENT(OUT) :: free_space ! Amount of free space in file
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_freespace_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_mdc_config" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetMdcConfig">H5Fget_mdc_config</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Fget_mdc_config</code>(<em>hid_t</em>
<code>file_id</code>, <em>H5AC_cache_config_t *</em><code>config_ptr</code>)
<dt><strong>Purpose:</strong>
<dd>Obtain current metadata cache configuration for target file.
<dt><strong>Description:</strong>
<dd><code>H5Fget_mdc_config</code> loads the current metadata cache
configuration into the instance of <code>H5AC_cache_config_t</code>
pointed to by the <code>config_ptr</code> parameter.
<p>Note that the version field of *<code>config_ptr</code> must
be initialized --this allows the library to support old versions
of the <code>H5AC_cache_config_t</code> structure.
<p>See the overview of the metadata cache in the special topics section
of the user manual for details on metadata cache configuration.
If you haven't read and understood that documentation, the results
of this call will not make much sense.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of the target file</td></tr>
<tr>
<td valign="top"><em>H5AC_cache_config_t *</em><code>config_ptr</code> </td>
<td valign="top">IN/OUT: Pointer to the instance of H5AC_cache_config_t
in which the current metadata cache configuration is to be reported.
The fields of this structure are discussed below:</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>General configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>int</em> <code>version</code> </td>
<td valign="top">IN: Integer field indicating the the version
of the H5AC_cache_config_t in use. This field should be
set to H5AC__CURR_CACHE_CONFIG_VERSION
(defined in H5ACpublic.h).</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>rpt_fcn_enabled</code> </td>
<td valign="top">OUT: Boolean flag indicating whether the adaptive
cache resize report function is enabled. This field should almost
always be set to FALSE. Since resize algorithm activity is reported
via stdout, it MUST be set to FALSE on Windows machines.
<p>The report function is not supported code, and can be
expected to change between versions of the library.
Use it at your own risk.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>set_initial_size</code> </td>
<td valign="top">OUT: Boolean flag indicating whether the cache
should be created with a user specified initial maximum size.
<p>If the configuration is loaded from the cache,
this flag will always be FALSE.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>initial_size</code> </td>
<td valign="top">OUT: Initial maximum size of the cache in bytes,
if applicable.
<p>If the configuration is loaded from the cache, this
field will contain the cache maximum size as of the
time of the call.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>min_clean_fraction</code> </td>
<td valign="top">OUT: This field is only used in the parallel
version of the library. It specifies the minimum fraction
of the cache that must be kept either clean or
empty when possible.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_size</code> </td>
<td valign="top">OUT: Upper bound (in bytes) on the range of
values that the adaptive cache resize code can select as
the maximum cache size.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>min_size</code> </td>
<td valign="top">OUT: Lower bound (in bytes) on the range
of values that the adaptive cache resize code can
select as the maximum cache size.</td></tr>
<tr>
<td valign="top"><em>long int</em> <code>epoch_length</code> </td>
<td valign="top">OUT: Number of cache accesses between runs
of the adaptive cache resize code.</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>Increment configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>enum H5C_cache_incr_mode</em> <code>incr_mode</code> </td>
<td valign="top">OUT: Enumerated value indicating the operational
mode of the automatic cache size increase code. At present,
only the following values are legal:
<p>H5C_incr__off: Automatic cache size increase is disabled.
<p>H5C_incr__threshold: Automatic cache size increase is
enabled using the hit rate threshold algorithm.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>lower_hr_threshold</code> </td>
<td valign="top">OUT: Hit rate threshold used in the hit rate
threshold cache size increase algorithm.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>increment</code> </td>
<td valign="top">OUT: The factor by which the current maximum
cache size is multiplied to obtain an initial new maximum cache
size if a size increase is triggered in the hit rate
threshold cache size increase algorithm.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_max_increment</code> </td>
<td valign="top">OUT: Boolean flag indicating whether an upper
limit will be applied to the size of cache size increases.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_increment</code> </td>
<td valign="top">OUT: The maximum number of bytes by which the
maximum cache size can be increased in a single step -- if
applicable.</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>Decrement configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>enum H5C_cache_decr_mode</em> <code>decr_mode</code> </td>
<td valign="top">OUT: Enumerated value indicating the operational
mode of the automatic cache size decrease code. At present,
the following values are legal:
<p>H5C_decr__off: Automatic cache size decrease is disabled,
and the remaining decrement fields are ignored.
<p>H5C_decr__threshold: Automatic cache size decrease is
enabled using the hit rate threshold algorithm.
<p>H5C_decr__age_out: Automatic cache size decrease is enabled
using the ageout algorithm.
<p>H5C_decr__age_out_with_threshold: Automatic cache size
decrease is enabled using the ageout with hit rate
threshold algorithm</td></tr>
<tr>
<td valign="top"><em>double</em> <code>upper_hr_threshold</code> </td>
<td valign="top">OUT: Upper hit rate threshold. This value is only
used if the decr_mode is either H5C_decr__threshold or
H5C_decr__age_out_with_threshold.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>decrement</code> </td>
<td valign="top">OUT: Factor by which the current max cache size
is multiplied to obtain an initial value for the new cache
size when cache size reduction is triggered in the hit rate
threshold cache size reduction algorithm.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_max_decrement</code> </td>
<td valign="top">OUT: Boolean flag indicating whether an upper
limit should be applied to the size of cache size
decreases.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_decrement</code> </td>
<td valign="top">OUT: The maximum number of bytes by which cache
size can be decreased if any single step, if applicable.</td></tr>
<tr>
<td valign="top"><em>int</em> <code>epochs_before_eviction</code> </td>
<td valign="top">OUT: The minimum number of epochs that an entry
must reside unaccessed in cache before being evicted under
either of the ageout cache size reduction algorithms.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_empty_reserve</code> </td>
<td valign="top">OUT: Boolean flag indicating whether an empty
reserve should be maintained under either of the ageout
cache size reduction algorithms.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>empty_reserve</code> </td>
<td valign="top">OUT: Empty reserve for use with the ageout
cache size reduction algorithms, if applicable.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful; otherwise returns a negative value.
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_mdc_hit_rate" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetMdcHitRate">H5Fget_mdc_hit_rate</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Fget_mdc_hit_rate</code>(<em>hid_t</em>
<code>file_id</code>, <em>double *</em><code>hit_rate_ptr</code>)
<dt><strong>Purpose:</strong>
<dd>Obtain target file's metadata cache hit rate.
<dt><strong>Description:</strong>
<dd>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. If the cache has
not been accessed since the last time the hit rate stats were reset,
the hit rate is defined to be 0.0.
<p>The hit rate stats can be reset either manually (via
H5Freset_mdc_hit_rate_stats()), or automatically. If the cache's
adaptive resize code is enabled, the hit rate stats will be reset
once per epoch. If they are reset manually as well,
the cache may behave oddly.
<p>See the overview of the metadata cache in the special
topics section of the user manual for details on the metadata
cache and its adaptive resize algorithms.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code>
</td>
<td valign="top">IN: Identifier of the target file.</td></tr>
<tr>
<td valign="top"><em>double *</em> <code>hit_rate_ptr</code>
</td>
<td valign="top">OUT: Pointer to the double in which the
hit rate is returned. Note that *<code>hit_rate_ptr</code> is
undefined if the API call fails.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful; otherwise
returns a negative value.
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_mdc_size" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetMdcSize">H5Fget_mdc_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Fget_mdc_size</code>(<em>hid_t</em> <code>file_id</code>,
<em>size_t *</em><code>max_size_ptr</code>,
<em>size_t *</em><code>min_clean_size_ptr</code>,
<em>size_t *</em><code>cur_size_ptr</code>,
<em>int *</em><code>cur_num_entries_ptr</code>)
<dt><strong>Purpose:</strong>
<dd>Obtain current metadata cache size data for specified file.
<dt><strong>Description:</strong>
<dd>H5Fget_mdc_size queries the metadata cache of the target file
for the desired size information, and returns this information in
the locations indicated by the pointer parameters. If any pointer
parameter is NULL, the associated data is not returned.
<p>If the API call fails, the values returned via the pointer
parameters are undefined.
<p>If adaptive cache resizing is enabled, the cache maximum size
and minimum clean size may change at the end of each epoch. Current
size and current number of entries can change on each cache access.
<p>Current size can exceed maximum size under certain conditions.
See the overview of the metadata cache in the special topics
section of the user manual for a discussion of this.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code>
</td>
<td valign="top">IN: Identifier of the target file.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>max_size_ptr</code>
</td>
<td valign="top">OUT: Pointer to the location in which the
current cache maximum size is to be returned, or NULL if
this datum is not desired.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>min_clean_size_ptr</code>
</td>
<td valign="top">OUT: Pointer to the location in which the
current cache minimum clean size is to be returned, or
NULL if that datum is not desired.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>cur_size_ptr</code>
</td>
<td valign="top">OUT: Pointer to the location in which the
current cache size is to be returned, or NULL if that
datum is not desired.</td></tr>
<tr>
<td valign="top"><em>int *</em><code>cur_num_entries_ptr</code>
</td>
<td valign="top">OUT: Pointer to the location in which the
current number of entries in the cache is to be returned,
or NULL if that datum is not desired.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful; otherwise returns a
negative value.
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_name" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetName">H5Fget_name</a>
<dt><strong>Signature:</strong>
<dd><em>ssize_t</em> <code>H5Fget_name</code>(<em>hid_t</em> <code>obj_id</code>,
<em>char *</em><code>name</code>,
<em>size_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves name of file to which object belongs.
<dt><strong>Description:</strong>
<dd><code>H5Fget_name</code> retrieves the name of the file
to which the object <code>obj_id</code> belongs.
The object can be a group, dataset, attribute, or
named datatype.
<p>
Up to <code>size</code> characters of the filename
are returned in <code>name</code>;
additional characters, if any, are not returned to
the user application.
<p>
If the length of the name,
which determines the required value of <code>size</code>,
is unknown, a preliminary <code>H5Fget_name</code> call
can be made by setting <code>name</code> to NULL.
The return value of this call will be the size of the filename;
that value can then be assigned to <code>size</code>
for a second <code>H5Fget_name</code> call,
which will retrieve the actual name.
<p>
If an error occurs, the buffer pointed to by
<code>name</code> is unchanged and
the function returns a negative value.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>obj_id</code>
<dd>IN: Identifier of the object for which the
associated filename is sought.
The object can be a group, dataset, attribute, or
named datatype.
<dt><em>char *</em><code>name</code>
<dd>OUT: Buffer to contain the returned filename.
<dt><em>size_t</em> <code>size</code>
<dd>IN: Size, in bytes, of the <code>name</code> buffer.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the length of the filename if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_name_f
<dd>
<pre>
SUBROUTINE h5fget_name_f(obj_id, buf, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
CHARACTER(LEN=*), INTENT(INOUT) :: buf ! Buffer to hold filename
INTEGER(SIZE_T), INTENT(OUT) :: size ! Size of the filename
INTEGER, INTENT(OUT) :: hdferr ! Error code: 0 on success,
! -1 if fail
END SUBROUTINE h5fget_name_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_obj_count" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetObjCount">H5Fget_obj_count</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Fget_obj_count</code>(<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the number of open object identifiers for an open file.
<dt><strong>Description:</strong>
<dd>Given the identifier of an open file, <code>file_id</code>,
and the desired object types, <code>types</code>,
<code>H5Fget_obj_count</code> returns the number of
open object identifiers for the file.
<p>
To retrieve a count of open identifiers for open objects in
all HDF5 application files that are currently open,
pass the value <code>H5F_OBJ_ALL</code> in <code>file_id</code>.
<p>
The types of objects to be counted are specified
in <code>types</code> as follows:
<center>
<table width=90% border=0>
<tr><td valign=top>
<code>H5F_OBJ_FILE</code>
</td><td valign=top>
Files only
</td></tr><tr><td valign=top>
<code>H5F_OBJ_DATASET</code>
</td><td valign=top>
Datasets only
</td></tr><tr><td valign=top>
<code>H5F_OBJ_GROUP</code>
</td><td valign=top>
Groups only
</td></tr><tr><td valign=top>
<code>H5F_OBJ_DATATYPE </code>
</td><td valign=top>
Named datatypes only
</td></tr><tr><td valign=top>
<code>H5F_OBJ_ATTR </code>
</td><td valign=top>
Attributes only
</td></tr><tr><td valign=top>
<code>H5F_OBJ_ALL</code>
</td><td valign=top>
All of the above
<br>
(I.e., <code>H5F_OBJ_FILE</code> | <code>H5F_OBJ_DATASET</code> |
<code>H5F_OBJ_GROUP</code> | <code>H5F_OBJ_DATATYPE</code>
| <code>H5F_OBJ_ATTR</code> )
</td></tr>
</table>
</center>
Multiple object types can be combined with the
logical <code>OR</code> operator (<code>|</code>).
For example, the expression <code>(H5F_OBJ_DATASET|H5F_OBJ_GROUP)</code> would call for
datasets and groups.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code></td>
<td valign="top">IN: Identifier of a currently-open HDF5 file or
<code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr>
<tr>
<td valign="top"><em>unsigned int</em> <code>types </code></td>
<td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a the number of open objects if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_obj_count_f
<dd>
<pre>
SUBROUTINE h5fget_obj_count_f(file_id, obj_type, obj_count, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER, INTENT(IN) :: obj_type ! Object types, possible values are:
! H5F_OBJ_FILE_F
! H5F_OBJ_GROUP_F
! H5F_OBJ_DATASET_F
! H5F_OBJ_DATATYPE_F
! H5F_OBJ_ALL_F
INTEGER, INTENT(OUT) :: obj_count ! Number of opened objects
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_obj_count_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_obj_ids" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetObjIDs">H5Fget_obj_ids</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Fget_obj_ids</code>(<em>hid_t</em> <code>file_id</code>,
<em>unsigned int</em> <code>types</code>,
<em>int</em> <code>max_objs</code>,
<em>hid_t *</em><code>obj_id_list</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns a list of open object identifiers.
<dt><strong>Description:</strong>
<dd>Given the file identifier <code>file_id</code> and
the type of objects to be identified, <code>types</code>,
<code>H5Fget_obj_ids</code> returns the list of identifiers
for all open HDF5 objects fitting the specified criteria.
<p>
To retrieve identifiers for open objects in all HDF5 application
files that are currently open, pass the value
<code>H5F_OBJ_ALL</code> in <code>file_id</code>.
<p>
The types of object identifiers to be retrieved are specified
in <code>types</code> using the codes listed for the same
parameter in <a href="#File-GetObjCount"><code>H5Fget_obj_count</code></a>
<p>
To retrieve identifiers for all open objects, pass a negative value
for the <code>max_objs</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code></td>
<td valign="top">IN: Identifier of a currently-open HDF5 file or
<code>H5F_OBJ_ALL</code> for all currently-open HDF5 files.</td></tr>
<tr>
<td valign="top"><em>unsigned int</em> <code>types</code></td>
<td valign="top">IN: Type of object for which identifiers are to be returned.</td></tr>
<tr>
<td valign="top"><em>int</em> <code>max_objs</code></td>
<td valign="top">IN: Maximum number of object identifiers to place into
<code>obj_id_list</code>.</td></tr>
<tr>
<td valign="top"><em>hid_t *</em><code>obj_id_list </code></td>
<td valign="top">OUT: Pointer to the returned list of open object identifiers.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns number of objects placed into <code>obj_id_list</code> if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fget_obj_ids_f
<dd>
<pre>
SUBROUTINE h5fget_obj_ids_f(file_id, obj_type, max_objs, obj_ids, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER, INTENT(IN) :: obj_type ! Object types, possible values are:
! H5F_OBJ_FILE_F
! H5F_OBJ_GROUP_F
! H5F_OBJ_DATASET_F
! H5F_OBJ_DATATYPE_F
! H5F_OBJ_ALL_F
INTEGER, INTENT(IN) :: max_objs ! Maximum number of object
! identifiers to retrieve
INTEGER(HID_T), DIMENSION(*), INTENT(OUT) :: obj_ids
! Array of requested object
! identifiers
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fget_obj_ids_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fget_vfd_handle" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetVfdHandle">H5Fget_vfd_handle</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Fget_vfd_handle</code>(<em>hid_t</em> <code>file_id</code>,
<em>hid_t</em> <code>fapl_id</code>,
<em>void *</em><code>file_handle</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns pointer to the file handle from the virtual file driver.
<dt><strong>Description:</strong>
<dd>Given the file identifier <code>file_id</code> and
the file access property list <code>fapl_id</code>,
<code>H5Fget_vfd_handle</code> returns a pointer to the file handle
from the low-level file driver currently being used by the
HDF5 library for file I/O.
<dt><strong>Notes:</strong>
<dd>Users are not supposed to modify any file through this file handle.
<p>
This file handle is dynamic and is valid only while the file remains
open; it will be invalid if the file is closed and reopened or
opened during a subsequent session.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code></td>
<td valign="top">IN: Identifier of the file to be queried.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>fapl_id</code></td>
<td valign="top">IN: File access property list identifier.
For most drivers, the value will be <code>H5P_DEFAULT</code>.
For the <code>FAMILY</code> or <code>MULTI</code> drivers,
this value should be defined through the property list
functions:
<code>H5Pset_family_offset</code> for the <code>FAMILY</code>
driver and <code>H5Pset_multi_type</code> for the
<code>MULTI</code> driver.</td></tr>
<tr>
<td valign="top"><em>void *</em><code>file_handle </code></td>
<td valign="top">OUT: Pointer to the file handle being used by
the low-level virtual file driver.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fis_hdf5" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a>
<dt><strong>Signature:</strong>
<dd><em>htri_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code>
)
<dt><strong>Purpose:</strong>
<dd>Determines whether a file is in the HDF5 format.
<dt><strong>Description:</strong>
<dd><code>H5Fis_hdf5</code> determines whether a file is in
the HDF5 format.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>const char *</em><code>name </code></td>
<td valign="top">IN: File name to check format.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>When successful, returns a positive value, for <code>TRUE</code>,
or <code>0</code> (zero), for <code>FALSE</code>.
Otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fis_hdf5_f
<dd>
<pre>
SUBROUTINE h5fis_hdf5_f(name, status, hdferr)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
LOGICAL, INTENT(OUT) :: status ! This parameter indicates
! whether file is an HDF5 file
! ( TRUE or FALSE )
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fis_hdf5_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fmount" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Mount">H5Fmount</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Fmount</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em><code>name</code>,
<em>hid_t</em> <code>child_id</code>,
<em>hid_t</em> <code>plist_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Mounts a file.
<dt><strong>Description:</strong>
<dd><code>H5Fmount</code> mounts the file specified by
<code>child_id</code> onto the group specified by
<code>loc_id</code> and <code>name</code> using
the mount properties <code>plist_id</code>.
<p>
Note that <code>loc_id</code> is either a file or group identifier
and <code>name</code> is relative to <code>loc_id</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>loc_id</code></td>
<td valign="top">IN: Identifier for of file or group in
which <code>name</code> is defined.</td>
<tr>
<td valign="top"><em>const char *</em><code>name </code></td>
<td valign="top">IN: Name of the group onto which the
file specified by <code>child_id</code>
is to be mounted.</td>
<tr>
<td valign="top"><em>hid_t</em> <code>child_id</code></td>
<td valign="top">IN: Identifier of the file to be mounted.</td>
<tr>
<td valign="top"><em>hid_t</em> <code>plist_id</code></td>
<td valign="top">IN: Identifier of the property list to be used.</td>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fmount_f
<dd>
<pre>
SUBROUTINE h5fmount_f(loc_id, name, child_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN):: name ! Group name at locationloc_id
INTEGER(HID_T), INTENT(IN) :: child_id ! File(to be mounted) identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5fmount_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fopen" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Open">H5Fopen</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Fopen</code>(<em>const char *</em><code>name</code>,
<em>unsigned</em> <code>flags</code>,
<em>hid_t</em> <code>access_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Opens an existing file.
<dt><strong>Description:</strong>
<dd><code>H5Fopen</code> opens an existing file and is the primary
function for accessing existing HDF5 files.
<p>
The parameter <code>access_id</code> is a file access property
list identifier or <code>H5P_DEFAULT</code> if the
default I/O access parameters are to be used
<p>
The <code>flags</code> argument determines whether writing
to an existing file will be allowed.
The file is opened with read and write permission if
<code>flags</code> is set to <code>H5F_ACC_RDWR</code>.
All flags may be combined with the bit-wise OR operator (`|')
to change the behavior of the file open call.
More complex behaviors of file access are controlled
through the file-access property list.
<p>
The return value is a file identifier for the open file;
this file identifier should be closed by calling
<code>H5Fclose</code> when it is no longer needed.
<p>
<b>Special case -- Multiple opens:</b>
<br>
A file can often be opened with a new <code>H5Fopen</code>
call without closing an already-open identifier established
in a previous <code>H5Fopen</code> or <code>H5Fcreate</code>
call. Each such <code>H5Fopen</code> call will return a
unique identifier and the file can be accessed through any
of these identifiers as long as the identifier remains valid.
In such multiply-opened cases, all the open calls should
use the same <code>flags</code> argument.
<p>
In some cases, such as files on a local Unix file system,
the HDF5 library can detect that a file is multiply opened and
will maintain coherent access among the file identifiers.
<p>
But in many other cases, such as parallel file systems or
networked file systems, it is not always possible to detect
multiple opens of the same physical file.
In such cases, HDF5 will treat the file identifiers
as though they are accessing different files and
will be unable to maintain coherent access.
Errors are likely to result in these cases.
While unlikely, the HDF5 library may not be able to detect,
and thus report, such errors.
<p>
It is generally recommended that applications avoid
multiple opens of the same file.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>const char *</em><code>name </code></td>
<td valign="top">IN: Name of the file to access.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>flags</code></td>
<td valign="top">IN: File access flags. Allowable values are:
<ul><dl>
<dt><code>H5F_ACC_RDWR</code>
<dd>Allow read and write access to file.
<dt><code>H5F_ACC_RDONLY</code>
<dd>Allow read-only access to file.
</dl>
<li><code>H5F_ACC_RDWR</code> and <code>H5F_ACC_RDONLY</code>
are mutually exclusive; use exactly one.
<li>An additional flag, <code>H5F_ACC_DEBUG</code>, prints
debug information. This flag is used only by HDF5 library
developers; it is neither tested nor supported
for use in applications.
</ul></td></tr>
<!-- NEW PAGE -->
<tr>
<td valign="top"><em>hid_t</em> <code>access_id </code></td>
<td valign="top">IN: Identifier for the file access properties list.
If parallel file access is desired, this is a collective
call according to the communicator stored in the
<code>access_id</code>.
Use <code>H5P_DEFAULT</code> for default file access properties.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a file identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5fopen_f
<dd>
<pre>
SUBROUTINE h5fopen_f(name, access_flags, file_id, hdferr, &
access_prp)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the file
INTEGER, INTENT(IN) :: access_flag ! File access flags
! Possible values are:
! H5F_ACC_RDWR_F
! H5F_ACC_RDONLY_F
INTEGER(HID_T), INTENT(OUT) :: file_id ! File identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: access_prp
! File access property list
! identifier
END SUBROUTINE h5fopen_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Freopen" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Reopen">H5Freopen</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Freopen</code>(<em>hid_t</em> <code>file_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns a new identifier for a previously-opened HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Freopen</code> returns a new file identifier for an
already-open HDF5 file, as specified by <code>file_id</code>.
Both identifiers share caches and other information.
The only difference between the identifiers is that the
new identifier is not mounted anywhere and no files are
mounted on it.
<p>
Note that there is no circumstance under which
<code>H5Freopen</code> can actually open a closed file;
the file must already be open and have an active
<code>file_id</code>. E.g., one cannot close a file with
<code> H5Fclose (file_id) </code> then use
<code> H5Freopen (file_id) </code> to reopen it.
<p>
The new file identifier should be closed by calling
<code>H5Fclose</code> when it is no longer needed.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of a file for which an additional identifier
is required.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a new file identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5freopen_f
<dd>
<pre>
SUBROUTINE h5freopen_f(file_id, new_file_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: file_id ! File identifier
INTEGER(HID_T), INTENT(OUT) :: new_file_id ! New file identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5freopen_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Freset_mdc_hit_rate_stats" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-ResetMdcHitRateStats">H5Freset_mdc_hit_rate_stats</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Freset_mdc_hit_rate_stats</code>(<em>hid_t</em>
<code>file_id</code>)
<dt><strong>Purpose:</strong>
<dd>Reset hit rate statistics counters for the target file.
<dt><strong>Description:</strong>
<dd>H5Freset_mdc_hit_rate_stats resets the hit rate statistics
counters in the metadata cache associated with the specified
file.
<p>If the adaptive cache resizing code is enabled, the hit
rate statistics are reset at the beginning of each epoch.
This API call allows you to do the same thing from your program.
<p>The adaptive cache resizing code may behave oddly if you use
this call when adaptive cache resizing is enabled. However,
the call should be useful if you choose to control metadata
cache size from your program.
<p>See the overview of the metadata cache in the special topics
section of the user manual for details of the metadata cache and
the adaptive cache resizing algorithms. If you haven't read,
understood, and thought about the material covered in that
documentation, you shouldn't be using this API call.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id </code></td>
<td valign="top">IN: Identifier of the target file.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful; otherwise returns a
negative value.
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Fset_mdc_config" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-SetMdcConfig">H5Fset_mdc_config</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Fset_mdc_config</code>(<em>hid_t</em>
<code>file_id</code>, <em>H5AC_cache_config_t *</em><code>config_ptr</code>)
<dt><strong>Purpose:</strong>
<dd>Attempt to configure metadata cache of target file.
<dt><strong>Description:</strong>
<dd>H5Fset_mdc_config attempts to configure the file's metadata cache
according configuration supplied in *config_ptr.
<p>See the overview of the metadata cache in the special topics
section of the user manual for details on what is being configured.
If you haven't read and understood that documentation, you really
shouldn't be using this API call.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>file_id</code>
</td>
<td valign="top">IN: Identifier of the target file</td></tr>
<tr>
<td valign="top"><em>H5AC_cache_config_t *</em><code>config_ptr</code>
</td>
<td valign="top">IN: Pointer to the instance of H5AC_cache_config_t
containing the desired configuration. The fields of this structure
are discussed below:</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>General configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>int</em> <code>version</code>
</td>
<td valign="top">IN: Integer field indicating the the version of
the H5AC_cache_config_t in use. This field should be set to
H5AC__CURR_CACHE_CONFIG_VERSION (defined in H5ACpublic.h).</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>rpt_fcn_enabled</code>
</td>
<td valign="top">IN: Boolean flag indicating whether the adaptive
cache resize report function is enabled. This field should almost
always be set to FALSE. Since resize algorithm activity is reported
via stdout, it MUST be set to FALSE on Windows machines.
<p>The report function is not supported code, and can be expected to
change between versions of the library. Use it at your own risk.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>set_initial_size</code>
</td>
<td valign="top">IN: Boolean flag indicating whether the cache should be
forced to the user specified initial size.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>initial_size</code>
</td>
<td valign="top">IN: If set_initial_size is TRUE, initial_size must
contains the desired initial size in bytes. This value must lie
in the closed interval [min_size, max_size]. (see below)</td></tr>
<tr>
<td valign="top"><em>double</em> <code>min_clean_fraction</code>
</td>
<td valign="top">IN: This field is only used in the parallel version
of the library. It specifies the minimum fraction of the cache that
must be kept either clean or empty.
<p>The value must lie in the interval [0.0, 1.0]. 0.25 is a good place
to start.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_size</code>
</td>
<td valign="top">IN: Upper bound (in bytes) on the range of values
that the adaptive cache resize code can select as the maximum
cache size.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>min_size</code>
</td>
<td valign="top">IN: Lower bound (in bytes) on the range of values
that the adaptive cache resize code can select as the maximum
cache size.</td></tr>
<tr>
<td valign="top"><em>long int</em> <code>epoch_length</code>
</td>
<td valign="top">IN: Number of cache accesses between runs of the
adaptive cache resize code. 50,000 is a good starting number.</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>Increment configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>enum H5C_cache_incr_mode</em> <code>incr_mode</code>
</td>
<td valign="top">IN: Enumerated value indicating the operational mode
of the automatic cache size increase code. At present, only two
values are legal:
<p>H5C_incr__off: Automatic cache size increase is disabled,
and the remaining increment fields are ignored.
<p>H5C_incr__threshold: Automatic cache size increase is enabled
using the hit rate threshold algorithm.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>lower_hr_threshold</code>
</td>
<td valign="top">IN: Hit rate threshold used by the hit rate threshold
cache size increment algorithm.
<p>When the hit rate over an epoch is below this threshold and the
cache is full, the maximum size of the cache is multiplied by
increment (below), and then clipped as necessary to stay within
max_size, and possibly max_increment.
<p>This field must lie in the interval [0.0, 1.0]. 0.8 or 0.9
is a good starting point.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>increment</code>
</td>
<td valign="top">IN: Factor by which the hit rate threshold cache
size increment algorithm multiplies the current cache max size
to obtain a tentative new cache size.
<p>The actual cache size increase will be clipped to satisfy the
max_size specified in the general configuration, and possibly
max_increment below.
<p>The parameter must be greater than or equal to 1.0 -- 2.0
is a reasonable value.
<p>If you set it to 1.0, you will effectively disable cache size
increases.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_max_increment</code>
</td>
<td valign="top">IN: Boolean flag indicating whether an upper limit
should be applied to the size of cache size increases.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_increment</code>
</td>
<td valign="top">IN: Maximum number of bytes by which cache size can
be increased in a single step -- if applicable.</td></tr>
<tr>
<td colspan="2"> </td>
</tr>
<tr>
<td colspan="2"><strong>Decrement configuration section:</strong></td>
</tr>
<tr>
<td valign="top"><em>enum H5C_cache_decr_mode</em> <code>decr_mode</code>
</td>
<td valign="top">IN: Enumerated value indicating the operational
mode of the automatic cache size decrease code. At present,
the following values are legal:
<p>H5C_decr__off: Automatic cache size decrease is disabled.
<p>H5C_decr__threshold: Automatic cache size decrease is
enabled using the hit rate threshold algorithm.
<p>H5C_decr__age_out: Automatic cache size decrease is enabled
using the ageout algorithm.
<p>H5C_decr__age_out_with_threshold: Automatic cache size
decrease is enabled using the ageout with hit rate threshold
algorithm</td></tr>
<tr>
<td valign="top"><em>double</em> <code>upper_hr_threshold</code>
</td>
<td valign="top">IN: Hit rate threshold for the hit rate threshold and
ageout with hit rate threshold cache size decrement algorithms.
<p>When decr_mode is H5C_decr__threshold, and the hit rate over a
given epoch exceeds the supplied threshold, the current maximum
cache size is multiplied by decrement to obtain a tentative new
(and smaller) maximum cache size.
<p>When decr_mode is H5C_decr__age_out_with_threshold, there is no
attempt to find and evict aged out entries unless the hit rate in
the previous epoch exceeded the supplied threshold.
<p>This field must lie in the interval [0.0, 1.0].
<p>For H5C_incr__threshold, .9995 or .99995 is a good place to start.
<p>For H5C_decr__age_out_with_threshold, .999 might be
more useful.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>decrement</code>
</td>
<td valign="top">IN: In the hit rate threshold cache size decrease
algorithm, this parameter contains the factor by which the
current max cache size is multiplied to produce a tentative
new cache size.
<p>The actual cache size decrease will be clipped to satisfy the
min_size specified in the general configuration, and possibly
max_decrement below.
<p>The parameter must be be in the interval [0.0, 1.0].
<p>If you set it to 1.0, you will effectively disable cache size
decreases. 0.9 is a reasonable starting point.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_max_decrement</code>
</td>
<td valign="top">IN: Boolean flag indicating whether an upper limit
should be applied to the size of cache size decreases.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>max_decrement</code>
</td>
<td valign="top">IN: Maximum number of bytes by which the maximum cache
size can be decreased in any single step -- if applicable.</td></tr>
<tr>
<td valign="top"><em>int</em> <code>epochs_before_eviction</code>
</td>
<td valign="top">IN: In the ageout based cache size reduction algorithms,
this field contains the minimum number of epochs an entry must remain
unaccessed in cache before the cache size reduction algorithm tries to
evict it. 3 is a reasonable value.</td></tr>
<tr>
<td valign="top"><em>hbool_t</em> <code>apply_empty_reserve</code>
</td>
<td valign="top">IN: Boolean flag indicating whether the ageout based
decrement algorithms will maintain a empty reserve when decreasing
cache size.</td></tr>
<tr>
<td valign="top"><em>double</em> <code>empty_reserve</code>
</td>
<td valign="top">IN: Empty reserve as a fraction of maximum cache
size if applicable.
<p>When so directed, the ageout based algorithms will not decrease
the maximum cache size unless the empty reserve can be met.
<p>The parameter must lie in the interval [0.0, 1.0].
0.1 or 0.05 is a good place to start.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful; otherwise returns a
negative value.
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Funmount" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Unmount">H5Funmount</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Funmount</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em><code>name</code>
)
<dt><strong>Purpose:</strong>
<dd>Unmounts a file.
<dt><strong>Description:</strong>
<dd>Given a mount point, <code>H5Funmount</code>
dissassociates the mount point's file
from the file mounted there. This function
does not close either file.
<p>
The mount point can be either the group in the
parent or the root group of the mounted file
(both groups have the same name). If the mount
point was opened before the mount then it is the
group in the parent; if it was opened after the
mount then it is the root group of the child.
<p>
Note that <code>loc_id</code> is either a file or group identifier
and <code>name</code> is relative to <code>loc_id</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>loc_id</code></td>
<td valign="top">IN: File or group identifier for the location at which
the specified file is to be unmounted.</td></tr>
<tr>
<td valign="top"><em>const char *</em><code>name </code></td>
<td valign="top">IN: Name of the mount point.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5funmount_f
<dd>
<pre>
SUBROUTINE h5funmount_f(loc_id, name, child_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN):: name ! Group name at location loc_id
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5funmount_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5im.html">H5IM</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5lt.html">H5LT</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5pt.html">H5PT</a>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/hdf5_hl/doc/RM_hdf5tb.html">H5TB</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<a href="RM_H5P.html">H5P</a>
<br>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 24 August 2004");
-->
</SCRIPT>
</body>
</html>
|
