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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Groups (H5G)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.f39b228</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___h5_g.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Groups (H5G)</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use the functions in this module to manage HDF5 groups.</p>
<table class="doxtable">
<tr>
<th>Create</th><th>Read </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  {</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  __label__ fail_group, fail_prop, fail_lcpl, fail_file;</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, lcpl, group;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">char</span> fname[] = <span class="stringliteral">"g1.h5"</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/αυτή/είναι/μια/νέα/ομάδα"</span>;</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(fname, <a class="code" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordflow">if</span> ((lcpl = <a class="code" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code" href="_h5_ppublic_8h.html#ad2c1d10104f0262c826350ccbf7c49f2">H5P_LINK_CREATE</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordflow">goto</span> fail_lcpl;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  }</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// ensure that intermediate groups are created automatically</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (<a class="code" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a>(lcpl, 1) < 0) {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">goto</span> fail_prop;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// use UTF-8 encoding for link names</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (<a class="code" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a>(lcpl, <a class="code" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a>) < 0) {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordflow">goto</span> fail_prop;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  }</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// create five groups</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordflow">if</span> ((group = <a class="code" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate</a>(file, path, lcpl, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">goto</span> fail_group;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> fail_group:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> fail_prop:</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(lcpl);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> fail_lcpl:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> fail_file:;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  }</div>
<div class="ttc" id="a_h5_fpublic_8h_html_a5a2d6726f9ad8d2bca8df2b817e5ad6a"><div class="ttname"><a href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a></div><div class="ttdeci">#define H5F_ACC_TRUNC</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:50</div></div>
<div class="ttc" id="a_h5_ipublic_8h_html_a0045db7ff9c22ad35db6ae91662e1943"><div class="ttname"><a href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></div><div class="ttdeci">int64_t hid_t</div><div class="ttdef"><b>Definition:</b> H5Ipublic.h:60</div></div>
<div class="ttc" id="a_h5_ipublic_8h_html_a01eab13dccc91afd6909d74dccb780ba"><div class="ttname"><a href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a></div><div class="ttdeci">#define H5I_INVALID_HID</div><div class="ttdef"><b>Definition:</b> H5Ipublic.h:75</div></div>
<div class="ttc" id="a_h5_ppublic_8h_html_ad2c1d10104f0262c826350ccbf7c49f2"><div class="ttname"><a href="_h5_ppublic_8h.html#ad2c1d10104f0262c826350ccbf7c49f2">H5P_LINK_CREATE</a></div><div class="ttdeci">#define H5P_LINK_CREATE</div><div class="ttdef"><b>Definition:</b> H5Ppublic.h:67</div></div>
<div class="ttc" id="a_h5_ppublic_8h_html_afa85e97bfbf9bf1c58e39263846c568f"><div class="ttname"><a href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a></div><div class="ttdeci">#define H5P_DEFAULT</div><div class="ttdef"><b>Definition:</b> H5Ppublic.h:102</div></div>
<div class="ttc" id="a_h5_tpublic_8h_html_a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658"><div class="ttname"><a href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a></div><div class="ttdeci">@ H5T_CSET_UTF8</div><div class="ttdef"><b>Definition:</b> H5Tpublic.h:96</div></div>
<div class="ttc" id="agroup___a_c_p_l_html_gad4fa8e2d17236786f770cf17eef908cc"><div class="ttname"><a href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a></div><div class="ttdeci">herr_t H5Pset_char_encoding(hid_t plist_id, H5T_cset_t encoding)</div><div class="ttdoc">Sets the character encoding used to encode link and attribute names.</div></div>
<div class="ttc" id="agroup___h5_f_html_gac55cd91d80822e4f8c2a7f04ea71b124"><div class="ttname"><a href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a></div><div class="ttdeci">herr_t H5Fclose(hid_t file_id)</div><div class="ttdoc">Terminates access to an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_f_html_gae64b51ee9ac0781bc4ccc599d98387f4"><div class="ttname"><a href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a></div><div class="ttdeci">hid_t H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id)</div><div class="ttdoc">Creates an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_g_html_ga187cee27a9fc4f1a311eb19b0522c7b8"><div class="ttname"><a href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate</a></div><div class="ttdeci">#define H5Gcreate</div><div class="ttdef"><b>Definition:</b> H5version.h:997</div></div>
<div class="ttc" id="agroup___h5_g_html_ga8dbe20b390d2504f0bd3589ed8f4e221"><div class="ttname"><a href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a></div><div class="ttdeci">herr_t H5Gclose(hid_t group_id)</div><div class="ttdoc">Closes the specified group.</div></div>
<div class="ttc" id="agroup___l_c_p_l_html_ga66c4c5d3f34e5cf65d00e47a5387383c"><div class="ttname"><a href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a></div><div class="ttdeci">herr_t H5Pset_create_intermediate_group(hid_t plist_id, unsigned crt_intmd)</div><div class="ttdoc">Specifies in property list whether to create missing intermediate groups.</div></div>
<div class="ttc" id="agroup___p_l_c_r_html_ga5dce61149211d3ef319452aa598887fb"><div class="ttname"><a href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a></div><div class="ttdeci">herr_t H5Pclose(hid_t plist_id)</div><div class="ttdoc">Terminates access to a property list.</div></div>
<div class="ttc" id="agroup___p_l_c_r_html_gaf1b11da01d4d45d788c45f8bc5f0cbfa"><div class="ttname"><a href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a></div><div class="ttdeci">hid_t H5Pcreate(hid_t cls_id)</div><div class="ttdoc">Creates a new property list as an instance of a property list class.</div></div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  __label__ fail_file;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">char</span> fname[] = <span class="stringliteral">"g1.h5"</span>;</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/αυτή/είναι"</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="struct_h5_g__info__t.html">H5G_info_t</a> info;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(fname, <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// open one of the intermediate groups</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e">H5Gget_info_by_name</a>(file, path, &info, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keywordflow">goto</span> fail_info;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  printf(<span class="stringliteral">"Link count: %llu\n"</span>, info.<a class="code" href="struct_h5_g__info__t.html#ae1a56f51943bb51479442045a6561454">nlinks</a>);</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">switch</span> (info.<a class="code" href="struct_h5_g__info__t.html#a36284d2618eefc8e8408ac6a58d2728a">storage_type</a>) {</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">case</span> <a class="code" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08caa5b612e8bd5597ac58eafd3f42e4d681">H5G_STORAGE_TYPE_COMPACT</a>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  printf(<span class="stringliteral">"Compact storage\n"</span>);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordflow">case</span> <a class="code" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08cae5f0b9b2491abb0a12c3fc4e3c8fdf75">H5G_STORAGE_TYPE_DENSE</a>:</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  printf(<span class="stringliteral">"Compact storage\n"</span>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">case</span> <a class="code" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08ca06c1f3bec70169d1889fc2dd37a606af">H5G_STORAGE_TYPE_SYMBOL_TABLE</a>:</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  printf(<span class="stringliteral">"Symbol table\n"</span>);</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">default</span>:</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  printf(<span class="stringliteral">"UFO\n"</span>);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">break</span>;</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  }</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> fail_info:</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> fail_file:;</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div>
<div class="ttc" id="a_h5_fpublic_8h_html_a1c406ffa89f4acf5a332144a2683d394"><div class="ttname"><a href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a></div><div class="ttdeci">#define H5F_ACC_RDONLY</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:48</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_aaadde411516426f400ed4db91bd8e08ca06c1f3bec70169d1889fc2dd37a606af"><div class="ttname"><a href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08ca06c1f3bec70169d1889fc2dd37a606af">H5G_STORAGE_TYPE_SYMBOL_TABLE</a></div><div class="ttdeci">@ H5G_STORAGE_TYPE_SYMBOL_TABLE</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:43</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_aaadde411516426f400ed4db91bd8e08caa5b612e8bd5597ac58eafd3f42e4d681"><div class="ttname"><a href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08caa5b612e8bd5597ac58eafd3f42e4d681">H5G_STORAGE_TYPE_COMPACT</a></div><div class="ttdeci">@ H5G_STORAGE_TYPE_COMPACT</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:45</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_aaadde411516426f400ed4db91bd8e08cae5f0b9b2491abb0a12c3fc4e3c8fdf75"><div class="ttname"><a href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08cae5f0b9b2491abb0a12c3fc4e3c8fdf75">H5G_STORAGE_TYPE_DENSE</a></div><div class="ttdeci">@ H5G_STORAGE_TYPE_DENSE</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:46</div></div>
<div class="ttc" id="agroup___h5_f_html_gaa3f4f877b9bb591f3880423ed2bf44bc"><div class="ttname"><a href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a></div><div class="ttdeci">hid_t H5Fopen(const char *filename, unsigned flags, hid_t fapl_id)</div><div class="ttdoc">Opens an existing HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_g_html_gadedd0c73c98f2ada69305f2992c3300e"><div class="ttname"><a href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e">H5Gget_info_by_name</a></div><div class="ttdeci">herr_t H5Gget_info_by_name(hid_t loc_id, const char *name, H5G_info_t *ginfo, hid_t lapl_id)</div><div class="ttdoc">Retrieves information about a group by its name.</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html"><div class="ttname"><a href="struct_h5_g__info__t.html">H5G_info_t</a></div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:55</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html_a36284d2618eefc8e8408ac6a58d2728a"><div class="ttname"><a href="struct_h5_g__info__t.html#a36284d2618eefc8e8408ac6a58d2728a">H5G_info_t::storage_type</a></div><div class="ttdeci">H5G_storage_type_t storage_type</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:56</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html_ae1a56f51943bb51479442045a6561454"><div class="ttname"><a href="struct_h5_g__info__t.html#ae1a56f51943bb51479442045a6561454">H5G_info_t::nlinks</a></div><div class="ttdeci">hsize_t nlinks</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:57</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Update</th><th>Delete </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  {</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  __label__ fail_group, fail_prop, fail_lcpl, fail_file;</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, lcpl, group;</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">char</span> fname[] = <span class="stringliteral">"g1.h5"</span>;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/αυτή/είναι/μια/άλλη/νέα/ομάδα"</span>;</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(fname, <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordflow">if</span> ((lcpl = <a class="code" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code" href="_h5_ppublic_8h.html#ad2c1d10104f0262c826350ccbf7c49f2">H5P_LINK_CREATE</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordflow">goto</span> fail_lcpl;</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  }</div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">// ensure that intermediate groups are created automatically</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordflow">if</span> (<a class="code" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a>(lcpl, 1) < 0) {</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">goto</span> fail_prop;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  }</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// use UTF-8 encoding for link names</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordflow">if</span> (<a class="code" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc">H5Pset_char_encoding</a>(lcpl, <a class="code" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a>) < 0) {</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">goto</span> fail_prop;</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="comment">// create an anonymous group</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordflow">if</span> ((group = <a class="code" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344">H5Gcreate_anon</a>(file, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">goto</span> fail_group;</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment">// link the new group to existing the group at "/αυτή/είναι/μια"</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard</a>(group, <span class="stringliteral">"."</span>, file, path, lcpl, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> fail_group:</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> fail_prop:</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <a class="code" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(lcpl);</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> fail_lcpl:</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> fail_file:;</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div>
<div class="ttc" id="a_h5_fpublic_8h_html_a402673dec5c537b27a49a9a8bd6140b4"><div class="ttname"><a href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a></div><div class="ttdeci">#define H5F_ACC_RDWR</div><div class="ttdef"><b>Definition:</b> H5Fpublic.h:49</div></div>
<div class="ttc" id="agroup___h5_g_html_gab52641f0736281faaaae4e3039bbb344"><div class="ttname"><a href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344">H5Gcreate_anon</a></div><div class="ttdeci">hid_t H5Gcreate_anon(hid_t loc_id, hid_t gcpl_id, hid_t gapl_id)</div><div class="ttdoc">Creates a new empty group without linking it into the file structure.</div></div>
<div class="ttc" id="agroup___h5_l_html_ga69d50f7acdfd2f1dc7c4372397e63bd2"><div class="ttname"><a href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard</a></div><div class="ttdeci">herr_t H5Lcreate_hard(hid_t cur_loc, const char *cur_name, hid_t dst_loc, const char *dst_name, hid_t lcpl_id, hid_t lapl_id)</div><div class="ttdoc">Creates a hard link to an object.</div></div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  {</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  __label__ fail_info, fail_object, fail_file;</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, obj;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keywordtype">char</span> fname[] = <span class="stringliteral">"g1.h5"</span>;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/αυτή/είναι/μια/άλλη/νέα/ομάδα"</span>;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keywordtype">char</span> delete_path[] = <span class="stringliteral">"/αυτή/είναι/μια"</span>;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <a class="code" href="_h5version_8h.html#a5f76b0cdd6d68d61f11e46d4f06e50d4">H5O_info_t</a> info;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  <span class="keywordflow">if</span> ((file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(fname, <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="comment">// open a "leaf" group as object</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">if</span> ((obj = <a class="code" href="group___h5_o.html#ga9f635f58c7ddf17f87c253bfbca08bc1">H5Oopen</a>(file, path, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">goto</span> fail_object;</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="comment">// delete the link to an intermediate group on the path to the leaf</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf">H5Ldelete</a>(file, delete_path, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  }</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="comment">// link deletion will propagate along hard links along all paths</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">// reachable from the intermediate group and cause reference counts to</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// be decremented, freeing the objects if the count reaches 0</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="keywordflow">if</span> (<a class="code" href="group___h5_o.html#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a>(obj, &info, <a class="code" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>) < 0) {</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  ret_val = EXIT_FAILURE;</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">goto</span> fail_info;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  }</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  </div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  printf(<span class="stringliteral">"Leaf reference count: %d\n"</span>, info.rc);</div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> fail_info:</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <a class="code" href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61">H5Oclose</a>(obj);</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> fail_object:</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> fail_file:;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  }</div>
<div class="ttc" id="a_h5_opublic_8h_html_addd3f3f27f124a16a52c390b8431a878"><div class="ttname"><a href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></div><div class="ttdeci">#define H5O_INFO_BASIC</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:81</div></div>
<div class="ttc" id="a_h5version_8h_html_a5f76b0cdd6d68d61f11e46d4f06e50d4"><div class="ttname"><a href="_h5version_8h.html#a5f76b0cdd6d68d61f11e46d4f06e50d4">H5O_info_t</a></div><div class="ttdeci">#define H5O_info_t</div><div class="ttdef"><b>Definition:</b> H5version.h:1310</div></div>
<div class="ttc" id="agroup___h5_l_html_ga5b4e7f59f5d4bdae94fd8ce6875295cf"><div class="ttname"><a href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf">H5Ldelete</a></div><div class="ttdeci">herr_t H5Ldelete(hid_t loc_id, const char *name, hid_t lapl_id)</div><div class="ttdoc">Removes a link from a group.</div></div>
<div class="ttc" id="agroup___h5_o_html_ga545ad7c54987013ebd50b40fe9e73c61"><div class="ttname"><a href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61">H5Oclose</a></div><div class="ttdeci">herr_t H5Oclose(hid_t object_id)</div><div class="ttdoc">Closes an object in an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_o_html_ga9f635f58c7ddf17f87c253bfbca08bc1"><div class="ttname"><a href="group___h5_o.html#ga9f635f58c7ddf17f87c253bfbca08bc1">H5Oopen</a></div><div class="ttdeci">hid_t H5Oopen(hid_t loc_id, const char *name, hid_t lapl_id)</div><div class="ttdoc">Opens an object in an HDF5 file by location identifier and path name.</div></div>
<div class="ttc" id="agroup___h5_o_html_gaf4f302a33faba9e1c2b5f64c62ca4ed5"><div class="ttname"><a href="group___h5_o.html#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a></div><div class="ttdeci">#define H5Oget_info</div><div class="ttdef"><b>Definition:</b> H5version.h:1097</div></div>
</div><!-- fragment --> </td></tr>
</table>
<p><b>Groups in HDF5:</b> A group associates names with objects and provides a mechanism for mapping a name to an object. Since all objects appear in at least one group (with the possible exception of the root object) and since objects can have names in more than one group, the set of all objects in an HDF5 file is a directed graph. The internal nodes (nodes with an out-degree greater than zero) must be groups, while the leaf nodes (nodes with an out-degree zero) are either empty groups or objects of some other type. Exactly one object in every non-empty file is the root object. The root object always has a positive in-degree because it is pointed to by the file superblock.</p>
<p><b>Locating objects in the HDF5 file hierarchy:</b> An object name consists of one or more components separated from one another by slashes. An absolute name begins with a slash, and the object is located by looking for the first component in the root object, then looking for the second component in the first object, etc., until the entire name is traversed. A relative name does not begin with a slash, and the traversal begins at the location specified by the create or access function.</p>
<p><b>Group implementations in HDF5:</b> The original HDF5 group implementation provided a single-indexed structure for link storage. A new group implementation, in HDF5 Release 1.8.0, enables more efficient compact storage for very small groups, improved link indexing for large groups, and other advanced features.</p>
<ul>
<li>The <em>original indexed</em> format remains the default. Links are stored in a B-tree in the group's local heap. </li>
<li>Groups created in the new <em>compact-or-indexed</em> format, the implementation introduced with Release 1.8.0, can be tuned for performance, switching between the compact and indexed formats at thresholds set in the user application.<ul>
<li>The <em>compact</em> format will conserve file space and processing overhead when working with small groups and is particularly valuable when a group contains no links. Links are stored as a list of messages in the group's header.</li>
<li>The <em>indexed</em> format will yield improved performance when working with large groups, e.g., groups containing thousands to millions of members. Links are stored in a fractal heap and indexed with an improved B-tree. </li>
</ul>
</li>
<li>The new implementation also enables the use of link names consisting of non-ASCII character sets (see <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a>) and is required for all link types other than hard or soft links, e.g., external and user-defined links (see the <a class="el" href="group___h5_l.html">Links (H5L)</a> APIs).</li>
</ul>
<p>The original group structure and the newer structures are not directly interoperable. By default, a group will be created in the original indexed format. An existing group can be changed to a compact-or-indexed format if the need arises; there is no capability to change back. As stated above, once in the compact-or-indexed format, a group can switch between compact and indexed as needed.</p>
<p>Groups will be initially created in the compact-or-indexed format only when one or more of the following conditions is met: </p><ul>
<li>The low version bound value of the library version bounds property has been set to Release 1.8.0 or later in the file access property list (see <a class="el" href="group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910" title="Controls the range of library release versions used when creating objects in a file.">H5Pset_libver_bounds()</a>). Currently, that would require an <a class="el" href="group___f_a_p_l.html#gacbe1724e7f70cd17ed687417a1d2a910" title="Controls the range of library release versions used when creating objects in a file.">H5Pset_libver_bounds()</a> call with the low parameter set to <a class="el" href="_h5_fpublic_8h.html#a47d050173da48a2b85c730446f0771c0">H5F_LIBVER_LATEST</a>.<br />
When this property is set for an HDF5 file, all objects in the file will be created using the latest available format; no effort will be made to create a file that can be read by older libraries. </li>
<li>The creation order tracking property, <a class="el" href="_h5_ppublic_8h.html#aa52f444ce2ba8bc5a062612f195e899f">H5P_CRT_ORDER_TRACKED</a>, has been set in the group creation property list (see <a class="el" href="group___g_c_p_l.html#ga24817b5c9553df3872de57c20bf11512" title="Sets creation order tracking and indexing for links in a group.">H5Pset_link_creation_order()</a>).</li>
</ul>
<p>An existing group, currently in the original indexed format, will be converted to the compact-or-indexed format upon the occurrence of any of the following events: </p><ul>
<li>An external or user-defined link is inserted into the group. </li>
<li>A link named with a string composed of non-ASCII characters is inserted into the group.</li>
</ul>
<p>The compact-or-indexed format offers performance improvements that will be most notable at the extremes, i.e., in groups with zero members and in groups with tens of thousands of members. But measurable differences may sometimes appear at a threshold as low as eight group members. Since these performance thresholds and criteria differ from application to application, tunable settings are provided to govern the switch between the compact and indexed formats (see <a class="el" href="group___g_c_p_l.html#gab463ac9355728469eddfd973b4a5964f" title="Sets the parameters for conversion between compact and dense groups.">H5Pset_link_phase_change()</a>). Optimal thresholds will depend on the application and the operating environment.</p>
<p>Future versions of HDF5 will retain the ability to create, read, write, and manipulate all groups stored in either the original indexed format or the compact-or-indexed format. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga187cee27a9fc4f1a311eb19b0522c7b8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate</a>   <a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9">H5Gcreate2</a></td></tr>
<tr class="separator:ga187cee27a9fc4f1a311eb19b0522c7b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3eca6807deff4f9e51fc5fe0befc2245"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen</a>   <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403">H5Gopen2</a></td></tr>
<tr class="separator:ga3eca6807deff4f9e51fc5fe0befc2245"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga86d93295965f750ef25dea2505a711d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9">H5Gcreate2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id)</td></tr>
<tr class="memdesc:ga86d93295965f750ef25dea2505a711d9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new group and links it into the file. <a href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9">More...</a><br /></td></tr>
<tr class="separator:ga86d93295965f750ef25dea2505a711d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab52641f0736281faaaae4e3039bbb344"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344">H5Gcreate_anon</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id)</td></tr>
<tr class="memdesc:gab52641f0736281faaaae4e3039bbb344"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new empty group without linking it into the file structure. <a href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344">More...</a><br /></td></tr>
<tr class="separator:gab52641f0736281faaaae4e3039bbb344"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadab91e2dd7a7e253dcc0e4fe04b81403"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403">H5Gopen2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id)</td></tr>
<tr class="memdesc:gadab91e2dd7a7e253dcc0e4fe04b81403"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing group in a file. <a href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403">More...</a><br /></td></tr>
<tr class="separator:gadab91e2dd7a7e253dcc0e4fe04b81403"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b959a53cbffa48f5d68ce33b43b7ed8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga0b959a53cbffa48f5d68ce33b43b7ed8">H5Gget_create_plist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group_id)</td></tr>
<tr class="memdesc:ga0b959a53cbffa48f5d68ce33b43b7ed8"><td class="mdescLeft"> </td><td class="mdescRight">Gets a group creation property list identifier. <a href="group___h5_g.html#ga0b959a53cbffa48f5d68ce33b43b7ed8">More...</a><br /></td></tr>
<tr class="separator:ga0b959a53cbffa48f5d68ce33b43b7ed8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad4be126ab7bbf2001435e8e70089f3d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3">H5Gget_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> *ginfo)</td></tr>
<tr class="memdesc:gad4be126ab7bbf2001435e8e70089f3d3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group. <a href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3">More...</a><br /></td></tr>
<tr class="separator:gad4be126ab7bbf2001435e8e70089f3d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadedd0c73c98f2ada69305f2992c3300e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e">H5Gget_info_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> *ginfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gadedd0c73c98f2ada69305f2992c3300e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group by its name. <a href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e">More...</a><br /></td></tr>
<tr class="separator:gadedd0c73c98f2ada69305f2992c3300e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga985f27ad1a164d99fa1f58c6de60ab00"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00">H5Gget_info_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> *ginfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga985f27ad1a164d99fa1f58c6de60ab00"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a group, according to the group's position within an index. <a href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00">More...</a><br /></td></tr>
<tr class="separator:ga985f27ad1a164d99fa1f58c6de60ab00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d55dbf931f8003bb329c4340b8fe4d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga1d55dbf931f8003bb329c4340b8fe4d6">H5Gflush</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group_id)</td></tr>
<tr class="memdesc:ga1d55dbf931f8003bb329c4340b8fe4d6"><td class="mdescLeft"> </td><td class="mdescRight">Flushes all buffers associated with a group to disk. <a href="group___h5_g.html#ga1d55dbf931f8003bb329c4340b8fe4d6">More...</a><br /></td></tr>
<tr class="separator:ga1d55dbf931f8003bb329c4340b8fe4d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a8bdd0eb1b001222c27d3d39a909840"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840">H5Grefresh</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group_id)</td></tr>
<tr class="memdesc:ga0a8bdd0eb1b001222c27d3d39a909840"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes all buffers associated with a group. <a href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840">More...</a><br /></td></tr>
<tr class="separator:ga0a8bdd0eb1b001222c27d3d39a909840"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8dbe20b390d2504f0bd3589ed8f4e221"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group_id)</td></tr>
<tr class="memdesc:ga8dbe20b390d2504f0bd3589ed8f4e221"><td class="mdescLeft"> </td><td class="mdescRight">Closes the specified group. <a href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">More...</a><br /></td></tr>
<tr class="separator:ga8dbe20b390d2504f0bd3589ed8f4e221"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7397440085510728a2e2d22199e81980"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, size_t size_hint)</td></tr>
<tr class="memdesc:ga7397440085510728a2e2d22199e81980"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new group and links it into the file. <a href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">More...</a><br /></td></tr>
<tr class="separator:ga7397440085510728a2e2d22199e81980"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga163ca3eb7893d34973ee900b2da886be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be">H5Gopen1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name)</td></tr>
<tr class="memdesc:ga163ca3eb7893d34973ee900b2da886be"><td class="mdescLeft"> </td><td class="mdescRight">Opens an existing group for modification and returns a group identifier for that group. <a href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be">More...</a><br /></td></tr>
<tr class="separator:ga163ca3eb7893d34973ee900b2da886be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1b9b2effdc1727613f81c4dcb2a4d644"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga1b9b2effdc1727613f81c4dcb2a4d644">H5Glink</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cur_loc_id, <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> type, const char *cur_name, const char *new_name)</td></tr>
<tr class="memdesc:ga1b9b2effdc1727613f81c4dcb2a4d644"><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of the specified type from <code>new_name</code> to <code>cur_name</code>. <a href="group___h5_g.html#ga1b9b2effdc1727613f81c4dcb2a4d644">More...</a><br /></td></tr>
<tr class="separator:ga1b9b2effdc1727613f81c4dcb2a4d644"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafabd07a7f64a7cbef27c56a3bee2df47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gafabd07a7f64a7cbef27c56a3bee2df47">H5Glink2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cur_loc_id, const char *cur_name, <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> type, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> new_loc_id, const char *new_name)</td></tr>
<tr class="memdesc:gafabd07a7f64a7cbef27c56a3bee2df47"><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of the specified type from <code>cur_name</code> to <code>new_name</code>. <a href="group___h5_g.html#gafabd07a7f64a7cbef27c56a3bee2df47">More...</a><br /></td></tr>
<tr class="separator:gafabd07a7f64a7cbef27c56a3bee2df47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6474351d346ad45309ae0b22ebdde9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a">H5Gmove</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_loc_id, const char *src_name, const char *dst_name)</td></tr>
<tr class="memdesc:gaa6474351d346ad45309ae0b22ebdde9a"><td class="mdescLeft"> </td><td class="mdescRight">Renames an object within an HDF5 file. <a href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a">More...</a><br /></td></tr>
<tr class="separator:gaa6474351d346ad45309ae0b22ebdde9a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad97bf21798b06b63df0bdd404cac562c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c">H5Gmove2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_loc_id, const char *src_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_loc_id, const char *dst_name)</td></tr>
<tr class="memdesc:gad97bf21798b06b63df0bdd404cac562c"><td class="mdescLeft"> </td><td class="mdescRight">Renames an object within an HDF5 file. <a href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c">More...</a><br /></td></tr>
<tr class="separator:gad97bf21798b06b63df0bdd404cac562c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb843cbd5bbb816cfa9c855463d1e51c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c">H5Gunlink</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name)</td></tr>
<tr class="memdesc:gacb843cbd5bbb816cfa9c855463d1e51c"><td class="mdescLeft"> </td><td class="mdescRight">Removes the link to an object from a group. <a href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c">More...</a><br /></td></tr>
<tr class="separator:gacb843cbd5bbb816cfa9c855463d1e51c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3a994ec16caa60edd7bb6c71c6fdc5aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga3a994ec16caa60edd7bb6c71c6fdc5aa">H5Gget_linkval</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, size_t size, char *buf)</td></tr>
<tr class="memdesc:ga3a994ec16caa60edd7bb6c71c6fdc5aa"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the object that the symbolic link points to. <a href="group___h5_g.html#ga3a994ec16caa60edd7bb6c71c6fdc5aa">More...</a><br /></td></tr>
<tr class="separator:ga3a994ec16caa60edd7bb6c71c6fdc5aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a615715ea68fc1bf11484a8278fe682"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga7a615715ea68fc1bf11484a8278fe682">H5Gset_comment</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, const char *comment)</td></tr>
<tr class="memdesc:ga7a615715ea68fc1bf11484a8278fe682"><td class="mdescLeft"> </td><td class="mdescRight">Sets comment for specified object. <a href="group___h5_g.html#ga7a615715ea68fc1bf11484a8278fe682">More...</a><br /></td></tr>
<tr class="separator:ga7a615715ea68fc1bf11484a8278fe682"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5a1c3e1ed4264d92cc02ca20afc57f4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gac5a1c3e1ed4264d92cc02ca20afc57f4">H5Gget_comment</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, size_t bufsize, char *buf)</td></tr>
<tr class="memdesc:gac5a1c3e1ed4264d92cc02ca20afc57f4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for specified object. <a href="group___h5_g.html#gac5a1c3e1ed4264d92cc02ca20afc57f4">More...</a><br /></td></tr>
<tr class="separator:gac5a1c3e1ed4264d92cc02ca20afc57f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga957fee64f796f184f542537127ad6c11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11">H5Giterate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, int *idx, <a class="el" href="_h5_gpublic_8h.html#aa2bdcd48141dd7db6e4a6d2534801697">H5G_iterate_t</a> op, void *op_data)</td></tr>
<tr class="memdesc:ga957fee64f796f184f542537127ad6c11"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over the entries of a group invoking a callback for each entry encountered. <a href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11">More...</a><br /></td></tr>
<tr class="separator:ga957fee64f796f184f542537127ad6c11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3e30142e15ccf9a08bfc91ca9925c14d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga3e30142e15ccf9a08bfc91ca9925c14d">H5Gget_num_objs</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *num_objs)</td></tr>
<tr class="memdesc:ga3e30142e15ccf9a08bfc91ca9925c14d"><td class="mdescLeft"> </td><td class="mdescRight">Returns number of objects in the group specified by its identifier. <a href="group___h5_g.html#ga3e30142e15ccf9a08bfc91ca9925c14d">More...</a><br /></td></tr>
<tr class="separator:ga3e30142e15ccf9a08bfc91ca9925c14d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad75244979da933ba0b3ad25258850a6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b">H5Gget_objinfo</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> follow_link, <a class="el" href="struct_h5_g__stat__t.html">H5G_stat_t</a> *statbuf)</td></tr>
<tr class="memdesc:gad75244979da933ba0b3ad25258850a6b"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about an object. <a href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b">More...</a><br /></td></tr>
<tr class="separator:gad75244979da933ba0b3ad25258850a6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga80180e7b819d3c9b3b3f1895e9baaf5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b">H5Gget_objname_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> idx, char *name, size_t size)</td></tr>
<tr class="memdesc:ga80180e7b819d3c9b3b3f1895e9baaf5b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of an object specified by an index. <a href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b">More...</a><br /></td></tr>
<tr class="separator:ga80180e7b819d3c9b3b3f1895e9baaf5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab1383b8cca3fa99410ad36427059c5a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_g.html#gab1383b8cca3fa99410ad36427059c5a7">H5Gget_objtype_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> idx)</td></tr>
<tr class="memdesc:gab1383b8cca3fa99410ad36427059c5a7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of an object specified by an index. <a href="group___h5_g.html#gab1383b8cca3fa99410ad36427059c5a7">More...</a><br /></td></tr>
<tr class="separator:gab1383b8cca3fa99410ad36427059c5a7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga187cee27a9fc4f1a311eb19b0522c7b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga187cee27a9fc4f1a311eb19b0522c7b8">◆ </a></span>H5Gcreate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Gcreate   <a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9">H5Gcreate2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate()</a> is a macro that is mapped to either <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> or <a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="Creates a new group and links it into the file.">H5Gcreate2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="ga3eca6807deff4f9e51fc5fe0befc2245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3eca6807deff4f9e51fc5fe0befc2245">◆ </a></span>H5Gopen</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Gopen   <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403">H5Gopen2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a> is a macro that is mapped to either <a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be" title="Opens an existing group for modification and returns a group identifier for that group.">H5Gopen1()</a> or <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8dbe20b390d2504f0bd3589ed8f4e221"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8dbe20b390d2504f0bd3589ed8f4e221">◆ </a></span>H5Gclose()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gclose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>group_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the specified group. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">group_id</td><td>Group identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> releases resources used by a group that was opened by <a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate()</a> or <a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a>. After closing a group, <code>group_id</code> cannot be used again until another <a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate()</a> or <a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a> is called on it.</p>
<p>Failure to release a group with this call will result in resource leaks.</p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f11.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group, child;</div>
<div class="line"> <span class="keywordflow">if</span> ((group = <a class="code" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a>(file, <span class="stringliteral">"mount_point"</span>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <span class="keywordflow">if</span> ((child = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f1.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a>(group, <span class="stringliteral">"."</span>, child, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) >= 0) {</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// do something useful w/ the mounted file</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> perror(<span class="stringliteral">"H5Fmount failed."</span>);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(child);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span></div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> }</div>
<div class="ttc" id="agroup___h5_f_html_ga7c4865fd36ee25d839725252150bb53b"><div class="ttname"><a href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a></div><div class="ttdeci">herr_t H5Fmount(hid_t loc, const char *name, hid_t child, hid_t plist)</div><div class="ttdoc">Mounts an HDF5 file.</div></div>
<div class="ttc" id="agroup___h5_g_html_ga7397440085510728a2e2d22199e81980"><div class="ttname"><a href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a></div><div class="ttdeci">hid_t H5Gcreate1(hid_t loc_id, const char *name, size_t size_hint)</div><div class="ttdoc">Creates a new group and links it into the file.</div></div>
</div><!-- fragment --> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga7397440085510728a2e2d22199e81980"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7397440085510728a2e2d22199e81980">◆ </a></span>H5Gcreate1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gcreate1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size_hint</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new group and links it into the file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size_hint</td><td>The number of bytes to reserve for the names that will appear in the group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000035">Deprecated:</a></b></dt><dd>This function is deprecated in favor of <a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="Creates a new group and links it into the file.">H5Gcreate2()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> creates a new group with the specified name at the specified location, <code>loc_id</code>. <code>loc_id</code> may be a file, group, dataset, named datatype or attribute. If an attribute, dataset, or named datatype is specified for <code>loc_id</code> then the group will be created at the location where the attribute, dataset, or named datatype is attached. The name, name, must not already be taken by some other object and all parent groups must already exist.</p>
<p><code>name</code> can be a relative path based at <code>loc_id</code> or an absolute path from the root of the file. Use of this function requires that any intermediate groups specified in the path already exist.</p>
<p>The length of a group name, or of the name of any object within a group, is not limited.</p>
<p><code>size_hint</code> is a hint for the number of bytes to reserve to store the names which will be eventually added to the new group. This value must be between 0 and UINT32_MAX (inclusive). If this parameter is zero, a default value will be used.</p>
<p>The return value is a group identifier for the open group. This group identifier should be closed by calling <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> when it is no longer needed.</p>
<p>See <a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> for a discussion of the differences between <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> and <a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a>.</p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"> {</div>
<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f11.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> <span class="keywordflow">if</span> (file != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group, child;</div>
<div class="line"> <span class="keywordflow">if</span> ((group = <a class="code" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980">H5Gcreate1</a>(file, <span class="stringliteral">"mount_point"</span>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <span class="keywordflow">if</span> ((child = <a class="code" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"f1.h5"</span>, <a class="code" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) != <a class="code" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b">H5Fmount</a>(group, <span class="stringliteral">"."</span>, child, <a class="code" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) >= 0) {</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// do something useful w/ the mounted file</span></div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span> {</div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> perror(<span class="stringliteral">"H5Fmount failed."</span>);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(child);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div>
<div class="line"> }</div>
<div class="line"> <a class="code" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">else</span></div>
<div class="line"> ret_val = EXIT_FAILURE;</div>
<div class="line"> }</div>
</div><!-- fragment --> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function <a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate()</a> renamed to <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> and deprecated in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga86d93295965f750ef25dea2505a711d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga86d93295965f750ef25dea2505a711d9">◆ </a></span>H5Gcreate2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gcreate2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>lcpl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>gcpl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>gapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new group and links it into the file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">gcpl_id</td><td>Group creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">gapl_id</td><td>Group access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="Creates a new group and links it into the file.">H5Gcreate2()</a> creates a new group in a file. After a group has been created, links to datasets and to other groups can be added.</p>
<p>The <code>loc_id</code> and <code>name</code> parameters specify where the group is located. <code>loc_id</code> may be a file, group, dataset, named datatype or attribute in the file. If an attribute, dataset, or named datatype is specified for <code>loc_id</code> then the group will be created at the location where the attribute, dataset, or named datatype is attached. <code>name</code> is the link to the group; <code>name</code> may be either an absolute path in the file (the links from the root group to the new group) or a relative path from <code>loc_id</code> (the link(s) from the group specified by <code>loc_id</code> to the new group).</p>
<p><code>lcpl_id</code>, <code>gcpl_id</code>, and <code>gapl_id</code> are property list identifiers. These property lists govern how the link to the group is created, how the group is created, and how the group can be accessed in the future, respectively. <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> can be passed in if the default properties are appropriate for these property lists. Currently, there are no APIs for the group access property list; use <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<p>The group identifier should be closed by <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> when access is no longer required to prevent resource leaks.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a> </dd></dl>
</div>
</div>
<a id="gab52641f0736281faaaae4e3039bbb344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab52641f0736281faaaae4e3039bbb344">◆ </a></span>H5Gcreate_anon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gcreate_anon </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>gcpl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>gapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new empty group without linking it into the file structure. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">gcpl_id</td><td>Group creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">gapl_id</td><td>Group access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> creates a new empty group in the file specified by <code>loc_id</code>. With default settings, <a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> provides similar functionality to that provided by <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a>, with the differences described in the list below.</p>
<p>The new group's creation and access properties are specified in <code>gcpl_id</code> and <code>gapl_id</code>, respectively.</p>
<p><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> returns a new group identifier. This identifier must be linked into the HDF5 file structure with <a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a> or it will be deleted from the file when the file is closed.</p>
<p>The differences between this function and <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> are as follows:</p>
<ul>
<li><a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> does not provide for the use of custom property lists; <a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1()</a> always uses default properties. </li>
<li><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> neither provides the new group's name nor links it into the HDF5 file structure; those actions must be performed separately through a call to <a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a>, which offers greater control over linking. </li>
<li><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon()</a> does not directly provide a hint mechanism for the group's heap size. Comparable information can be included in the group creation property list <code>gcpl_id</code> through a <a class="el" href="group___g_c_p_l.html#ga870728af2bf3c0b16edafd762a1c44d6" title="Specifies the anticipated maximum size of a local heap.">H5Pset_local_heap_size_hint()</a> call.</li>
</ul>
<p>A group created with this function should be closed with <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> when the group is no longer needed so that resource leaks will not develop.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a>, <a class="el" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga1d55dbf931f8003bb329c4340b8fe4d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d55dbf931f8003bb329c4340b8fe4d6">◆ </a></span>H5Gflush()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gflush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>group_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes all buffers associated with a group to disk. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">group_id</td><td>Group identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga1d55dbf931f8003bb329c4340b8fe4d6" title="Flushes all buffers associated with a group to disk.">H5Gflush()</a> causes all buffers associated with a group to be immediately flushed to the disk without removing the data from the cache.</p>
<dl class="section attention"><dt>Attention</dt><dd>HDF5 does not possess full control over buffering. H5G_FLUSH flushes the internal HDF5 buffers and 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 the disk.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gac5a1c3e1ed4264d92cc02ca20afc57f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5a1c3e1ed4264d92cc02ca20afc57f4">◆ </a></span>H5Gget_comment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int H5Gget_comment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>bufsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves comment for specified object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the object whose comment is to be set or reset name must be <code>'.'</code> (dot) if <code>loc_id</code> fully specifies the object for which the comment is to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Maximum number of comment characters to be returned in <code>buf</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>The comment</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of characters in the comment, counting the <code>NULL</code> terminator, if successful; the value returned may be larger than <code>bufsize</code>. Otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000044">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_o.html#gaa1511ce5e2fe01ce7ea58f2f851d694b" title="Retrieves comment for specified object.">H5Oget_comment()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gac5a1c3e1ed4264d92cc02ca20afc57f4" title="Retrieves comment for specified object.">H5Gget_comment()</a> retrieves the comment for the object specified by <code>loc_id</code> and <code>name</code>. The comment is returned in the buffer <code>buf</code>.</p>
<p><code>loc_id</code> can specify any object in the file. name can be one of the following: </p><ul>
<li>The name of the object relative to <code>loc_id</code> </li>
<li>An absolute name of the object, starting from <code>/</code>, the file's root group </li>
<li>A dot (<code></code>.), if <code>loc_id</code> fully specifies the object</li>
</ul>
<p>At most bufsize characters, including a null-terminator, are returned in <code>buf</code>. The returned value is not null-terminated if the comment is longer than the supplied buffer. If the size of the comment is unknown, a preliminary <code><a class="el" href="group___h5_g.html#gac5a1c3e1ed4264d92cc02ca20afc57f4" title="Retrieves comment for specified object.">H5Gget_comment()</a></code> call will return the size of the comment, including space for the null-terminator.</p>
<p>If an object does not have a comment, the empty string is returned in comment.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="ga0b959a53cbffa48f5d68ce33b43b7ed8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0b959a53cbffa48f5d68ce33b43b7ed8">◆ </a></span>H5Gget_create_plist()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gget_create_plist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>group_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a group creation property list identifier. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">group_id</td><td>Group identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a creation property list identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga0b959a53cbffa48f5d68ce33b43b7ed8" title="Gets a group creation property list identifier.">H5Gget_create_plist()</a> returns an identifier for the group creation property list associated with the group specified by <code>group_id</code>.</p>
<p>The creation property list identifier should be released with <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a> to prevent resource leaks.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gad4be126ab7bbf2001435e8e70089f3d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad4be126ab7bbf2001435e8e70089f3d3">◆ </a></span>H5Gget_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> * </td>
<td class="paramname"><em>ginfo</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information about a group. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ginfo</td><td>Struct in which group information is returned</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="Retrieves information about a group.">H5Gget_info()</a> retrieves information about the group at location specified by <code>loc_id</code>. The information is returned in the <code>ginfo</code>.</p>
<p><code>ginfo</code> is an <a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> struct and is defined (in <a class="el" href="_h5_gpublic_8h.html">H5Gpublic.h</a>) as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_g__info__t.html">H5G_info_t</a> {</div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08c">H5G_storage_type_t</a> <a class="code" href="struct_h5_g__info__t.html#a36284d2618eefc8e8408ac6a58d2728a">storage_type</a>; </div>
<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_g__info__t.html#ae1a56f51943bb51479442045a6561454">nlinks</a>; </div>
<div class="line"> int64_t <a class="code" href="struct_h5_g__info__t.html#a24109e19a1737b1f795f651f4e6d9f5d">max_corder</a>; </div>
<div class="line"> <a class="code" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> <a class="code" href="struct_h5_g__info__t.html#a7b3769ffcce93e1ed205cf6d8d84423a">mounted</a>; </div>
<div class="line">} <a class="code" href="struct_h5_g__info__t.html">H5G_info_t</a>;</div>
<div class="ttc" id="a_h5_gpublic_8h_html_aaadde411516426f400ed4db91bd8e08c"><div class="ttname"><a href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08c">H5G_storage_type_t</a></div><div class="ttdeci">H5G_storage_type_t</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:41</div></div>
<div class="ttc" id="a_h5public_8h_html_a7f81cce70fb546af88da24d9285d3c1c"><div class="ttname"><a href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></div><div class="ttdeci">uint64_t hsize_t</div><div class="ttdef"><b>Definition:</b> H5public.h:297</div></div>
<div class="ttc" id="a_h5public_8h_html_ad470b00eccd2115c707c02de5fa1120d"><div class="ttname"><a href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></div><div class="ttdeci">bool hbool_t</div><div class="ttdef"><b>Definition:</b> H5public.h:249</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html_a24109e19a1737b1f795f651f4e6d9f5d"><div class="ttname"><a href="struct_h5_g__info__t.html#a24109e19a1737b1f795f651f4e6d9f5d">H5G_info_t::max_corder</a></div><div class="ttdeci">int64_t max_corder</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:58</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html_a7b3769ffcce93e1ed205cf6d8d84423a"><div class="ttname"><a href="struct_h5_g__info__t.html#a7b3769ffcce93e1ed205cf6d8d84423a">H5G_info_t::mounted</a></div><div class="ttdeci">hbool_t mounted</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:59</div></div>
</div><!-- fragment --><p> Possible values of <code>storage_type</code> are: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08caa5b612e8bd5597ac58eafd3f42e4d681">H5G_STORAGE_TYPE_COMPACT</a></td><td>Compact storage</td></tr>
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08cae5f0b9b2491abb0a12c3fc4e3c8fdf75">H5G_STORAGE_TYPE_DENSE</a></td><td>Indexed storage</td></tr>
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08ca06c1f3bec70169d1889fc2dd37a606af">H5G_STORAGE_TYPE_SYMBOL_TABLE</a></td><td>Symbol tables, the original HDF5 structure</td></tr>
</table>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga985f27ad1a164d99fa1f58c6de60ab00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga985f27ad1a164d99fa1f58c6de60ab00">◆ </a></span>H5Gget_info_by_idx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_info_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>group_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> </td>
<td class="paramname"><em>idx_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> </td>
<td class="paramname"><em>order</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> * </td>
<td class="paramname"><em>ginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>lapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information about a group, according to the group's position within an index. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">group_name</td><td>Name of the group to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Transient index identifying object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Transient index identifying object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Position in the index of the group to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ginfo</td><td>Struct in which group information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <ul>
<li>The size of the object name if successful, or </li>
<li>0 if no name is associated with the group identifier, or </li>
<li>negative value, if failure occurred</li>
</ul>
<a class="el" href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00" title="Retrieves information about a group, according to the group's position within an index.">H5Gget_info_by_idx()</a> retrieves the same information about a group as retrieved by the function <a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="Retrieves information about a group.">H5Gget_info()</a>, but the means of identifying the group differs; the group is identified by position in an index rather than by name.</dd></dl>
<p><code>loc_id</code> and <code>group_name</code> specify the group containing the group for which information is sought. The groups in <code>group_name</code> are indexed by <code>idx_type</code>; the group for which information is retrieved is identified in that index by index order, <code>order</code>, and index position, <code>n</code>.</p>
<p>If <code>loc_id</code> specifies the group containing the group for which information is queried, <code>group_name</code> can be a dot (.).</p>
<p>Valid values for <code>index_type</code> are as follows: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a></td><td>Lexicographic order on name</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a315475479b34056043b4b6583bafb280">H5_INDEX_CRT_ORDER</a></td><td>Index on creation order</td></tr>
</table>
<p>The order in which the index is to be examined, as specified by <code>order</code>, can be one of the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a></td><td>Increasing order</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a></td><td>Decreasing order</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a></td><td>Fastest available order</td></tr>
</table>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gadedd0c73c98f2ada69305f2992c3300e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadedd0c73c98f2ada69305f2992c3300e">◆ </a></span>H5Gget_info_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_info_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> * </td>
<td class="paramname"><em>ginfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>lapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information about a group by its name. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ginfo</td><td>Struct in which group information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e" title="Retrieves information about a group by its name.">H5Gget_info_by_name()</a> retrieves information about the group <code>name</code> at location specified by <code>loc_id</code>. The information is returned in the <code>ginfo</code> struct.</p>
<p>If <code>loc_id</code> specifies the group for which information is queried, then the group's <code>name</code> can be a dot (.).</p>
<p><code>ginfo</code> is an <a class="el" href="struct_h5_g__info__t.html">H5G_info_t</a> struct and is defined (in <a class="el" href="_h5_gpublic_8h.html">H5Gpublic.h</a>) as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_g__info__t.html">H5G_info_t</a> {</div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08c">H5G_storage_type_t</a> <a class="code" href="struct_h5_g__info__t.html#a36284d2618eefc8e8408ac6a58d2728a">storage_type</a>; </div>
<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_g__info__t.html#ae1a56f51943bb51479442045a6561454">nlinks</a>; </div>
<div class="line"> int64_t <a class="code" href="struct_h5_g__info__t.html#a24109e19a1737b1f795f651f4e6d9f5d">max_corder</a>; </div>
<div class="line"> <a class="code" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> <a class="code" href="struct_h5_g__info__t.html#a7b3769ffcce93e1ed205cf6d8d84423a">mounted</a>; </div>
<div class="line">} <a class="code" href="struct_h5_g__info__t.html">H5G_info_t</a>;</div>
</div><!-- fragment --><p> Possible values of <code>storage_type</code> are: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08caa5b612e8bd5597ac58eafd3f42e4d681">H5G_STORAGE_TYPE_COMPACT</a></td><td>Compact storage</td></tr>
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08cae5f0b9b2491abb0a12c3fc4e3c8fdf75">H5G_STORAGE_TYPE_DENSE</a></td><td>Indexed storage</td></tr>
<tr>
<td><a class="el" href="_h5_gpublic_8h.html#aaadde411516426f400ed4db91bd8e08ca06c1f3bec70169d1889fc2dd37a606af">H5G_STORAGE_TYPE_SYMBOL_TABLE</a></td><td>Symbol tables, the original HDF5 structure</td></tr>
</table>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga3a994ec16caa60edd7bb6c71c6fdc5aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3a994ec16caa60edd7bb6c71c6fdc5aa">◆ </a></span>H5Gget_linkval()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_linkval </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the object that the symbolic link points to. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Symbolic link to the object whose name is to be returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Maximum number of characters of value to be returned </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>A buffer to hold the name of the object being sought</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000042">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_l.html#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga3a994ec16caa60edd7bb6c71c6fdc5aa" title="Returns the name of the object that the symbolic link points to.">H5Gget_linkval()</a> returns up to size characters of the name of the object that the symbolic link name points to.</p>
<p>The parameter <code>loc_id</code> is a file or group identifier.</p>
<p>The parameter <code>name</code> must be a symbolic link pointing to the desired object and must be defined relative to <code>loc_id</code>.</p>
<p>If size is smaller than the size of the returned object name, then the name stored in the buffer value will not be <code>NULL</code> terminated.</p>
<p>This function fails if <code>name</code> is not a symbolic link. The presence of a symbolic link can be tested by passing zero for <code>size</code> and <code>NULL</code> for value.</p>
<p>This function should be used only after <a class="el" href="group___h5_l.html#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1()</a> (or the deprecated function <a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a>) has been called to verify that name is a symbolic link.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="ga3e30142e15ccf9a08bfc91ca9925c14d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3e30142e15ccf9a08bfc91ca9925c14d">◆ </a></span>H5Gget_num_objs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_num_objs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> * </td>
<td class="paramname"><em>num_objs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns number of objects in the group specified by its identifier. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">num_objs</td><td>Number of objects in the group</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000046">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="Retrieves information about a group.">H5Gget_info()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga3e30142e15ccf9a08bfc91ca9925c14d" title="Returns number of objects in the group specified by its identifier.">H5Gget_num_objs()</a> returns number of objects in a group. Group is specified by its identifier <code>loc_id</code>. If a file identifier is passed in, then the number of objects in the root group is returned.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="gad75244979da933ba0b3ad25258850a6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad75244979da933ba0b3ad25258850a6b">◆ </a></span>H5Gget_objinfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gget_objinfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> </td>
<td class="paramname"><em>follow_link</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_g__stat__t.html">H5G_stat_t</a> * </td>
<td class="paramname"><em>statbuf</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about an object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the object for which status is being sought </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">follow_link</td><td>Link flag </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">statbuf</td><td>Buffer in which to return information about the object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000047">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the functions <a class="el" href="group___h5_o.html#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> and <a class="el" href="group___h5_l.html#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a> returns information about the specified object through the <code>statbuf</code> argument.</p>
<p>A file or group identifier, <code>loc_id</code>, and an object name, <code>name</code>, relative to <code>loc_id</code>, are commonly used to specify the object. However, if the object identifier is already known to the application, an alternative approach is to use that identifier, <code>obj_id</code>, in place of <code>loc_id</code>, and a dot (<code></code>.) in place of <code>name</code>. Thus, the alternative versions of the first portion of an <a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a> call would be as follows: </p><div class="fragment"><div class="line"><a class="code" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b">H5Gget_objinfo</a> (loc_id name ...)</div>
<div class="line"><a class="code" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b">H5Gget_objinfo</a> (obj_id . ...)</div>
<div class="ttc" id="agroup___h5_g_html_gad75244979da933ba0b3ad25258850a6b"><div class="ttname"><a href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b">H5Gget_objinfo</a></div><div class="ttdeci">herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf)</div><div class="ttdoc">Returns information about an object.</div></div>
</div><!-- fragment --><p>If the object is a symbolic link and follow_link is zero (0), then the information returned describes the link itself; otherwise the link is followed and the information returned describes the object to which the link points. If <code>follow_link</code> is non-zero but the final symbolic link is dangling (does not point to anything), then an error is returned. The <code>statbuf</code> fields are undefined for an error. The existence of an object can be tested by calling this function with a <code>NULL</code> <code>statbuf</code>.</p>
<p><a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a> fills in the following data structure (defined in <a class="el" href="_h5_gpublic_8h.html">H5Gpublic.h</a>): </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_g__stat__t.html">H5G_stat_t</a> {</div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="struct_h5_g__stat__t.html#a3e6af6ccd452ff6ff53a6aadc5a33860">fileno</a>[2]; </div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="struct_h5_g__stat__t.html#a871980f2e438ab5b2d466163496b8d84">objno</a>[2]; </div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_g__stat__t.html#a2c8cbd250873ea4c133ba88beead3a4e">nlink</a>; </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> <a class="code" href="struct_h5_g__stat__t.html#a292266459b6436aa9818e8d7a9cd25cc">type</a>; </div>
<div class="line"> time_t <a class="code" href="struct_h5_g__stat__t.html#a4a2d3a53446ef3217564ced73636f9bf">mtime</a>; </div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code" href="struct_h5_g__stat__t.html#aa60adc607e378ee1f1f51a19f883eeb0">linklen</a>; </div>
<div class="line"> <a class="code" href="struct_h5_o__stat__t.html">H5O_stat_t</a> <a class="code" href="struct_h5_g__stat__t.html#acec33440ee705e96159fa8eebe1702ea">ohdr</a>; </div>
<div class="line">} <a class="code" href="struct_h5_g__stat__t.html">H5G_stat_t</a>;</div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a></div><div class="ttdeci">H5G_obj_t</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:535</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html"><div class="ttname"><a href="struct_h5_g__stat__t.html">H5G_stat_t</a></div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:563</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_a292266459b6436aa9818e8d7a9cd25cc"><div class="ttname"><a href="struct_h5_g__stat__t.html#a292266459b6436aa9818e8d7a9cd25cc">H5G_stat_t::type</a></div><div class="ttdeci">H5G_obj_t type</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:567</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_a2c8cbd250873ea4c133ba88beead3a4e"><div class="ttname"><a href="struct_h5_g__stat__t.html#a2c8cbd250873ea4c133ba88beead3a4e">H5G_stat_t::nlink</a></div><div class="ttdeci">unsigned nlink</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:566</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_a3e6af6ccd452ff6ff53a6aadc5a33860"><div class="ttname"><a href="struct_h5_g__stat__t.html#a3e6af6ccd452ff6ff53a6aadc5a33860">H5G_stat_t::fileno</a></div><div class="ttdeci">unsigned long fileno[2]</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:564</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_a4a2d3a53446ef3217564ced73636f9bf"><div class="ttname"><a href="struct_h5_g__stat__t.html#a4a2d3a53446ef3217564ced73636f9bf">H5G_stat_t::mtime</a></div><div class="ttdeci">time_t mtime</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:568</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_a871980f2e438ab5b2d466163496b8d84"><div class="ttname"><a href="struct_h5_g__stat__t.html#a871980f2e438ab5b2d466163496b8d84">H5G_stat_t::objno</a></div><div class="ttdeci">unsigned long objno[2]</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:565</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_aa60adc607e378ee1f1f51a19f883eeb0"><div class="ttname"><a href="struct_h5_g__stat__t.html#aa60adc607e378ee1f1f51a19f883eeb0">H5G_stat_t::linklen</a></div><div class="ttdeci">size_t linklen</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:569</div></div>
<div class="ttc" id="astruct_h5_g__stat__t_html_acec33440ee705e96159fa8eebe1702ea"><div class="ttname"><a href="struct_h5_g__stat__t.html#acec33440ee705e96159fa8eebe1702ea">H5G_stat_t::ohdr</a></div><div class="ttdeci">H5O_stat_t ohdr</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:570</div></div>
<div class="ttc" id="astruct_h5_o__stat__t_html"><div class="ttname"><a href="struct_h5_o__stat__t.html">H5O_stat_t</a></div><div class="ttdef"><b>Definition:</b> H5Opublic.h:1706</div></div>
</div><!-- fragment --><p> where <a class="el" href="struct_h5_o__stat__t.html">H5O_stat_t</a> (defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a>) is: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_h5_o__stat__t.html">H5O_stat_t</a> {</div>
<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_o__stat__t.html#aa5b212cd36c18ffdccd85c5363889d8b">size</a>; </div>
<div class="line"> <a class="code" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code" href="struct_h5_o__stat__t.html#acdbfc9793e4909dbda74715d9d651bec">free</a>; </div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_o__stat__t.html#a005ffdb55b518afa0634576e5c3d0833">nmesgs</a>; </div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code" href="struct_h5_o__stat__t.html#a0ede30b8596ce981ce6e8ad09d2d3382">nchunks</a>; </div>
<div class="line">} <a class="code" href="struct_h5_o__stat__t.html">H5O_stat_t</a>;</div>
<div class="ttc" id="astruct_h5_o__stat__t_html_a005ffdb55b518afa0634576e5c3d0833"><div class="ttname"><a href="struct_h5_o__stat__t.html#a005ffdb55b518afa0634576e5c3d0833">H5O_stat_t::nmesgs</a></div><div class="ttdeci">unsigned nmesgs</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:1709</div></div>
<div class="ttc" id="astruct_h5_o__stat__t_html_a0ede30b8596ce981ce6e8ad09d2d3382"><div class="ttname"><a href="struct_h5_o__stat__t.html#a0ede30b8596ce981ce6e8ad09d2d3382">H5O_stat_t::nchunks</a></div><div class="ttdeci">unsigned nchunks</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:1710</div></div>
<div class="ttc" id="astruct_h5_o__stat__t_html_aa5b212cd36c18ffdccd85c5363889d8b"><div class="ttname"><a href="struct_h5_o__stat__t.html#aa5b212cd36c18ffdccd85c5363889d8b">H5O_stat_t::size</a></div><div class="ttdeci">hsize_t size</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:1707</div></div>
<div class="ttc" id="astruct_h5_o__stat__t_html_acdbfc9793e4909dbda74715d9d651bec"><div class="ttname"><a href="struct_h5_o__stat__t.html#acdbfc9793e4909dbda74715d9d651bec">H5O_stat_t::free</a></div><div class="ttdeci">hsize_t free</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:1708</div></div>
</div><!-- fragment --> <dl class="section attention"><dt>Attention</dt><dd>Some systems will be able to record the time accurately but unable to retrieve the correct time; such systems (e.g., Irix64) will report an <code>mtime</code> value of 0 (zero).</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd>
<dd>
1.6.1 Two new fields were added to the <a class="el" href="struct_h5_g__stat__t.html">H5G_stat_t</a> struct in this release. </dd></dl>
</div>
</div>
<a id="ga80180e7b819d3c9b3b3f1895e9baaf5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga80180e7b819d3c9b3b3f1895e9baaf5b">◆ </a></span>H5Gget_objname_by_idx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Gget_objname_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
<td class="paramname"><em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of an object specified by an index. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>Transient index identifying object </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">name</td><td>Pointer to user-provided buffer the object name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Name length</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the size of the object name if successful, or 0 if no name is associated with the group identifier. Otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000048">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_l.html#ga453ea40c3bb85ec8120dd17deed2bd90" title="Retrieves name of the n-th link in a group, according to the order within a specified field or index.">H5Lget_name_by_idx()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b" title="Returns the name of an object specified by an index.">H5Gget_objname_by_idx()</a> returns the name of the object specified by the index <code>idx</code> in the group <code>loc_id</code>.</p>
<p>The group is specified by a group identifier <code>loc_id</code>. If preferred, a file identifier may be passed in <code>loc_id</code>; that file's root group will be assumed.</p>
<p><code>idx</code> is the transient index used to iterate through the objects in the group. The value of <code>idx</code> is any nonnegative number less than the total number of objects in the group, which is returned by the function <a class="el" href="group___h5_g.html#ga3e30142e15ccf9a08bfc91ca9925c14d" title="Returns number of objects in the group specified by its identifier.">H5Gget_num_objs()</a>. Note that this is a transient index; an object may have a different index each time a group is opened.</p>
<p>The object name is returned in the user-specified buffer <code>name</code>.</p>
<p>If the size of the provided buffer <code>name</code> is less or equal the actual object name length, the object name is truncated to <code>max_size - 1</code> characters.</p>
<p>Note that if the size of the object's name is unknown, a preliminary call to <a class="el" href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b" title="Returns the name of an object specified by an index.">H5Gget_objname_by_idx()</a> with <code>name</code> set to <code>NULL</code> will return the length of the object's name. A second call to <a class="el" href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b" title="Returns the name of an object specified by an index.">H5Gget_objname_by_idx()</a> can then be used to retrieve the actual name.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="gab1383b8cca3fa99410ad36427059c5a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1383b8cca3fa99410ad36427059c5a7">◆ </a></span>H5Gget_objtype_by_idx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> H5Gget_objtype_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of an object specified by an index. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>Transient index identifying object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the type of the object if successful. Otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000049">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_o.html#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gab1383b8cca3fa99410ad36427059c5a7" title="Returns the type of an object specified by an index.">H5Gget_objtype_by_idx()</a> returns the type of the object specified by the index <code>idx</code> in the group <code>loc_id</code>.</p>
<p>The group is specified by a group identifier <code>loc_id</code>. If preferred, a file identifier may be passed in <code>loc_id</code>; that file's root group will be assumed.</p>
<p><code>idx</code> is the transient index used to iterate through the objects in the group. This parameter is described in more detail in the discussion of <a class="el" href="group___h5_g.html#ga80180e7b819d3c9b3b3f1895e9baaf5b" title="Returns the name of an object specified by an index.">H5Gget_objname_by_idx()</a>.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd>
<dd>
1.6.0 The function return type changed from <code>int</code> to the enumerated type <a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a>. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga957fee64f796f184f542537127ad6c11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga957fee64f796f184f542537127ad6c11">◆ </a></span>H5Giterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Giterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_gpublic_8h.html#aa2bdcd48141dd7db6e4a6d2534801697">H5G_iterate_t</a> </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>op_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over the entries of a group invoking a callback for each entry encountered. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Group over which the iteration is performed </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Location at which to begin the iteration </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Operation to be performed on an object at each step of the iteration </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">op_data</td><td>Data associated with the operation</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000045">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___t_r_a_v.html#ga1e7c0a8cf17699563c02e128f27042f1" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate1()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> iterates over the members of name in the file or group specified with <code>loc_id</code>. For each object in the group, the <code>op_data</code> and some additional information, specified below, are passed to the operator function. The iteration begins with the <code>idx</code> object in the group and the next element to be processed by the operator is returned in <code>idx</code>. If <code>idx</code> is NULL, then the iterator starts at the first group member; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero. <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> does not recursively follow links into subgroups of the specified group.</p>
<p>The prototype for <a class="el" href="_h5_gpublic_8h.html#aa2bdcd48141dd7db6e4a6d2534801697">H5G_iterate_t</a> is: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code" href="_h5_gpublic_8h.html#aa2bdcd48141dd7db6e4a6d2534801697">H5G_iterate_t</a>)(<a class="code" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">void</span> *op_data);</div>
<div class="ttc" id="a_h5_gpublic_8h_html_aa2bdcd48141dd7db6e4a6d2534801697"><div class="ttname"><a href="_h5_gpublic_8h.html#aa2bdcd48141dd7db6e4a6d2534801697">H5G_iterate_t</a></div><div class="ttdeci">herr_t(* H5G_iterate_t)(hid_t group, const char *name, void *op_data)</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:554</div></div>
<div class="ttc" id="a_h5public_8h_html_a3b079ecf932a5c599499cf7e298af160"><div class="ttname"><a href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a></div><div class="ttdeci">int herr_t</div><div class="ttdef"><b>Definition:</b> H5public.h:235</div></div>
</div><!-- fragment --><p> The operation receives the group identifier for the group being iterated over, <code>group</code>, the name of the current object within the group, <code>name</code>, and the pointer to the operator data passed into <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a>, <code>op_data</code>.</p>
<p>The return values from an operator are: </p><ul>
<li>Zero causes the iterator to continue, returning zero when all group members have been processed. </li>
<li>Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next group member. </li>
<li>Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next group member.</li>
</ul>
<p><a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> assumes that the membership of the group identified by <code>name</code> remains unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.</p>
<p><a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> is not recursive. In particular, if a member of <code>name</code> is found to be a group, call it <code>subgroup_a</code>, <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> does not examine the members of <code>subgroup_a</code>. When recursive iteration is required, the application must handle the recursion, explicitly calling <a class="el" href="group___h5_g.html#ga957fee64f796f184f542537127ad6c11" title="Iterates over the entries of a group invoking a callback for each entry encountered.">H5Giterate()</a> on discovered subgroups.</p>
<dl class="section warning"><dt>Warning</dt><dd>Adding or removing members to the group during iteration will lead to undefined behavior.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="ga1b9b2effdc1727613f81c4dcb2a4d644"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1b9b2effdc1727613f81c4dcb2a4d644">◆ </a></span>H5Glink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Glink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>cur_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cur_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>new_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a link of the specified type from <code>new_name</code> to <code>cur_name</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cur_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Link type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cur_name</td><td>Name of the existing object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_name</td><td>New name for the object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000037">Deprecated:</a></b></dt><dd>This function is deprecated.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga1b9b2effdc1727613f81c4dcb2a4d644" title="Creates a link of the specified type from new_name to cur_name.">H5Glink()</a> creates a new name for an object that has some current name, possibly one of many names it currently has.</p>
<p>If <code>link_type</code> is <a class="el" href="_h5_gpublic_8h.html#a57c964305b99e9b9f9096f44d683b009">H5G_LINK_HARD</a>, then <code>cur_name</code> must specify the name of an existing object and both names are interpreted relative to <code>cur_loc_id</code>, which is either a file identifier or a group identifier.</p>
<p>If <code>link_type</code> is <a class="el" href="_h5_gpublic_8h.html#a55f1f04ca997fe006ca614b7e8952a96">H5G_LINK_SOFT</a>, then <code>cur_name</code> can be anything and is interpreted at lookup time relative to the group which contains the final component of <code>new_name</code>. For instance, if <code>cur_name</code> is <code>./foo</code>, <code>new_name</code> is <code>./x/y/bar</code>, and a request is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="gafabd07a7f64a7cbef27c56a3bee2df47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafabd07a7f64a7cbef27c56a3bee2df47">◆ </a></span>H5Glink2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Glink2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>cur_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cur_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>new_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>new_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a link of the specified type from <code>cur_name</code> to <code>new_name</code>. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cur_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">cur_name</td><td>Name of the existing object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Link type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_name</td><td>New name for the object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000038">Deprecated:</a></b></dt><dd>This function is deprecated.</dd></dl>
<p><a class="el" href="group___h5_g.html#gafabd07a7f64a7cbef27c56a3bee2df47" title="Creates a link of the specified type from cur_name to new_name.">H5Glink2()</a> creates a new name for an object that has some current name, possibly one of many names it currently has.</p>
<p>If <code>link_type</code> is <a class="el" href="_h5_gpublic_8h.html#a57c964305b99e9b9f9096f44d683b009">H5G_LINK_HARD</a>, then <code>cur_name</code> must specify the name of an existing object and both names are interpreted relative to <code>cur_loc_id</code> and <code>new_loc_id</code>, respectively, which are either file identifiers or group identifiers.</p>
<p>If <code>link_type</code> is <a class="el" href="_h5_gpublic_8h.html#a55f1f04ca997fe006ca614b7e8952a96">H5G_LINK_SOFT</a>, then <code>cur_name</code> can be anything and is interpreted at lookup time relative to the group which contains the final component of <code>new_name</code>. For instance, if <code>current_name</code> is <code>./foo</code>, <code>new_name</code> is <code>./x/y/bar</code>, and a request is made for <code>./x/y/bar</code>, then the actual object looked up is <code>./x/y/./foo</code>.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="gaa6474351d346ad45309ae0b22ebdde9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6474351d346ad45309ae0b22ebdde9a">◆ </a></span>H5Gmove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>src_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dst_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Renames an object within an HDF5 file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">src_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_name</td><td>Object's original name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_name</td><td>Object's new name</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000039">Deprecated:</a></b></dt><dd>This function is deprecated.</dd></dl>
<p><a class="el" href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a" title="Renames an object within an HDF5 file.">H5Gmove()</a> renames an object within an HDF5 file. The original name, <code>src_name</code>, is unlinked from the group graph and the new name, <code>dst_name</code>, is inserted as an atomic operation. Both names are interpreted relative to <code>loc_id</code>, which is either a file or a group identifier.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise care in moving groups as it is possible to render data in a file inaccessible with <a class="el" href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a" title="Renames an object within an HDF5 file.">H5Gmove()</a>. See The Group Interface in the <a class="el" href="_u_g.html">HDF5 User Guide</a>.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="gad97bf21798b06b63df0bdd404cac562c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad97bf21798b06b63df0bdd404cac562c">◆ </a></span>H5Gmove2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gmove2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>src_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>src_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>dst_loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dst_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Renames an object within an HDF5 file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">src_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_name</td><td>Object's original name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_name</td><td>Object's new name</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000040">Deprecated:</a></b></dt><dd>This function is deprecated.</dd></dl>
<p><a class="el" href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c" title="Renames an object within an HDF5 file.">H5Gmove2()</a> renames an object within an HDF5 file. The original name, <code>src_name</code>, is unlinked from the group graph and the new name, <code>dst_name</code>, is inserted as an atomic operation.</p>
<p><code>src_name</code> and <code>dst_name</code> are interpreted relative to <code>src_loc_id</code> and <code>dst_loc_id</code>, respectively, which are either file or group identifiers.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise care in moving groups as it is possible to render data in a file inaccessible with <a class="el" href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c" title="Renames an object within an HDF5 file.">H5Gmove2()</a>. See The Group Interface in the <a class="el" href="_u_g.html">HDF5 User Guide</a>.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="ga163ca3eb7893d34973ee900b2da886be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga163ca3eb7893d34973ee900b2da886be">◆ </a></span>H5Gopen1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gopen1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an existing group for modification and returns a group identifier for that group. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000036">Deprecated:</a></b></dt><dd>This function is deprecated in favor of <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be" title="Opens an existing group for modification and returns a group identifier for that group.">H5Gopen1()</a> opens an existing group, <code>name</code>, at the location specified by <code>loc_id</code>.</p>
<p><a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be" title="Opens an existing group for modification and returns a group identifier for that group.">H5Gopen1()</a> returns a group identifier for the group that was opened. This group identifier should be released by calling <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> when it is no longer needed.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 The function <a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a> was renamed to <a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be" title="Opens an existing group for modification and returns a group identifier for that group.">H5Gopen1()</a> and deprecated in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gadab91e2dd7a7e253dcc0e4fe04b81403"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadab91e2dd7a7e253dcc0e4fe04b81403">◆ </a></span>H5Gopen2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Gopen2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>gapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an existing group in a file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the group to open </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">gapl_id</td><td>Group access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a group identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a> opens an existing group, <code>name</code>, at the location specified by <code>loc_id</code>.</p>
<p>With default settings, <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a> provides similar functionality to that provided by <a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a>. The only difference is that <a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a> can provide a group access property list, <code>gapl_id</code>.</p>
<p><a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2()</a> returns a group identifier for the group that was opened. This group identifier should be released by <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a> when it is no longer needed to prevent resource leaks.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="Creates a new group and links it into the file.">H5Gcreate2()</a> </dd></dl>
</div>
</div>
<a id="ga0a8bdd0eb1b001222c27d3d39a909840"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a8bdd0eb1b001222c27d3d39a909840">◆ </a></span>H5Grefresh()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Grefresh </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>group_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes all buffers associated with a group. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">group_id</td><td>Group identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840" title="Refreshes all buffers associated with a group.">H5Grefresh()</a> causes all buffers associated with a group to be cleared and immediately re-loaded with updated contents from disk.</p>
<p>This function essentially closes the group, evicts all metadata associated with it from the cache, and then reopens the group. The reopened group is automatically re-registered with the same identifier.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga7a615715ea68fc1bf11484a8278fe682"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a615715ea68fc1bf11484a8278fe682">◆ </a></span>H5Gset_comment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gset_comment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>comment</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets comment for specified object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the object whose comment is to be set or reset name must be <code>'.'</code> (dot) if <code>loc_id</code> fully specifies the object for which the comment is to be set. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">comment</td><td>The new comment</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000043">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_o.html#ga8b5cf8e916204e29616516046121f631" title="Sets comment for specified object.">H5Oset_comment()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#ga7a615715ea68fc1bf11484a8278fe682" title="Sets comment for specified object.">H5Gset_comment()</a> sets the comment for the object specified by <code>loc_id</code> and name to comment. Any previously existing comment is overwritten.</p>
<p><code>loc_id</code> can specify any object in the file. name can be one of the following: </p><ul>
<li>The name of the object relative to <code>loc_id</code> </li>
<li>An absolute name of the object, starting from <code>/</code>, the file's root group </li>
<li>A dot (<code></code>.), if <code>loc_id</code> fully specifies the object</li>
</ul>
<p>If <code>comment</code> is the empty string or a null pointer, the comment message is removed from the object.</p>
<p>Comments should be relatively short, null-terminated, ASCII strings.</p>
<p>Comments can be attached to any object that has an object header, e.g., datasets, groups, and named datatypes, but not symbolic links.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </dd></dl>
</div>
</div>
<a id="gacb843cbd5bbb816cfa9c855463d1e51c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb843cbd5bbb816cfa9c855463d1e51c">◆ </a></span>H5Gunlink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Gunlink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the link to an object from a group. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file or group. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the object to unlink</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000041">Deprecated:</a></b></dt><dd>This function is deprecated in favor of the function <a class="el" href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete()</a>.</dd></dl>
<p><a class="el" href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c" title="Removes the link to an object from a group.">H5Gunlink()</a> removes the object specified by <code>name</code> from the group graph and decrements the link count for the object to which <code>name</code> points. This action eliminates any association between name and the object to which name pointed.</p>
<p>Object headers keep track of how many hard links refer to an object; when the link count reaches zero, the object can be removed from the file. Objects which are open are not removed until all identifiers to the object are closed.</p>
<p>If the link count reaches zero, all file space associated with the object will be released, i.e., identified in memory as freespace. If any object identifier is open for the object, the space will not be released until after the object identifier is closed.</p>
<p>Note that space identified as freespace is available for reuse only as long as the file remains open; once a file has been closed, the HDF5 library loses track of freespace. See “Freespace Management” in the <a class="el" href="_u_g.html">HDF5 User Guide</a> for further details.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise care in moving groups as it is possible to render data in a file inaccessible with <a class="el" href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c" title="Removes the link to an object from a group.">H5Gunlink()</a>. See The Group Interface in the <a class="el" href="_u_g.html">HDF5 User Guide</a>.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.0 Function deprecated in this release. </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.9.1 </li>
</ul>
</div>
</body>
</html>
|
