1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Objects (H5O)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.2908dd1</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___h5_o.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Objects (H5O)</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 objects.</p>
<p>HDF5 objects (groups, datasets, datatype objects) are usually created using functions in the object-specific modules (<a class="el" href="group___h5_g.html">Groups (H5G)</a>, <a class="el" href="group___h5_d.html">Datasets (H5D)</a>, <a class="el" href="group___h5_t.html">Datatypes (H5T)</a>). However, new objects can also be created by copying existing objects.</p>
<p>Many functions in this module are variations on object introspection, that is, the retrieval of detailed information about HDF5 objects in a file. Objects in an HDF5 file can be "visited" in an iterative fashion.</p>
<p>HDF5 objects are usually updated using functions in the object-specific modules. However, there are certain generic object properties, such as reference counts, that can be manipulated using functions in this module.</p>
<p>HDF5 objects are deleted as a side effect of rendering them unreachable from the root group. The net effect is the diminution of the object's reference count to zero, which can (but should not usually) be affected by a function in this module.</p>
<table class="doxtable">
<tr>
<th>Create</th><th>Read </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"><span class="lineno"> 16</span> {</div>
<div class="line"><span class="lineno"> 17</span> __label__ fail_file;</div>
<div class="line"><span class="lineno"> 18</span> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, group;</div>
<div class="line"><span class="lineno"> 19</span> <span class="keywordtype">char</span> src_path[] = <span class="stringliteral">"/a/few/groups"</span>;</div>
<div class="line"><span class="lineno"> 20</span> </div>
<div class="line"><span class="lineno"> 21</span> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(<span class="stringliteral">"o1.h5"</span>, <a class="code hl_define" href="_h5_fpublic_8h.html#a5a2d6726f9ad8d2bca8df2b817e5ad6a">H5F_ACC_TRUNC</a>, H5P_DEFAULTx2)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 22</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 23</span> <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><span class="lineno"> 24</span> }</div>
<div class="line"><span class="lineno"> 25</span> </div>
<div class="line"><span class="lineno"> 26</span> <span class="comment">// create a few groups</span></div>
<div class="line"><span class="lineno"> 27</span> {</div>
<div class="line"><span class="lineno"> 28</span> __label__ fail_group, fail_lcpl;</div>
<div class="line"><span class="lineno"> 29</span> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl;</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordflow">if</span> ((lcpl = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#ad2c1d10104f0262c826350ccbf7c49f2">H5P_LINK_CREATE</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 31</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 32</span> <span class="keywordflow">goto</span> fail_lcpl;</div>
<div class="line"><span class="lineno"> 33</span> }</div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a>(lcpl, 1) < 0) {</div>
<div class="line"><span class="lineno"> 35</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 36</span> <span class="keywordflow">goto</span> fail_group;</div>
<div class="line"><span class="lineno"> 37</span> }</div>
<div class="line"><span class="lineno"> 38</span> <span class="keywordflow">if</span> ((group = <a class="code hl_define" href="group___h5_g.html#ga187cee27a9fc4f1a311eb19b0522c7b8">H5Gcreate</a>(file, src_path, lcpl, H5P_DEFAULTx2)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 39</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 40</span> <span class="keywordflow">goto</span> fail_group;</div>
<div class="line"><span class="lineno"> 41</span> }</div>
<div class="line"><span class="lineno"> 42</span> </div>
<div class="line"><span class="lineno"> 43</span> <a class="code hl_function" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221">H5Gclose</a>(group);</div>
<div class="line"><span class="lineno"> 44</span>fail_group:</div>
<div class="line"><span class="lineno"> 45</span> <a class="code hl_function" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(lcpl);</div>
<div class="line"><span class="lineno"> 46</span>fail_lcpl:;</div>
<div class="line"><span class="lineno"> 47</span> }</div>
<div class="line"><span class="lineno"> 48</span> </div>
<div class="line"><span class="lineno"> 49</span> <span class="comment">// create a copy</span></div>
<div class="line"><span class="lineno"> 50</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gaa94449be6f67f499be5ddd3fc44f4225">H5Ocopy</a>(file, <span class="stringliteral">"."</span>, file, <span class="stringliteral">"copy of"</span>, H5P_DEFAULTx2) < 0) {</div>
<div class="line"><span class="lineno"> 51</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 52</span> }</div>
<div class="line"><span class="lineno"> 53</span> </div>
<div class="line"><span class="lineno"> 54</span> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><span class="lineno"> 55</span>fail_file:;</div>
<div class="line"><span class="lineno"> 56</span> }</div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><span class="lineno"> 60</span> {</div>
<div class="line"><span class="lineno"> 61</span> __label__ fail_info, fail_file;</div>
<div class="line"><span class="lineno"> 62</span> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file;</div>
<div class="line"><span class="lineno"> 63</span> <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/a/few/groups"</span>;</div>
<div class="line"><span class="lineno"> 64</span> <a class="code hl_struct" href="struct_h5_o__info2__t.html">H5O_info2_t</a> info;</div>
<div class="line"><span class="lineno"> 65</span> </div>
<div class="line"><span class="lineno"> 66</span> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"o1.h5"</span>, <a class="code hl_define" href="_h5_fpublic_8h.html#a1c406ffa89f4acf5a332144a2683d394">H5F_ACC_RDONLY</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 67</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 68</span> <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><span class="lineno"> 69</span> }</div>
<div class="line"><span class="lineno"> 70</span> </div>
<div class="line"><span class="lineno"> 71</span> <span class="comment">// retrieve information about the object</span></div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name</a>(file, path, &info, <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="code hl_define" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div>
<div class="line"><span class="lineno"> 73</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 74</span> <span class="keywordflow">goto</span> fail_info;</div>
<div class="line"><span class="lineno"> 75</span> }</div>
<div class="line"><span class="lineno"> 76</span> </div>
<div class="line"><span class="lineno"> 77</span> <span class="comment">// determine the object type</span></div>
<div class="line"><span class="lineno"> 78</span> <span class="keywordflow">switch</span> (info.<a class="code hl_variable" href="struct_h5_o__info2__t.html#a6e12ef8203e400ee995a41a24e981539">type</a>) {</div>
<div class="line"><span class="lineno"> 79</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecadab6343bd9f2c6d54d07816d5d823cf8">H5O_TYPE_GROUP</a>:</div>
<div class="line"><span class="lineno"> 80</span> printf(<span class="stringliteral">"HDF5 group\n"</span>);</div>
<div class="line"><span class="lineno"> 81</span> <span class="keywordflow">break</span>;</div>
<div class="line"><span class="lineno"> 82</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca5ca744a77f8cd2b28dda90c37807ae31">H5O_TYPE_DATASET</a>:</div>
<div class="line"><span class="lineno"> 83</span> printf(<span class="stringliteral">"HDF5 dataset\n"</span>);</div>
<div class="line"><span class="lineno"> 84</span> <span class="keywordflow">break</span>;</div>
<div class="line"><span class="lineno"> 85</span> <span class="keywordflow">case</span> <a class="code hl_enumvalue" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaaf17b046771c311d41bed7383874050e">H5O_TYPE_NAMED_DATATYPE</a>:</div>
<div class="line"><span class="lineno"> 86</span> printf(<span class="stringliteral">"HDF5 datatype\n"</span>);</div>
<div class="line"><span class="lineno"> 87</span> <span class="keywordflow">break</span>;</div>
<div class="line"><span class="lineno"> 88</span> <span class="keywordflow">default</span>:</div>
<div class="line"><span class="lineno"> 89</span> printf(<span class="stringliteral">"UFO?\n"</span>);</div>
<div class="line"><span class="lineno"> 90</span> <span class="keywordflow">break</span>;</div>
<div class="line"><span class="lineno"> 91</span> }</div>
<div class="line"><span class="lineno"> 92</span> <span class="comment">// print basic information</span></div>
<div class="line"><span class="lineno"> 93</span> printf(<span class="stringliteral">"Reference count: %u\n"</span>, info.<a class="code hl_variable" href="struct_h5_o__info2__t.html#a299ecaad7f9548089654d47a1b06291f">rc</a>);</div>
<div class="line"><span class="lineno"> 94</span> printf(<span class="stringliteral">"Attribute count: %lld\n"</span>, info.<a class="code hl_variable" href="struct_h5_o__info2__t.html#abc37a3659a46ce6096446cfd0d9f67ff">num_attrs</a>);</div>
<div class="line"><span class="lineno"> 95</span> </div>
<div class="line"><span class="lineno"> 96</span>fail_info:</div>
<div class="line"><span class="lineno"> 97</span> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><span class="lineno"> 98</span>fail_file:;</div>
<div class="line"><span class="lineno"> 99</span> }</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Update</th><th>Delete </th></tr>
<tr valign="top">
<td><div class="fragment"><div class="line"><span class="lineno"> 103</span> {</div>
<div class="line"><span class="lineno"> 104</span> __label__ fail_obj, fail_incr, fail_file;</div>
<div class="line"><span class="lineno"> 105</span> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, obj;</div>
<div class="line"><span class="lineno"> 106</span> <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/a/few/groups"</span>;</div>
<div class="line"><span class="lineno"> 107</span> <a class="code hl_struct" href="struct_h5_o__info2__t.html">H5O_info2_t</a> info;</div>
<div class="line"><span class="lineno"> 108</span> </div>
<div class="line"><span class="lineno"> 109</span> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"o1.h5"</span>, <a class="code hl_define" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 110</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 111</span> <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><span class="lineno"> 112</span> }</div>
<div class="line"><span class="lineno"> 113</span> </div>
<div class="line"><span class="lineno"> 114</span> <span class="comment">// open an object by path name</span></div>
<div class="line"><span class="lineno"> 115</span> <span class="keywordflow">if</span> ((obj = <a class="code hl_function" href="#ga9f635f58c7ddf17f87c253bfbca08bc1">H5Oopen</a>(file, path, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 116</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 117</span> <span class="keywordflow">goto</span> fail_obj;</div>
<div class="line"><span class="lineno"> 118</span> }</div>
<div class="line"><span class="lineno"> 119</span> </div>
<div class="line"><span class="lineno"> 120</span> <span class="comment">// bump its reference count (by 1)</span></div>
<div class="line"><span class="lineno"> 121</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga2086bad6c3cd2a711c306a48c093ff55">H5Oincr_refcount</a>(obj) < 0) {</div>
<div class="line"><span class="lineno"> 122</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 123</span> <span class="keywordflow">goto</span> fail_incr;</div>
<div class="line"><span class="lineno"> 124</span> }</div>
<div class="line"><span class="lineno"> 125</span> </div>
<div class="line"><span class="lineno"> 126</span> <span class="comment">// confirm the new reference count</span></div>
<div class="line"><span class="lineno"> 127</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a>(obj, &info, <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>) < 0) {</div>
<div class="line"><span class="lineno"> 128</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 129</span> <span class="keywordflow">goto</span> fail_incr;</div>
<div class="line"><span class="lineno"> 130</span> }</div>
<div class="line"><span class="lineno"> 131</span> printf(<span class="stringliteral">"Reference count: %u\n"</span>, info.<a class="code hl_variable" href="struct_h5_o__info2__t.html#a299ecaad7f9548089654d47a1b06291f">rc</a>);</div>
<div class="line"><span class="lineno"> 132</span> </div>
<div class="line"><span class="lineno"> 133</span>fail_incr:</div>
<div class="line"><span class="lineno"> 134</span> <a class="code hl_function" href="#ga545ad7c54987013ebd50b40fe9e73c61">H5Oclose</a>(obj);</div>
<div class="line"><span class="lineno"> 135</span>fail_obj:</div>
<div class="line"><span class="lineno"> 136</span> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><span class="lineno"> 137</span>fail_file:;</div>
<div class="line"><span class="lineno"> 138</span> }</div>
</div><!-- fragment --> </td><td><div class="fragment"><div class="line"><span class="lineno"> 142</span> {</div>
<div class="line"><span class="lineno"> 143</span> __label__ fail_obj, fail_delete, fail_file;</div>
<div class="line"><span class="lineno"> 144</span> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file, obj;</div>
<div class="line"><span class="lineno"> 145</span> <span class="keywordtype">char</span> path[] = <span class="stringliteral">"/a/few/groups"</span>;</div>
<div class="line"><span class="lineno"> 146</span> <a class="code hl_struct" href="struct_h5_o__info2__t.html">H5O_info2_t</a> info;</div>
<div class="line"><span class="lineno"> 147</span> </div>
<div class="line"><span class="lineno"> 148</span> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc">H5Fopen</a>(<span class="stringliteral">"o1.h5"</span>, <a class="code hl_define" href="_h5_fpublic_8h.html#a402673dec5c537b27a49a9a8bd6140b4">H5F_ACC_RDWR</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 149</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 150</span> <span class="keywordflow">goto</span> fail_file;</div>
<div class="line"><span class="lineno"> 151</span> }</div>
<div class="line"><span class="lineno"> 152</span> </div>
<div class="line"><span class="lineno"> 153</span> <span class="comment">// open an object by path name</span></div>
<div class="line"><span class="lineno"> 154</span> <span class="keywordflow">if</span> ((obj = <a class="code hl_function" href="#ga9f635f58c7ddf17f87c253bfbca08bc1">H5Oopen</a>(file, path, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
<div class="line"><span class="lineno"> 155</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 156</span> <span class="keywordflow">goto</span> fail_obj;</div>
<div class="line"><span class="lineno"> 157</span> }</div>
<div class="line"><span class="lineno"> 158</span> </div>
<div class="line"><span class="lineno"> 159</span> <span class="comment">// render it inaccessible from the root group by deleting the one and</span></div>
<div class="line"><span class="lineno"> 160</span> <span class="comment">// only link to it; this drops the reference count by 1</span></div>
<div class="line"><span class="lineno"> 161</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf">H5Ldelete</a>(file, path, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0) {</div>
<div class="line"><span class="lineno"> 162</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 163</span> <span class="keywordflow">goto</span> fail_delete;</div>
<div class="line"><span class="lineno"> 164</span> }</div>
<div class="line"><span class="lineno"> 165</span> </div>
<div class="line"><span class="lineno"> 166</span> <span class="comment">// confirm the new reference count</span></div>
<div class="line"><span class="lineno"> 167</span> <span class="keywordflow">if</span> (<a class="code hl_define" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a>(obj, &info, <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>) < 0) {</div>
<div class="line"><span class="lineno"> 168</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 169</span> <span class="keywordflow">goto</span> fail_delete;</div>
<div class="line"><span class="lineno"> 170</span> }</div>
<div class="line"><span class="lineno"> 171</span> printf(<span class="stringliteral">"Reference count: %u\n"</span>, info.<a class="code hl_variable" href="struct_h5_o__info2__t.html#a299ecaad7f9548089654d47a1b06291f">rc</a>);</div>
<div class="line"><span class="lineno"> 172</span> </div>
<div class="line"><span class="lineno"> 173</span> <span class="comment">// if we close the file at this point, we'd be creating a tombstone,</span></div>
<div class="line"><span class="lineno"> 174</span> <span class="comment">// an object that cannot be reached and that cannot be reclaimed by the</span></div>
<div class="line"><span class="lineno"> 175</span> <span class="comment">// freespace manager; decrement the reference count to zero to prevent that</span></div>
<div class="line"><span class="lineno"> 176</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="group___h5_i.html#gaea2aa78caea892edf2a6a6ac70486ed9">H5Idec_ref</a>(obj) < 0) {</div>
<div class="line"><span class="lineno"> 177</span> ret_val = EXIT_FAILURE;</div>
<div class="line"><span class="lineno"> 178</span> <span class="keywordflow">goto</span> fail_delete;</div>
<div class="line"><span class="lineno"> 179</span> }</div>
<div class="line"><span class="lineno"> 180</span> <span class="keywordflow">else</span></div>
<div class="line"><span class="lineno"> 181</span> <span class="comment">// attempting to close the object would be like a double H5Oclose and fail</span></div>
<div class="line"><span class="lineno"> 182</span> <span class="keywordflow">goto</span> fail_obj;</div>
<div class="line"><span class="lineno"> 183</span> </div>
<div class="line"><span class="lineno"> 184</span>fail_delete:</div>
<div class="line"><span class="lineno"> 185</span> <a class="code hl_function" href="#ga545ad7c54987013ebd50b40fe9e73c61">H5Oclose</a>(obj);</div>
<div class="line"><span class="lineno"> 186</span>fail_obj:</div>
<div class="line"><span class="lineno"> 187</span> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
<div class="line"><span class="lineno"> 188</span>fail_file:;</div>
<div class="line"><span class="lineno"> 189</span> }</div>
</div><!-- fragment --> </td></tr>
</table>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaf4f302a33faba9e1c2b5f64c62ca4ed5" id="r_gaf4f302a33faba9e1c2b5f64c62ca4ed5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a>   <a class="el" href="#gaf0fbf7d780a1eefce920facadb198013">H5Oget_info3</a></td></tr>
<tr class="separator:gaf4f302a33faba9e1c2b5f64c62ca4ed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe764884e1530f86079288dd5895a7bd" id="r_gafe764884e1530f86079288dd5895a7bd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx</a>   <a class="el" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb">H5Oget_info_by_idx3</a></td></tr>
<tr class="separator:gafe764884e1530f86079288dd5895a7bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga16d8ac07f9244cfccb42b5f309ca6b3c" id="r_ga16d8ac07f9244cfccb42b5f309ca6b3c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name</a>   <a class="el" href="#gabb69c962999e027cef0079bbb1282199">H5Oget_info_by_name3</a></td></tr>
<tr class="separator:ga16d8ac07f9244cfccb42b5f309ca6b3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ce86255fcc34ceaf84a62551cd24233" id="r_ga5ce86255fcc34ceaf84a62551cd24233"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit</a>   <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a">H5Ovisit3</a></td></tr>
<tr class="separator:ga5ce86255fcc34ceaf84a62551cd24233"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab02a69e88b11404e7fd61f55344b186c" id="r_gab02a69e88b11404e7fd61f55344b186c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a>   <a class="el" href="#ga34815400b01df59c4dac19436124885a">H5Ovisit_by_name3</a></td></tr>
<tr class="separator:gab02a69e88b11404e7fd61f55344b186c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9f635f58c7ddf17f87c253bfbca08bc1" id="r_ga9f635f58c7ddf17f87c253bfbca08bc1"><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="#ga9f635f58c7ddf17f87c253bfbca08bc1">H5Oopen</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> lapl_id)</td></tr>
<tr class="memdesc:ga9f635f58c7ddf17f87c253bfbca08bc1"><td class="mdescLeft"> </td><td class="mdescRight">Opens an object in an HDF5 file by location identifier and path name. <br /></td></tr>
<tr class="separator:ga9f635f58c7ddf17f87c253bfbca08bc1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ea3627cf171d0565307702a5e203262" id="r_ga2ea3627cf171d0565307702a5e203262"><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="#ga2ea3627cf171d0565307702a5e203262">H5Oopen_by_token</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> token)</td></tr>
<tr class="memdesc:ga2ea3627cf171d0565307702a5e203262"><td class="mdescLeft"> </td><td class="mdescRight">Opens an object in an HDF5 file using its VOL independent token. <br /></td></tr>
<tr class="separator:ga2ea3627cf171d0565307702a5e203262"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb66e5cbb3ca79890fc284a0b06762be" id="r_gaeb66e5cbb3ca79890fc284a0b06762be"><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="#gaeb66e5cbb3ca79890fc284a0b06762be">H5Oopen_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="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gaeb66e5cbb3ca79890fc284a0b06762be"><td class="mdescLeft"> </td><td class="mdescRight">Opens the nth object in a group. <br /></td></tr>
<tr class="separator:gaeb66e5cbb3ca79890fc284a0b06762be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0fef18d97844c4f83d412c5a22def7b" id="r_gab0fef18d97844c4f83d412c5a22def7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b">H5Oexists_by_name</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> lapl_id)</td></tr>
<tr class="memdesc:gab0fef18d97844c4f83d412c5a22def7b"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a link resolves to an actual object. <br /></td></tr>
<tr class="separator:gab0fef18d97844c4f83d412c5a22def7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0fbf7d780a1eefce920facadb198013" id="r_gaf0fbf7d780a1eefce920facadb198013"><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="#gaf0fbf7d780a1eefce920facadb198013">H5Oget_info3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *oinfo, unsigned fields)</td></tr>
<tr class="memdesc:gaf0fbf7d780a1eefce920facadb198013"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object specified by an identifier. <br /></td></tr>
<tr class="separator:gaf0fbf7d780a1eefce920facadb198013"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabb69c962999e027cef0079bbb1282199" id="r_gabb69c962999e027cef0079bbb1282199"><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="#gabb69c962999e027cef0079bbb1282199">H5Oget_info_by_name3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gabb69c962999e027cef0079bbb1282199"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by location and relative name. <br /></td></tr>
<tr class="separator:gabb69c962999e027cef0079bbb1282199"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa2f8884f7d3e7fd9b8549f5b59fd9eb" id="r_gafa2f8884f7d3e7fd9b8549f5b59fd9eb"><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="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb">H5Oget_info_by_idx3</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_o__info2__t.html">H5O_info2_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gafa2f8884f7d3e7fd9b8549f5b59fd9eb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by an index position. <br /></td></tr>
<tr class="separator:gafa2f8884f7d3e7fd9b8549f5b59fd9eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga677d99ab106e2032b991b75b75de0e46" id="r_ga677d99ab106e2032b991b75b75de0e46"><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="#ga677d99ab106e2032b991b75b75de0e46">H5Oget_native_info</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a> *oinfo, unsigned fields)</td></tr>
<tr class="memdesc:ga677d99ab106e2032b991b75b75de0e46"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve native file format information about an object. <br /></td></tr>
<tr class="separator:ga677d99ab106e2032b991b75b75de0e46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga296ded21aeac3921fee07272353b8476" id="r_ga296ded21aeac3921fee07272353b8476"><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="#ga296ded21aeac3921fee07272353b8476">H5Oget_native_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_o__native__info__t.html">H5O_native_info_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga296ded21aeac3921fee07272353b8476"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve native file format information about an object given its name. <br /></td></tr>
<tr class="separator:ga296ded21aeac3921fee07272353b8476"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa6570d8b0ef6e2aff75093e1f99f67e" id="r_gafa6570d8b0ef6e2aff75093e1f99f67e"><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="#gafa6570d8b0ef6e2aff75093e1f99f67e">H5Oget_native_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_o__native__info__t.html">H5O_native_info_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gafa6570d8b0ef6e2aff75093e1f99f67e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve native file format information about an object according to the order of an index. <br /></td></tr>
<tr class="separator:gafa6570d8b0ef6e2aff75093e1f99f67e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2c97dd58e64b67d16325fceb7e02113f" id="r_ga2c97dd58e64b67d16325fceb7e02113f"><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="#ga2c97dd58e64b67d16325fceb7e02113f">H5Olink</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> new_loc_id, const char *new_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> lapl_id)</td></tr>
<tr class="memdesc:ga2c97dd58e64b67d16325fceb7e02113f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a hard link to an object in an HDF5 file. <br /></td></tr>
<tr class="separator:ga2c97dd58e64b67d16325fceb7e02113f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2086bad6c3cd2a711c306a48c093ff55" id="r_ga2086bad6c3cd2a711c306a48c093ff55"><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="#ga2086bad6c3cd2a711c306a48c093ff55">H5Oincr_refcount</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id)</td></tr>
<tr class="memdesc:ga2086bad6c3cd2a711c306a48c093ff55"><td class="mdescLeft"> </td><td class="mdescRight">Increments an object reference count. <br /></td></tr>
<tr class="separator:ga2086bad6c3cd2a711c306a48c093ff55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60c20da5e244c28a653d4fa23d316b44" id="r_ga60c20da5e244c28a653d4fa23d316b44"><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="#ga60c20da5e244c28a653d4fa23d316b44">H5Odecr_refcount</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id)</td></tr>
<tr class="memdesc:ga60c20da5e244c28a653d4fa23d316b44"><td class="mdescLeft"> </td><td class="mdescRight">Decrements an object reference count. <br /></td></tr>
<tr class="separator:ga60c20da5e244c28a653d4fa23d316b44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa94449be6f67f499be5ddd3fc44f4225" id="r_gaa94449be6f67f499be5ddd3fc44f4225"><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="#gaa94449be6f67f499be5ddd3fc44f4225">H5Ocopy</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, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> ocpypl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id)</td></tr>
<tr class="memdesc:gaa94449be6f67f499be5ddd3fc44f4225"><td class="mdescLeft"> </td><td class="mdescRight">Copies an object in an HDF5 file. <br /></td></tr>
<tr class="separator:gaa94449be6f67f499be5ddd3fc44f4225"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8b5cf8e916204e29616516046121f631" id="r_ga8b5cf8e916204e29616516046121f631"><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="#ga8b5cf8e916204e29616516046121f631">H5Oset_comment</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, const char *comment)</td></tr>
<tr class="memdesc:ga8b5cf8e916204e29616516046121f631"><td class="mdescLeft"> </td><td class="mdescRight">Sets comment for specified object. <br /></td></tr>
<tr class="separator:ga8b5cf8e916204e29616516046121f631"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafeb5242de7f1080b5c19f4fe19784505" id="r_gafeb5242de7f1080b5c19f4fe19784505"><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="#gafeb5242de7f1080b5c19f4fe19784505">H5Oset_comment_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, const char *comment, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gafeb5242de7f1080b5c19f4fe19784505"><td class="mdescLeft"> </td><td class="mdescRight">Sets comment for specified object. <br /></td></tr>
<tr class="separator:gafeb5242de7f1080b5c19f4fe19784505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1511ce5e2fe01ce7ea58f2f851d694b" id="r_gaa1511ce5e2fe01ce7ea58f2f851d694b"><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="#gaa1511ce5e2fe01ce7ea58f2f851d694b">H5Oget_comment</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, char *comment, size_t bufsize)</td></tr>
<tr class="memdesc:gaa1511ce5e2fe01ce7ea58f2f851d694b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for specified object. <br /></td></tr>
<tr class="separator:gaa1511ce5e2fe01ce7ea58f2f851d694b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae6d92d597c5a292d342a1bda91e41171" id="r_gae6d92d597c5a292d342a1bda91e41171"><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="#gae6d92d597c5a292d342a1bda91e41171">H5Oget_comment_by_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, char *comment, size_t bufsize, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gae6d92d597c5a292d342a1bda91e41171"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for specified object. <br /></td></tr>
<tr class="separator:gae6d92d597c5a292d342a1bda91e41171"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d03115ae0e5e5b516bbf35bb492266a" id="r_ga6d03115ae0e5e5b516bbf35bb492266a"><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="#ga6d03115ae0e5e5b516bbf35bb492266a">H5Ovisit3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <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="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a> op, void *op_data, unsigned fields)</td></tr>
<tr class="memdesc:ga6d03115ae0e5e5b516bbf35bb492266a"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects accessible from a specified object. <br /></td></tr>
<tr class="separator:ga6d03115ae0e5e5b516bbf35bb492266a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga34815400b01df59c4dac19436124885a" id="r_ga34815400b01df59c4dac19436124885a"><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="#ga34815400b01df59c4dac19436124885a">H5Ovisit_by_name3</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_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="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a> op, void *op_data, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga34815400b01df59c4dac19436124885a"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects accessible from a specified object. <br /></td></tr>
<tr class="separator:ga34815400b01df59c4dac19436124885a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga545ad7c54987013ebd50b40fe9e73c61" id="r_ga545ad7c54987013ebd50b40fe9e73c61"><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="#ga545ad7c54987013ebd50b40fe9e73c61">H5Oclose</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id)</td></tr>
<tr class="memdesc:ga545ad7c54987013ebd50b40fe9e73c61"><td class="mdescLeft"> </td><td class="mdescRight">Closes an object in an HDF5 file. <br /></td></tr>
<tr class="separator:ga545ad7c54987013ebd50b40fe9e73c61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad99f35048cba4534b6393214684f090f" id="r_gad99f35048cba4534b6393214684f090f"><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="#gad99f35048cba4534b6393214684f090f">H5Oflush</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id)</td></tr>
<tr class="memdesc:gad99f35048cba4534b6393214684f090f"><td class="mdescLeft"> </td><td class="mdescRight">Flushes all buffers associated with an HDF5 object to disk. <br /></td></tr>
<tr class="separator:gad99f35048cba4534b6393214684f090f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf0318b68be9ab23a92b8a6bee0af9e2f" id="r_gaf0318b68be9ab23a92b8a6bee0af9e2f"><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="#gaf0318b68be9ab23a92b8a6bee0af9e2f">H5Orefresh</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oid)</td></tr>
<tr class="memdesc:gaf0318b68be9ab23a92b8a6bee0af9e2f"><td class="mdescLeft"> </td><td class="mdescRight">Refreshes all buffers associated with an HDF5 object. <br /></td></tr>
<tr class="separator:gaf0318b68be9ab23a92b8a6bee0af9e2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0908be309da1fb4f771c1e264fac22ae" id="r_ga0908be309da1fb4f771c1e264fac22ae"><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="#ga0908be309da1fb4f771c1e264fac22ae">H5Odisable_mdc_flushes</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id)</td></tr>
<tr class="memdesc:ga0908be309da1fb4f771c1e264fac22ae"><td class="mdescLeft"> </td><td class="mdescRight">Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage. <br /></td></tr>
<tr class="separator:ga0908be309da1fb4f771c1e264fac22ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga21014920bdabf6973e233796d7174156" id="r_ga21014920bdabf6973e233796d7174156"><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="#ga21014920bdabf6973e233796d7174156">H5Oenable_mdc_flushes</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id)</td></tr>
<tr class="memdesc:ga21014920bdabf6973e233796d7174156"><td class="mdescLeft"> </td><td class="mdescRight">Enables flushing of dirty metadata entries from a file's metadata cache. <br /></td></tr>
<tr class="separator:ga21014920bdabf6973e233796d7174156"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab2fa388aadd1ff154ee150cbb4884c1c" id="r_gab2fa388aadd1ff154ee150cbb4884c1c"><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="#gab2fa388aadd1ff154ee150cbb4884c1c">H5Oare_mdc_flushes_disabled</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> object_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *are_disabled)</td></tr>
<tr class="memdesc:gab2fa388aadd1ff154ee150cbb4884c1c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves comment for specified object. <br /></td></tr>
<tr class="separator:gab2fa388aadd1ff154ee150cbb4884c1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeb8da4fbe62f8a3cd9146a7ac1093562" id="r_gaeb8da4fbe62f8a3cd9146a7ac1093562"><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="#gaeb8da4fbe62f8a3cd9146a7ac1093562">H5Otoken_cmp</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *token1, const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *token2, int *cmp_value)</td></tr>
<tr class="memdesc:gaeb8da4fbe62f8a3cd9146a7ac1093562"><td class="mdescLeft"> </td><td class="mdescRight">Compares two VOL connector object tokens. <br /></td></tr>
<tr class="separator:gaeb8da4fbe62f8a3cd9146a7ac1093562"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2bdd7528090f7f2c4b361ab4cc7735f6" id="r_ga2bdd7528090f7f2c4b361ab4cc7735f6"><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="#ga2bdd7528090f7f2c4b361ab4cc7735f6">H5Otoken_to_str</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *token, char **token_str)</td></tr>
<tr class="memdesc:ga2bdd7528090f7f2c4b361ab4cc7735f6"><td class="mdescLeft"> </td><td class="mdescRight">Serializes a connector's object token into a string. <br /></td></tr>
<tr class="separator:ga2bdd7528090f7f2c4b361ab4cc7735f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5136c14b4e907f15007030d7a6d6cd24" id="r_ga5136c14b4e907f15007030d7a6d6cd24"><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="#ga5136c14b4e907f15007030d7a6d6cd24">H5Otoken_from_str</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *token_str, <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *token)</td></tr>
<tr class="memdesc:ga5136c14b4e907f15007030d7a6d6cd24"><td class="mdescLeft"> </td><td class="mdescRight">Deserializes a string into a connector object token. <br /></td></tr>
<tr class="separator:ga5136c14b4e907f15007030d7a6d6cd24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga137f3823adab4daaaf8fe87b40453fa2" id="r_ga137f3823adab4daaaf8fe87b40453fa2"><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="#ga137f3823adab4daaaf8fe87b40453fa2">H5Oopen_by_addr</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> addr)</td></tr>
<tr class="memdesc:ga137f3823adab4daaaf8fe87b40453fa2"><td class="mdescLeft"> </td><td class="mdescRight">Opens an object using its address within an HDF5 file. <br /></td></tr>
<tr class="separator:ga137f3823adab4daaaf8fe87b40453fa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3751684a6706e3ba49b863406011f80" id="r_gaf3751684a6706e3ba49b863406011f80"><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="#gaf3751684a6706e3ba49b863406011f80">H5Oget_info1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *oinfo)</td></tr>
<tr class="memdesc:gaf3751684a6706e3ba49b863406011f80"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object specified by an identifier. <br /></td></tr>
<tr class="separator:gaf3751684a6706e3ba49b863406011f80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga96ce408ffda805210844246904da2842" id="r_ga96ce408ffda805210844246904da2842"><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="#ga96ce408ffda805210844246904da2842">H5Oget_info_by_name1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *oinfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga96ce408ffda805210844246904da2842"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by location and relative name. <br /></td></tr>
<tr class="separator:ga96ce408ffda805210844246904da2842"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7208d2cf198dcfc875603323841bffae" id="r_ga7208d2cf198dcfc875603323841bffae"><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="#ga7208d2cf198dcfc875603323841bffae">H5Oget_info_by_idx1</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_o__info1__t.html">H5O_info1_t</a> *oinfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga7208d2cf198dcfc875603323841bffae"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by an index position. <br /></td></tr>
<tr class="separator:ga7208d2cf198dcfc875603323841bffae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga06f896e14fe4fa940fbc2bc235e0cf74" id="r_ga06f896e14fe4fa940fbc2bc235e0cf74"><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="#ga06f896e14fe4fa940fbc2bc235e0cf74">H5Oget_info2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *oinfo, unsigned fields)</td></tr>
<tr class="memdesc:ga06f896e14fe4fa940fbc2bc235e0cf74"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object specified by an identifier. <br /></td></tr>
<tr class="separator:ga06f896e14fe4fa940fbc2bc235e0cf74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0090da86c086c1c63a5acfaed39a035e" id="r_ga0090da86c086c1c63a5acfaed39a035e"><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="#ga0090da86c086c1c63a5acfaed39a035e">H5Oget_info_by_name2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga0090da86c086c1c63a5acfaed39a035e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by location and relative name. <br /></td></tr>
<tr class="separator:ga0090da86c086c1c63a5acfaed39a035e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85e15e65922874111da1a5efd5dd7bed" id="r_ga85e15e65922874111da1a5efd5dd7bed"><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="#ga85e15e65922874111da1a5efd5dd7bed">H5Oget_info_by_idx2</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_o__info1__t.html">H5O_info1_t</a> *oinfo, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga85e15e65922874111da1a5efd5dd7bed"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata for an object, identifying the object by an index position. <br /></td></tr>
<tr class="separator:ga85e15e65922874111da1a5efd5dd7bed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6efdb2a0a9fe9fe46695cc0f7bd993e7" id="r_ga6efdb2a0a9fe9fe46695cc0f7bd993e7"><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="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7">H5Ovisit1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <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="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a> op, void *op_data)</td></tr>
<tr class="memdesc:ga6efdb2a0a9fe9fe46695cc0f7bd993e7"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects accessible from a specified object. <br /></td></tr>
<tr class="separator:ga6efdb2a0a9fe9fe46695cc0f7bd993e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaffacf3bd66f4fe074099eae1c80914f2" id="r_gaffacf3bd66f4fe074099eae1c80914f2"><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="#gaffacf3bd66f4fe074099eae1c80914f2">H5Ovisit_by_name1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_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="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a> op, void *op_data, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gaffacf3bd66f4fe074099eae1c80914f2"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects starting from a specified object. <br /></td></tr>
<tr class="separator:gaffacf3bd66f4fe074099eae1c80914f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa4ab542f581f4fc9a4eaa95debb29c9e" id="r_gaa4ab542f581f4fc9a4eaa95debb29c9e"><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="#gaa4ab542f581f4fc9a4eaa95debb29c9e">H5Ovisit2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <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="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a> op, void *op_data, unsigned fields)</td></tr>
<tr class="memdesc:gaa4ab542f581f4fc9a4eaa95debb29c9e"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects accessible from a specified object. <br /></td></tr>
<tr class="separator:gaa4ab542f581f4fc9a4eaa95debb29c9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c155caf5499405fe403e1eb27b5beb6" id="r_ga9c155caf5499405fe403e1eb27b5beb6"><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="#ga9c155caf5499405fe403e1eb27b5beb6">H5Ovisit_by_name2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *obj_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="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a> op, void *op_data, unsigned fields, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga9c155caf5499405fe403e1eb27b5beb6"><td class="mdescLeft"> </td><td class="mdescRight">Recursively visits all objects starting from a specified object. <br /></td></tr>
<tr class="separator:ga9c155caf5499405fe403e1eb27b5beb6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gaf4f302a33faba9e1c2b5f64c62ca4ed5" name="gaf4f302a33faba9e1c2b5f64c62ca4ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">◆ </a></span>H5Oget_info</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Oget_info   <a class="el" href="#gaf0fbf7d780a1eefce920facadb198013">H5Oget_info3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> is a macro that is mapped to either <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> or <a class="el" href="#ga06f896e14fe4fa940fbc2bc235e0cf74" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info2()</a> or <a class="el" href="#gaf0fbf7d780a1eefce920facadb198013" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info3()</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="gafe764884e1530f86079288dd5895a7bd" name="gafe764884e1530f86079288dd5895a7bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe764884e1530f86079288dd5895a7bd">◆ </a></span>H5Oget_info_by_idx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Oget_info_by_idx   <a class="el" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb">H5Oget_info_by_idx3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx()</a> is a macro that is mapped to either <a class="el" href="#ga7208d2cf198dcfc875603323841bffae" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx1()</a> or <a class="el" href="#ga85e15e65922874111da1a5efd5dd7bed" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx2()</a> or <a class="el" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx3()</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="ga16d8ac07f9244cfccb42b5f309ca6b3c" name="ga16d8ac07f9244cfccb42b5f309ca6b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">◆ </a></span>H5Oget_info_by_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Oget_info_by_name   <a class="el" href="#gabb69c962999e027cef0079bbb1282199">H5Oget_info_by_name3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name()</a> is a macro that is mapped to either <a class="el" href="#ga96ce408ffda805210844246904da2842" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name1()</a> or <a class="el" href="#ga0090da86c086c1c63a5acfaed39a035e" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name2()</a> or <a class="el" href="#gabb69c962999e027cef0079bbb1282199" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name3()</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="ga5ce86255fcc34ceaf84a62551cd24233" name="ga5ce86255fcc34ceaf84a62551cd24233"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5ce86255fcc34ceaf84a62551cd24233">◆ </a></span>H5Ovisit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Ovisit   <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a">H5Ovisit3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit()</a> is a macro that is mapped to either <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a> or <a class="el" href="#gaa4ab542f581f4fc9a4eaa95debb29c9e" title="Recursively visits all objects accessible from a specified object.">H5Ovisit2()</a> or <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</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="gab02a69e88b11404e7fd61f55344b186c" name="gab02a69e88b11404e7fd61f55344b186c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab02a69e88b11404e7fd61f55344b186c">◆ </a></span>H5Ovisit_by_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Ovisit_by_name   <a class="el" href="#ga34815400b01df59c4dac19436124885a">H5Ovisit_by_name3</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name()</a> is a macro that is mapped to either <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a> or <a class="el" href="#ga9c155caf5499405fe403e1eb27b5beb6" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name2()</a> or <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</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="gab2fa388aadd1ff154ee150cbb4884c1c" name="gab2fa388aadd1ff154ee150cbb4884c1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2fa388aadd1ff154ee150cbb4884c1c">◆ </a></span>H5Oare_mdc_flushes_disabled()</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> H5Oare_mdc_flushes_disabled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *</td> <td class="paramname"><span class="paramname"><em>are_disabled</em></span> )</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">object_id</td><td>Identifier of an object in the cache; may be a group, named datatype, or dataset identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">are_disabled</td><td>Flushes enabled/disabled</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>are_disabled</code> will be set to <code>1</code> if an object has had flushes disabled and <code>0</code> if it has not had flushes disabled. </dd>
<dd>
Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gab2fa388aadd1ff154ee150cbb4884c1c" title="Retrieves comment for specified object.">H5Oare_mdc_flushes_disabled()</a> determines if an HDF5 object (dataset, group, committed datatype) has had flushes of metadata entries disabled.</p>
<p>The <a class="el" href="#ga21014920bdabf6973e233796d7174156" title="Enables flushing of dirty metadata entries from a file's metadata cache.">H5Oenable_mdc_flushes()</a>, <a class="el" href="#ga0908be309da1fb4f771c1e264fac22ae" title="Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage.">H5Odisable_mdc_flushes()</a> and associated flush functions can be used to control the flushing of entries from a file's metadata cache. Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level.</p>
<dl class="section note"><dt>Note</dt><dd>HDF5 objects include datasets, groups, and committed datatypes. Only <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifiers that represent these objects can be passed to the function. </dd>
<dd>
Passing in a <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifier that represents any other HDF5 entity is considered an error. </dd>
<dd>
It is an error to pass an HDF5 file identifier (obtained from <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> or <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a>) to this function.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga545ad7c54987013ebd50b40fe9e73c61" name="ga545ad7c54987013ebd50b40fe9e73c61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga545ad7c54987013ebd50b40fe9e73c61">◆ </a></span>H5Oclose()</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> H5Oclose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes an object in an HDF5 file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Object 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="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> closes the group, dataset, or named datatype specified by object_id.</p>
<p>This function is the companion to <a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a>, and has the same effect as calling <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a>, <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a>, or <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a>.</p>
<p><a class="el" href="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> is not used to close a dataspace, attribute, property list, or file.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.8 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaa94449be6f67f499be5ddd3fc44f4225" name="gaa94449be6f67f499be5ddd3fc44f4225"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa94449be6f67f499be5ddd3fc44f4225">◆ </a></span>H5Ocopy()</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> H5Ocopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>src_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dst_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dst_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>ocpypl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies an object in 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>Object identifier indicating the location of the source object to be copied </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_name</td><td>Name of the source object to be copied </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_loc_id</td><td>Location identifier specifying the destination </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_name</td><td>Name to be assigned to the new copy </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ocpypl_id</td><td>Object copy property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation 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="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> copies the group, dataset or committed datatype specified by <code>src_name</code> from the file or group specified by <code>src_loc_id</code> to the destination location <code>dst_loc_id</code>.</p>
<p>The destination location, as specified in dst_loc_id, may be a group in the current file or a location in a different file. If dst_loc_id is a file identifier, the copy will be placed in that file's root group.</p>
<p>The copy will be created with the path specified in <code>dst_name</code>, which must not pre-exist in the destination location. If <code>dst_name</code> already exists at the location <code>dst_loc_id</code>, <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> will fail. If <code>dst_name</code> is an absolute path, the copy will be created relative to the file's root group.</p>
<p>The copy of the object is created with the property lists specified by <code>ocpypl_id</code> and <code>lcpl_id</code>. <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a> can be passed in for these property lists. The default behavior:</p>
<ul>
<li>of the link creation property list is to NOT create intermediate groups.</li>
<li>of the flags specified by the object creation property list is described in <a class="el" href="group___o_c_p_y_p_l.html#ga8819261e0b4663827212892e10dfc8a6" title="Sets properties to be used when an object is copied.">H5Pset_copy_object()</a>.</li>
</ul>
<p>These property lists or flags can be modified to govern the behavior of <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> as follows:</p>
<ul>
<li>A flag controlling the creation of intermediate groups that may not yet exist is set in the link creation property list <code>lcpl_id</code> with <a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group()</a>.</li>
<li>Copying of committed datatypes can be tuned through the use of <a class="el" href="group___o_c_p_y_p_l.html#ga8819261e0b4663827212892e10dfc8a6" title="Sets properties to be used when an object is copied.">H5Pset_copy_object()</a>, <a class="el" href="group___o_c_p_y_p_l.html#gab89c9debe50afca848151ff046afc82f" title="Adds a path to the list of paths that will be searched in the destination file for a matching committ...">H5Padd_merge_committed_dtype_path()</a>, <a class="el" href="group___o_c_p_y_p_l.html#ga9e0448885990a1b9ebd4493b7604f0c1" title="Sets the callback function that H5Ocopy() will invoke before searching the entire destination file fo...">H5Pset_mcdt_search_cb()</a>, and related functions.</li>
<li>Flags controlling other aspects of object copying are set in the object copy property list <code>ocpypl_id</code> with <a class="el" href="group___o_c_p_y_p_l.html#ga8819261e0b4663827212892e10dfc8a6" title="Sets properties to be used when an object is copied.">H5Pset_copy_object()</a>.</li>
</ul>
<p><a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> will always try to make a copy of the object specified in <code>src_name</code>.</p>
<ul>
<li>If the object specified by <code>src_name</code> is a group containing a soft or external link, the default is that the new copy will contain a soft or external link with the same value as the original. See <a class="el" href="group___o_c_p_y_p_l.html#ga8819261e0b4663827212892e10dfc8a6" title="Sets properties to be used when an object is copied.">H5Pset_copy_object()</a> for optional settings.</li>
<li>If the path specified in <code>src_name</code> is or contains a soft link or an external link, <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> will copy the target object. Use <a class="el" href="group___h5_l.html#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a> if the intent is to create a new soft or external link with the same value as the original link.</li>
</ul>
<p><a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a> can be used to copy an object in an HDF5 file. If an object has been changed since it was opened, it should be written back to the file before using <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a>. The object can be written back either by closing the object (<a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a>, <a class="el" href="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a>, <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a>, or <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a>) or by flushing the HDF5 file (<a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124" title="Flushes all buffers associated with a file to storage.">H5Fflush()</a>).</p>
<dl class="section user"><dt>See Also:</dt><dd><ul>
<li>Functions to modify the behavior of <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a>:<ul>
<li><a class="el" href="group___o_c_p_y_p_l.html#gab89c9debe50afca848151ff046afc82f" title="Adds a path to the list of paths that will be searched in the destination file for a matching committ...">H5Padd_merge_committed_dtype_path()</a></li>
<li><a class="el" href="group___o_c_p_y_p_l.html#ga8819261e0b4663827212892e10dfc8a6" title="Sets properties to be used when an object is copied.">H5Pset_copy_object()</a></li>
<li><a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group()</a></li>
<li><a class="el" href="group___o_c_p_y_p_l.html#ga9e0448885990a1b9ebd4493b7604f0c1" title="Sets the callback function that H5Ocopy() will invoke before searching the entire destination file fo...">H5Pset_mcdt_search_cb()</a></li>
</ul>
</li>
<li>Copying Committed Datatypes with <a class="el" href="#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy</a> - A comprehensive discussion of copying committed datatypes (PDF) in Advanced Topics in HDF5</li>
</ul>
</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.9 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga60c20da5e244c28a653d4fa23d316b44" name="ga60c20da5e244c28a653d4fa23d316b44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60c20da5e244c28a653d4fa23d316b44">◆ </a></span>H5Odecr_refcount()</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> H5Odecr_refcount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decrements an object reference count. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.</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="#ga60c20da5e244c28a653d4fa23d316b44" title="Decrements an object reference count.">H5Odecr_refcount()</a> decrements the hard link reference count for an object. It should be used any time a user-defined link that references an object by address is deleted. In general, <a class="el" href="#ga2086bad6c3cd2a711c306a48c093ff55" title="Increments an object reference count.">H5Oincr_refcount()</a> will have been used previously, when the link was created.</p>
<p>An object's reference count is the number of hard links in the file that point to that object. See the “Programming Model” section of the HDF5 Groups chapter in the <em><a class="el" href="_u_g.html">HDF5 User Guide</a></em> for a more complete discussion of reference counts.</p>
<p>If a user application needs to determine an object's reference count, an <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> call is required; the reference count is returned in the <code>rc</code> field of the <a class="el" href="_h5version_8h.html#a5f76b0cdd6d68d61f11e46d4f06e50d4">H5O_info_t</a> <code>struct</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>This function must be used with care! </dd>
<dd>
Improper use can lead to inaccessible data, wasted space in the file, or <b><em>file corruption</em></b>.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0908be309da1fb4f771c1e264fac22ae" name="ga0908be309da1fb4f771c1e264fac22ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0908be309da1fb4f771c1e264fac22ae">◆ </a></span>H5Odisable_mdc_flushes()</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> H5Odisable_mdc_flushes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Identifier of the object that will have flushes disabled; may be a group, named datatype, or dataset 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="#ga0908be309da1fb4f771c1e264fac22ae" title="Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage.">H5Odisable_mdc_flushes()</a>, <a class="el" href="#ga21014920bdabf6973e233796d7174156" title="Enables flushing of dirty metadata entries from a file's metadata cache.">H5Oenable_mdc_flushes()</a> and associated flush functions can be used to control the flushing of entries from a file's metadata cache.</p>
<p>This function prevents an object's or cache's dirty metadata entries from being flushed from the cache by the usual cache eviction/flush policy. Instead, users must manually flush the cache or entries for individual objects via the appropriate <a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124" title="Flushes all buffers associated with a file to storage.">H5Fflush()</a>, <a class="el" href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7" title="Flushes all buffers associated with a dataset to disk.">H5Dflush()</a>, <a class="el" href="group___h5_g.html#ga1d55dbf931f8003bb329c4340b8fe4d6" title="Flushes all buffers associated with a group to disk.">H5Gflush()</a>, <a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a>, and <a class="el" href="#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a> calls.</p>
<p>Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level.</p>
<dl class="section note"><dt>Note</dt><dd>HDF5 objects include datasets, groups, and committed datatypes. Only <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifiers that represent these objects can be passed to the function. Passing in a <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifier that represents any other HDF5 entity is considered an error. It is an error to pass an HDF5 file identifier (obtained from <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> or <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a>) to this function. Misuse of this function can cause the cache to exhaust available memory. Objects can be returned to the default automatic flush behavior with <a class="el" href="#ga21014920bdabf6973e233796d7174156" title="Enables flushing of dirty metadata entries from a file's metadata cache.">H5Oenable_mdc_flushes()</a>. Flush prevention only pertains to new or dirty metadata entries. Clean entries can be evicted from the cache. Calling this function on an object that has already had flushes disabled will return an error.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga21014920bdabf6973e233796d7174156" name="ga21014920bdabf6973e233796d7174156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21014920bdabf6973e233796d7174156">◆ </a></span>H5Oenable_mdc_flushes()</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> H5Oenable_mdc_flushes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables flushing of dirty metadata entries from a file's metadata cache. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Identifier of the object that will have flushes re-enabled; may be a group, named datatype, or dataset 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="#ga21014920bdabf6973e233796d7174156" title="Enables flushing of dirty metadata entries from a file's metadata cache.">H5Oenable_mdc_flushes()</a>, <a class="el" href="#ga0908be309da1fb4f771c1e264fac22ae" title="Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage.">H5Odisable_mdc_flushes()</a> and associated flush functions can be used to control the flushing of entries from a file's metadata cache.</p>
<p>This function allows an object or cache's dirty metadata entries to be flushed from the cache by the usual cache eviction/flush policy.</p>
<p>Metadata cache entries can be controlled at both the individual HDF5 object level (datasets, groups, committed datatypes) and the entire metadata cache level.</p>
<dl class="section note"><dt>Note</dt><dd>HDF5 objects include datasets, groups, and committed datatypes. Only <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifiers that represent these objects can be passed to the function. Passing in a <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> identifier that represents any other HDF5 entity is considered an error. It is an error to pass an HDF5 file identifier (obtained from <a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen()</a> or <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a>) to this function. Using this function on an object that has not had flushes disabled is considered an error. The state of an object can be determined with <a class="el" href="#gab2fa388aadd1ff154ee150cbb4884c1c" title="Retrieves comment for specified object.">H5Oare_mdc_flushes_disabled()</a>. An object will be returned to the default flush algorithm when it is closed. All objects will be returned to the default flush algorithm when the file is closed. An object's entries will not necessarily be flushed as a result of calling this function.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="gab0fef18d97844c4f83d412c5a22def7b" name="gab0fef18d97844c4f83d412c5a22def7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0fef18d97844c4f83d412c5a22def7b">◆ </a></span>H5Oexists_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Oexists_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether a link resolves to an actual 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 of object. 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>The name of the link to check </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 positive value if the object pointed to by the <code>loc_id</code> and <code>name</code> combination exists. </dd>
<dd>
Returns 0 if the object pointed to by the <code>loc_id</code> and <code>name</code> combination does not exist. </dd>
<dd>
Returns a negative value when the function fails.</dd></dl>
<p><a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> allows an application to determine whether the link <code>name</code> in the group or file specified with <code>loc_id</code> resolves to an HDF5 object to open or if the link dangles. The link may be of any type, but hard links will always resolve to objects and do not need to be verified.</p>
<p>Note that <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> verifies only that the target object exists. If <code>name</code> includes either a relative path or an absolute path to the target link, intermediate steps along the path must be verified before the existence of the target link can be safely checked. If the path is not verified and an intermediate element of the path does not exist, <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> will fail. The example in the next paragraph illustrates one step-by-step method for verifying the existence of a link with a relative or absolute path.</p>
<dl class="section user"><dt>Example</dt><dd>Use the following steps to verify the existence of the link <code>datasetD</code> in the <code>group</code> group1/group2/softlink_to_group3/, where <code>group1</code> is a member of the group specified by <code>loc_id:</code> </dd></dl>
<dl class="section user"><dt></dt><dd><ul>
<li>First, use <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> to verify that a link named <code>group1</code> exists.</li>
<li>If <code>group1</code> exists, use <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> to verify that the link <code>group1</code> resolves to an object.</li>
<li>If <code>group1</code> exists, use <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> again, this time with the name set to <code>group1/group2</code>, to verify that the link <code>group2</code> exists in <code>group1</code>.</li>
<li>If the <code>group2</code> link exists, use <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> to verify that <code>group1/group2</code> resolves to an object.</li>
<li>If <code>group2</code> exists, use <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> again, this time with the name set to <code>group1/group2/softlink_to_group3</code>, to verify that the link <code>softlink_to_group3</code> exists in <code>group2</code>.</li>
<li>If the <code>softlink_to_group3</code> link exists, use <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> to verify that <code>group1/group2/softlink_to_group3</code> resolves to an object.</li>
<li>If <code>softlink_to_group3</code> exists, you can now safely use H5Lexists with the name set to <code>group1/group2/softlink_to_group3/datasetD</code> to verify that the target link, <code>datasetD</code>, exists.</li>
<li>And finally, if the link <code>datasetD</code> exists, use H5Oexists_by_name to verify that <code>group1/group2/softlink_to_group3/datasetD</code> resolves to an object.</li>
</ul>
</dd></dl>
<dl class="section user"><dt></dt><dd>If the link to be verified is specified with an absolute path, the same approach should be used, but starting with the first link in the file's root group. For instance, if <code>datasetD</code> were in <code>/group1/group2/softlink_to_group3</code>, the first call to <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> would have name set to <code>/group1</code>.</dd></dl>
<dl class="section user"><dt></dt><dd>Note that this is an outline and does not include all the necessary details. Depending on circumstances, for example, an application may need to verify the type of an object also.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd><b>Failure Modes:</b> </dd>
<dd>
If <code>loc_id</code> and <code>name</code> both exist, but the combination does not resolve to an object, the function will return 0 (zero); the function does not fail in this case. </dd>
<dd>
If either the location or the link specified by the <code>loc_id</code> and <code>name</code> combination does not exist, the function will fail, returning a negative value. </dd>
<dd>
Note that verifying the existence of an object within an HDF5 file is a multistep process. An application can be certain the object does not exist only if <a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> and <a class="el" href="#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name()</a> have been used to verify the existence of the links and groups in the hierarchy above that object. The example above, in the function description, provides a step-by-step description of that verification process.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.5 </dd></dl>
</div>
</div>
<a id="gad99f35048cba4534b6393214684f090f" name="gad99f35048cba4534b6393214684f090f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad99f35048cba4534b6393214684f090f">◆ </a></span>H5Oflush()</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> H5Oflush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flushes all buffers associated with an HDF5 object to disk. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.</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="#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a> causes all buffers associated with an object to be immediately flushed to disk without removing the data from the cache.</p>
<p>The object associated with <code>object_id</code> can be any named object in an HDF5 file, including a dataset, a group, or a committed datatype.</p>
<dl class="section warning"><dt>Warning</dt><dd>H5Oflush doesn't work correctly with parallel. It causes an assertion failure in metadata cache during <a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose()</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>HDF5 does not possess full control over buffering. <a class="el" href="#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a> 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 disk.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7" title="Flushes all buffers associated with a dataset to disk.">H5Dflush()</a>, <a class="el" href="group___h5_d.html#ga3c1ea7e5db3f62d9cf03dd62d1fb08da" title="Refreshes all buffers associated with a dataset.">H5Drefresh()</a>, <a class="el" href="#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a>, <a class="el" href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840" title="Refreshes all buffers associated with a group.">H5Grefresh()</a>, <a class="el" href="#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush()</a>, <a class="el" href="#gaf0318b68be9ab23a92b8a6bee0af9e2f" title="Refreshes all buffers associated with an HDF5 object.">H5Orefresh()</a>, <a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush()</a>, <a class="el" href="group___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d" title="Refreshes all buffers associated with a committed datatype.">H5Trefresh()</a> </dd>
<dd>
<a class="el" href="group___h5_d_o.html#ga316caac160af15192e0c78228667341e" title="Appends data to a dataset along a specified dimension.">H5DOappend()</a>, <a class="el" href="group___s_w_m_r.html#ga159be34fbe7e4a959589310ef0196dfe" title="Retrieves free-space section information for a file.">H5Fstart_swmr_write()</a>, <a class="el" href="group___d_a_p_l.html#gacd6803640eebd20e408c330192b09fa6" title="Retrieves the values of the append property that is set up in the dataset access property list.">H5Pget_append_flush()</a>, <a class="el" href="group___f_a_p_l.html#gadb66d434fd8d2f600213b0eec539564e" title="Retrieves the object flush property values from the file access property list.">H5Pget_object_flush_cb()</a>, <a class="el" href="group___d_a_p_l.html#ga2f685a7b3f3a4fa35ddcd1659ab4a835" title="Sets two actions to perform when the size of a dataset's dimension being appended reaches a specified...">H5Pset_append_flush()</a>, <a class="el" href="group___f_a_p_l.html#gab4a4a788af5b6e88381dda0df2efbf19" title="Sets a callback function to invoke when an object flush occurs in the file.">H5Pset_object_flush_cb()</a> </dd>
<dd>
<a class="el" href="#gab2fa388aadd1ff154ee150cbb4884c1c" title="Retrieves comment for specified object.">H5Oare_mdc_flushes_disabled()</a>, <a class="el" href="#ga0908be309da1fb4f771c1e264fac22ae" title="Prevents metadata entries for an HDF5 object from being flushed from the metadata cache to storage.">H5Odisable_mdc_flushes()</a>, <a class="el" href="#ga21014920bdabf6973e233796d7174156" title="Enables flushing of dirty metadata entries from a file's metadata cache.">H5Oenable_mdc_flushes()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="gaa1511ce5e2fe01ce7ea58f2f851d694b" name="gaa1511ce5e2fe01ce7ea58f2f851d694b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1511ce5e2fe01ce7ea58f2f851d694b">◆ </a></span>H5Oget_comment()</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> H5Oget_comment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>comment</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>bufsize</em></span> )</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">obj_id</td><td>Location identifier of object. 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">comment</td><td>The comment </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Anticipated required size of the comment buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Upon success, returns the number of characters in the comment, not including the <code>NULL</code> terminator, or zero (<code>0</code>) if the object has no comment. The value returned may be larger than <code>bufsize</code>. Otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gaa1511ce5e2fe01ce7ea58f2f851d694b" title="Retrieves comment for specified object.">H5Oget_comment()</a> retrieves the comment for the specified object in the buffer <code>comment</code>.</p>
<p>The target object is specified by an identifier, <code>object_id</code>.</p>
<p>The size in bytes of the buffer <code>comment</code>, including the <code>NULL</code> terminator, is specified in <code>bufsize</code>. If <code>bufsize</code> is unknown, a preliminary <a class="el" href="#gaa1511ce5e2fe01ce7ea58f2f851d694b" title="Retrieves comment for specified object.">H5Oget_comment()</a> call with the pointer <code>comment</code> set to <code>NULL</code> will return the size of the comment <em>without</em> the <code>NULL</code> terminator.</p>
<p>If <code>bufsize</code> is set to a smaller value than described above, only <code>bufsize</code> bytes of the comment, without a <code>NULL</code> terminator, are returned in <code>comment</code>.</p>
<p>If an object does not have a comment, an empty string is returned in <code>comment</code>.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gae6d92d597c5a292d342a1bda91e41171" name="gae6d92d597c5a292d342a1bda91e41171"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6d92d597c5a292d342a1bda91e41171">◆ </a></span>H5Oget_comment_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Oget_comment_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>comment</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>bufsize</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</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 of object. 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 object whose comment is to be retrieved </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">comment</td><td>The comment </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Anticipated required size of the <code>comment</code> buffer </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>Upon success, returns the number of characters in the comment, not including the <code>NULL</code> terminator, or zero (<code>0</code>) if the object has no comment. The value returned may be larger than <code>bufsize</code>. Otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gae6d92d597c5a292d342a1bda91e41171" title="Retrieves comment for specified object.">H5Oget_comment_by_name()</a> retrieves the comment for an object in the buffer <code>comment</code>.</p>
<p>The target object is specified by <code>loc_id</code> and <code>name</code>. <code>loc_id</code> can specify any object in the file. <code>name</code> 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>The size in bytes of the comment, including the <code>NULL</code> terminator, is specified in <code>bufsize</code>. If <code>bufsize</code> is unknown, a preliminary <a class="el" href="#gae6d92d597c5a292d342a1bda91e41171" title="Retrieves comment for specified object.">H5Oget_comment_by_name()</a> call with the pointer <code>comment</code> set to <code>NULL</code> will return the size of the comment <em>without</em> the <code>NULL</code> terminator.</p>
<p>If <code>bufsize</code> is set to a smaller value than described above, only <code>bufsize</code> bytes of the comment, without a <code>NULL</code> terminator, are returned in <code>comment</code>.</p>
<p>If an object does not have a comment, an empty string is returned in <code>comment</code>.</p>
<p><code>lapl_id</code> contains a link access property list identifier. A link access property list can come into play when traversing links to access an object.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaf3751684a6706e3ba49b863406011f80" name="gaf3751684a6706e3ba49b863406011f80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3751684a6706e3ba49b863406011f80">◆ </a></span>H5Oget_info1()</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> H5Oget_info1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object specified by an 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 of object. 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">oinfo</td><td>Buffer in which to return object information</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#_deprecated000058">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#gaf0fbf7d780a1eefce920facadb198013" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info3()</a> or the macro <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a>.</dd></dl>
<p><a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> specifies an object by its identifier, <code>loc_id</code> , and retrieves the metadata describing that object in <code>oinfo</code>.</p>
<dl class="section note"><dt>Note</dt><dd>If you are iterating through a lot of different objects to retrieve information via the <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> family of routines, you may see memory building up. This can be due to memory allocation for metadata, such as object headers and messages, when the iterated objects are put into the metadata cache. </dd>
<dd>
If the memory buildup is not desirable, you can configure a smaller cache via <a class="el" href="group___m_d_c.html#ga81bc06be69131484eb04d01511b9c8f8" title="Attempts to configure metadata cache of target file.">H5Fset_mdc_config()</a> or set the file access property list via <a class="el" href="group___f_a_p_l.html#gaf234199ad4cf9c708f45893f7f9cd4d3" title="Set the initial metadata cache configuration in the indicated File Access Property List to the suppli...">H5Pset_mdc_config()</a>. A smaller sized cache will force metadata entries to be evicted from the cache, thus freeing the memory associated with the entries.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.10.5 The macro <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a> was removed and the function <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> was copied to <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a>. </dd>
<dd>
1.10.3 Function <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> was copied to <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a>, and the macro <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info</a> was created. </dd>
<dd>
1.8.15 Added a note about the valid values for the <code>version</code> field in the <a class="el" href="struct_h5_o__hdr__info__t.html">H5O_hdr_info_t</a> structure. </dd>
<dd>
1.8.11 Fortran subroutine introduced in this release. </dd>
<dd>
1.8.10 Added <a class="el" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> structure to the Description section. <br />
Separated <a class="el" href="struct_h5_o__hdr__info__t.html">H5O_hdr_info_t</a> structure from <a class="el" href="_h5version_8h.html#a5f76b0cdd6d68d61f11e46d4f06e50d4">H5O_info_t</a> in the Description section. <br />
Clarified the definition and implementation of the time fields.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga06f896e14fe4fa940fbc2bc235e0cf74" name="ga06f896e14fe4fa940fbc2bc235e0cf74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga06f896e14fe4fa940fbc2bc235e0cf74">◆ </a></span>H5Oget_info2()</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> H5Oget_info2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object specified by an 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 of object. 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">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000061">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#gaf0fbf7d780a1eefce920facadb198013" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info3()</a> or the macro <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a>.</dd></dl>
<p><a class="el" href="#ga06f896e14fe4fa940fbc2bc235e0cf74" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info2()</a> specifies an object by its identifier, <code>loc_id</code> , and retrieves the metadata describing that object in <code>oinfo</code> , an <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code>. This <code>struct</code> type is described in <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a>.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file:</p>
<table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd>If you are iterating through a lot of different objects to retrieve information via the <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> family of routines, you may see memory building up. This can be due to memory allocation for metadata, such as object headers and messages, when the iterated objects are put into the metadata cache. </dd>
<dd>
If the memory buildup is not desirable, you can configure a smaller cache via <a class="el" href="group___m_d_c.html#ga81bc06be69131484eb04d01511b9c8f8" title="Attempts to configure metadata cache of target file.">H5Fset_mdc_config()</a> or set the file access property list via <a class="el" href="group___f_a_p_l.html#gaf234199ad4cf9c708f45893f7f9cd4d3" title="Set the initial metadata cache configuration in the indicated File Access Property List to the suppli...">H5Pset_mdc_config()</a>. A smaller sized cache will force metadata entries to be evicted from the cache, thus freeing the memory associated with the entries.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.3 </dd></dl>
</div>
</div>
<a id="gaf0fbf7d780a1eefce920facadb198013" name="gaf0fbf7d780a1eefce920facadb198013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0fbf7d780a1eefce920facadb198013">◆ </a></span>H5Oget_info3()</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> H5Oget_info3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object specified by an 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 of object. 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">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaf0fbf7d780a1eefce920facadb198013" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info3()</a> specifies an object by its identifier, <code>loc_id</code> , and retrieves the metadata describing that object in <code>oinfo</code>.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file:</p>
<table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<dl class="section user"><dt>Example</dt><dd>An example snippet from examples/h5_attribute.c: </dd></dl>
<dl class="section user"><dt></dt><dd><div class="fragment"><div class="line"> </div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Find string attribute by iterating through all attributes</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = <a class="code hl_function" href="#gaf0fbf7d780a1eefce920facadb198013">H5Oget_info3</a>(dataset, &oinfo, <a class="code hl_define" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a>);</div>
<div class="line"> <span class="keywordflow">for</span> (i = 0; i < (unsigned)oinfo.<a class="code hl_variable" href="struct_h5_o__info2__t.html#abc37a3659a46ce6096446cfd0d9f67ff">num_attrs</a>; i++) {</div>
<div class="line"> attr = <a class="code hl_function" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d">H5Aopen_by_idx</a>(dataset, <span class="stringliteral">"."</span>, <a class="code hl_enumvalue" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a315475479b34056043b4b6583bafb280">H5_INDEX_CRT_ORDER</a>, <a class="code hl_enumvalue" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, (<a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>)i, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>,</div>
<div class="line"> <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> atype = <a class="code hl_function" href="group___h5_a.html#ga0b070b714b2e535df2e1cb3005026a44">H5Aget_type</a>(attr);</div>
<div class="line"> type_class = <a class="code hl_function" href="group___h5_t.html#ga364545c053f925fec65880b235e37898">H5Tget_class</a>(atype);</div>
<div class="line"> <span class="keywordflow">if</span> (type_class == <a class="code hl_enumvalue" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a2de5d7919fe54466b7cf6a6c0b4265fa">H5T_STRING</a>) {</div>
<div class="line"> atype_mem = <a class="code hl_function" href="group___h5_t.html#ga05b99133058637e8daa5d745381ddd3d">H5Tget_native_type</a>(atype, <a class="code hl_enumvalue" href="_h5_tpublic_8h.html#a891787104495ea80c677ab7042bfc33da0c49a07f752898162207bb2767b20cc6">H5T_DIR_ASCEND</a>);</div>
<div class="line"> ret = <a class="code hl_function" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c">H5Aread</a>(attr, atype_mem, string_out);</div>
<div class="line"> printf(<span class="stringliteral">"Found string attribute; its index is %d , value = %s \n"</span>, i, string_out);</div>
<div class="line"> ret = <a class="code hl_function" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">H5Tclose</a>(atype_mem);</div>
<div class="line"> }</div>
<div class="line"> ret = <a class="code hl_function" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda">H5Aclose</a>(attr);</div>
<div class="line"> ret = <a class="code hl_function" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0">H5Tclose</a>(atype);</div>
<div class="line"> }</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section note"><dt>Note</dt><dd>If you are iterating through a lot of different objects to retrieve information via the <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> family of routines, you may see memory building up. This can be due to memory allocation for metadata, such as object headers and messages, when the iterated objects are put into the metadata cache. </dd>
<dd>
If the memory buildup is not desirable, you can configure a smaller cache via <a class="el" href="group___m_d_c.html#ga81bc06be69131484eb04d01511b9c8f8" title="Attempts to configure metadata cache of target file.">H5Fset_mdc_config()</a> or set the file access property list via <a class="el" href="group___f_a_p_l.html#gaf234199ad4cf9c708f45893f7f9cd4d3" title="Set the initial metadata cache configuration in the indicated File Access Property List to the suppli...">H5Pset_mdc_config()</a>. A smaller sized cache will force metadata entries to be evicted from the cache, thus freeing the memory associated with the entries.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga7208d2cf198dcfc875603323841bffae" name="ga7208d2cf198dcfc875603323841bffae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7208d2cf198dcfc875603323841bffae">◆ </a></span>H5Oget_info_by_idx1()</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> H5Oget_info_by_idx1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></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"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by an index position. </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 of object. 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 group in which object is located </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Position within the index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000060">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx3()</a> or the macro <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx()</a>.</dd></dl>
<p><a class="el" href="#ga7208d2cf198dcfc875603323841bffae" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx1()</a> retrieves the metadata describing an object in the <code>struct</code> <code>oinfo</code>, as specified by the location, <code>loc_id</code>, group name, <code>group_name</code>, the index by which objects in that group are tracked, <code>idx_type</code>, the order by which the index is to be traversed, <code>order</code>, and an object's position <code>n</code> within that index.</p>
<p>If <code>loc_id</code> fully specifies the group in which the object resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.5 The macro <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx</a> was removed and the function <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx()</a> was copied to <a class="el" href="#ga7208d2cf198dcfc875603323841bffae" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx1()</a>. </dd>
<dd>
1.10.3 Function <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx()</a> was copied to <a class="el" href="#ga7208d2cf198dcfc875603323841bffae" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx1()</a> and the macro <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx</a> was created. </dd>
<dd>
1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga85e15e65922874111da1a5efd5dd7bed" name="ga85e15e65922874111da1a5efd5dd7bed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85e15e65922874111da1a5efd5dd7bed">◆ </a></span>H5Oget_info_by_idx2()</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> H5Oget_info_by_idx2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></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"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by an index position. </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 of object. 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 group in which object is located </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Position within the index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000063">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function is deprecated in favor of the function <a class="el" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx3()</a> or the macro <a class="el" href="#gafe764884e1530f86079288dd5895a7bd">H5Oget_info_by_idx</a>.</dd></dl>
<p><a class="el" href="#ga85e15e65922874111da1a5efd5dd7bed" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx2()</a> retrieves the metadata describing an object in the <code>struct</code> <code>oinfo</code>, as specified by the location, <code>loc_id</code>, group name, <code>group_name</code>, the index by which objects in that group are tracked, <code>idx_type</code>, the order by which the index is to be traversed, <code>order</code>, and an object's position <code>n</code> within that index.</p>
<p><code>oinfo</code>, in which the object information is returned, is a <code>struct</code> of type <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a>. This and other <code>struct</code> types used by <a class="el" href="#ga85e15e65922874111da1a5efd5dd7bed" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx2()</a> are described in <a class="el" href="#ga7208d2cf198dcfc875603323841bffae" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx1()</a>.</p>
<p>If <code>loc_id</code> fully specifies the group in which the object resides, i<code>group_name</code> can be a dot (<code></code>.).</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.3 </dd></dl>
</div>
</div>
<a id="gafa2f8884f7d3e7fd9b8549f5b59fd9eb" name="gafa2f8884f7d3e7fd9b8549f5b59fd9eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb">◆ </a></span>H5Oget_info_by_idx3()</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> H5Oget_info_by_idx3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></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"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by an index position. </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 of object. 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 group in which object is located </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Position within the index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </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="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb" title="Retrieves the metadata for an object, identifying the object by an index position.">H5Oget_info_by_idx3()</a> retrieves the metadata describing an object in the <code>struct</code> <code>oinfo</code>, as specified by the location, <code>loc_id</code>, group name, <code>group_name</code>, the index by which objects in that group are tracked, <code>idx_type</code>, the order by which the index is to be traversed, <code>order</code>, and an object's position <code>n</code> within that index.</p>
<p>If <code>loc_id</code> fully specifies the group in which the object resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section user"><dt>Example</dt><dd>An example snippet from test/titerate.c: <div class="fragment"><div class="line"> </div>
<div class="line"> ret = <a class="code hl_function" href="#gafa2f8884f7d3e7fd9b8549f5b59fd9eb">H5Oget_info_by_idx3</a>(root_group, <span class="stringliteral">"."</span>, <a class="code hl_enumvalue" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="code hl_enumvalue" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, (<a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a>)i, &oinfo,</div>
<div class="line"> <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> CHECK(ret, FAIL, <span class="stringliteral">"H5Oget_info_by_idx"</span>);</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga96ce408ffda805210844246904da2842" name="ga96ce408ffda805210844246904da2842"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96ce408ffda805210844246904da2842">◆ </a></span>H5Oget_info_by_name1()</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> H5Oget_info_by_name1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by location and relative 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 of object. 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 object, relative to <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000059">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga0090da86c086c1c63a5acfaed39a035e" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name2()</a> or the macro <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name</a>.</dd></dl>
<p><a class="el" href="#ga96ce408ffda805210844246904da2842" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name1()</a> specifies an object's location and name, <code>loc_id</code> and <code>name</code>, respectively, and retrieves the metadata describing that object in <code>oinfo</code>, an <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code>.</p>
<p>The <code>struct</code> <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> is defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> and described in the <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> function entry.</p>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.5 The macro <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name</a> was removed and the function <a class="el" href="#ga96ce408ffda805210844246904da2842" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name1()</a> was copied to <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name()</a>. </dd>
<dd>
1.10.3 Function <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name()</a> was copied to <a class="el" href="#ga96ce408ffda805210844246904da2842" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name1()</a> and the macro <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name</a> was created. </dd>
<dd>
1.8.8 Fortran 2003 subroutine and <code>h5o_info_t</code> derived type introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0090da86c086c1c63a5acfaed39a035e" name="ga0090da86c086c1c63a5acfaed39a035e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0090da86c086c1c63a5acfaed39a035e">◆ </a></span>H5Oget_info_by_name2()</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> H5Oget_info_by_name2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by location and relative 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 of object. 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 object, relative to <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000062">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#gabb69c962999e027cef0079bbb1282199" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name3()</a> or the macro <a class="el" href="#ga16d8ac07f9244cfccb42b5f309ca6b3c">H5Oget_info_by_name()</a>.</dd></dl>
<p><a class="el" href="#ga0090da86c086c1c63a5acfaed39a035e" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name2()</a> specifies an object's location and name, <code>loc_id</code> and <code>name</code>, respectively, and retrieves the metadata describing that object in <code>oinfo</code>, an <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code>.</p>
<p>The <code>struct</code> <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> is defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> and described in the <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> function entry.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file:</p>
<table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.3 </dd></dl>
</div>
</div>
<a id="gabb69c962999e027cef0079bbb1282199" name="gabb69c962999e027cef0079bbb1282199"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabb69c962999e027cef0079bbb1282199">◆ </a></span>H5Oget_info_by_name3()</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> H5Oget_info_by_name3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the metadata for an object, identifying the object by location and relative 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 of object. 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 object, relative to <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to include in <code>oinfo</code> </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="#gabb69c962999e027cef0079bbb1282199" title="Retrieves the metadata for an object, identifying the object by location and relative name.">H5Oget_info_by_name3()</a> specifies an object's location and name, <code>loc_id</code> and <code>name</code>, respectively, and retrieves the metadata describing that object in <code>oinfo</code>, an <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> struct.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be filled in the <a class="el" href="struct_h5_o__info2__t.html">H5O_info2_t</a> <code>struct</code> returned in <code>oinfo</code>. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file:</p>
<table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section user"><dt>Example</dt><dd>An example snippet from test/vol.c: <div class="fragment"><div class="line"> </div>
<div class="line"> <span class="comment">/* H5Oget_info_by_name */</span></div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gabb69c962999e027cef0079bbb1282199">H5Oget_info_by_name3</a>(fid, NATIVE_VOL_TEST_GROUP_NAME, &object_info, <a class="code hl_define" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0)</div>
<div class="line"> TEST_ERROR;</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga677d99ab106e2032b991b75b75de0e46" name="ga677d99ab106e2032b991b75b75de0e46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga677d99ab106e2032b991b75b75de0e46">◆ </a></span>H5Oget_native_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> H5Oget_native_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve native file format 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 of object. 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">oinfo</td><td>Buffer in which to return native object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags to determine which fields in <code>oinfo</code> are filled in</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="#ga677d99ab106e2032b991b75b75de0e46" title="Retrieve native file format information about an object.">H5Oget_native_info()</a> retrieves the native file format information for an object specified by <code>loc_id</code>.</p>
<p>The <code>fields</code> parameter indicates which fields to fill in <a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a>. Possible values defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> are:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_HDR 0x0008u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_META_SIZE 0x0010u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_ALL (H5O_NATIVE_INFO_HDR | H5O_NATIVE_INFO_META_SIZE)</span></div>
</div><!-- fragment --><dl class="section user"><dt>Example</dt><dd>An example snippet from test/tfile.c: </dd></dl>
<dl class="section user"><dt></dt><dd><div class="fragment"><div class="line"> </div>
<div class="line"> ret = <a class="code hl_function" href="#ga677d99ab106e2032b991b75b75de0e46">H5Oget_native_info</a>(group, &ninfo, <a class="code hl_define" href="_h5_opublic_8h.html#a41832cc0fcd1f5063f28e796733761e2">H5O_NATIVE_INFO_HDR</a>);</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gafa6570d8b0ef6e2aff75093e1f99f67e" name="gafa6570d8b0ef6e2aff75093e1f99f67e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa6570d8b0ef6e2aff75093e1f99f67e">◆ </a></span>H5Oget_native_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> H5Oget_native_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"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></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"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve native file format information about an object according to the order of 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 of object. 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 group in which object is located </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Position within the index </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return native object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags to determine which fields in <code>oinfo</code> are filled in </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="#gafa6570d8b0ef6e2aff75093e1f99f67e" title="Retrieve native file format information about an object according to the order of an index.">H5Oget_native_info_by_idx()</a> retrieves the native file format information for an object specified by <code>loc_id</code>, group name, <code>group_name</code>, the index by which objects in the group are tracked, <code>idx_type</code>, the order by which the index is to be traversed, <code>order</code> , and an object's position <code>n</code> within that index.</p>
<p>The <code>fields</code> parameter indicates which fields to fill in <a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a>. Possible values defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> are: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_HDR 0x0008u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_META_SIZE 0x0010u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_ALL (H5O_NATIVE_INFO_HDR | H5O_NATIVE_INFO_META_SIZE)</span></div>
</div><!-- fragment --><p>The link access property list, <code>lapl_id</code>, is not currently used; it should be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga296ded21aeac3921fee07272353b8476" name="ga296ded21aeac3921fee07272353b8476"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga296ded21aeac3921fee07272353b8476">◆ </a></span>H5Oget_native_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> H5Oget_native_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"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a> *</td> <td class="paramname"><span class="paramname"><em>oinfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve native file format information about an object given 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 of object. 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 object </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">oinfo</td><td>Buffer in which to return native object information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags to determine which fields in <code>oinfo</code> are filled in </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="#ga296ded21aeac3921fee07272353b8476" title="Retrieve native file format information about an object given its name.">H5Oget_native_info_by_name()</a> retrieves the native file format information for an object specified by <code>loc_id</code> and the name <code>name</code>.</p>
<p>The <code>fields</code> parameter which fields to fill in <a class="el" href="struct_h5_o__native__info__t.html">H5O_native_info_t</a>. Possible values defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> are:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_HDR 0x0008u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_META_SIZE 0x0010u </span></div>
<div class="line"><span class="preprocessor">#define H5O_NATIVE_INFO_ALL (H5O_NATIVE_INFO_HDR | H5O_NATIVE_INFO_META_SIZE)</span></div>
</div><!-- fragment --><dl class="section user"><dt>Example</dt><dd>An example snippet from test/tfile.c: <div class="fragment"><div class="line"> </div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Make sure the root group still has the correct object header version</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = <a class="code hl_function" href="#ga296ded21aeac3921fee07272353b8476">H5Oget_native_info_by_name</a>(file, <span class="stringliteral">"/"</span>, &ninfo, <a class="code hl_define" href="_h5_opublic_8h.html#a41832cc0fcd1f5063f28e796733761e2">H5O_NATIVE_INFO_HDR</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga2086bad6c3cd2a711c306a48c093ff55" name="ga2086bad6c3cd2a711c306a48c093ff55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2086bad6c3cd2a711c306a48c093ff55">◆ </a></span>H5Oincr_refcount()</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> H5Oincr_refcount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>object_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increments an object reference count. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">object_id</td><td>Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.</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="#ga2086bad6c3cd2a711c306a48c093ff55" title="Increments an object reference count.">H5Oincr_refcount()</a> increments the hard link reference count for an object. It should be used any time a user-defined link that references an object by address is added. When the link is deleted, <a class="el" href="#ga60c20da5e244c28a653d4fa23d316b44" title="Decrements an object reference count.">H5Odecr_refcount()</a> should be used.</p>
<p>An object's reference count is the number of hard links in the file that point to that object. See the “Programming Model” section of the HDF5 Groups chapter in the – <em><a class="el" href="_u_g.html">HDF5 User Guide</a></em> for a complete discussion of reference counts.</p>
<p>If a user application needs to determine an object's reference count, an <a class="el" href="#gaf4f302a33faba9e1c2b5f64c62ca4ed5">H5Oget_info()</a> call is required; the reference count is returned in the <code>rc</code> field of the <a class="el" href="_h5version_8h.html#a5f76b0cdd6d68d61f11e46d4f06e50d4">H5O_info_t</a> <code>struct</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd>This function must be used with care! </dd>
<dd>
Improper use can lead to inaccessible data, wasted space in the file, or <b><em>file corruption</em></b>.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga2c97dd58e64b67d16325fceb7e02113f" name="ga2c97dd58e64b67d16325fceb7e02113f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c97dd58e64b67d16325fceb7e02113f">◆ </a></span>H5Olink()</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> H5Olink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>new_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>new_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a hard link to an object in an HDF5 file. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object to be linked </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_loc_id</td><td>Location identifier at which object is to be linked; may be a file, group, dataset, named datatype or attribute identifier. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">new_name</td><td>Name of link to be created, relative to <code>new_loc_id</code>. </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">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="#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a> creates a new hard link to an object in an HDF5 file. <code>new_loc_id</code> and <code><code>new_link_name</code> specify</code> the location and name of the new link, while <code>object_id</code> identifies the object that the link points to.</p>
<p><a class="el" href="#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink()</a> is designed for two purposes:</p><ul>
<li>To create the first hard link to an object that has just been created with <a class="el" href="group___h5_d.html#ga15a77e82383d821fee8ecbf9ab8408cb" title="Creates a dataset in a file without linking it into the file structure.">H5Dcreate_anon()</a>, <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>, or <a class="el" href="group___h5_t.html#ga510d2e4ab51247ab1a915be701001581" title="Commits a transient datatype to a file, creating a newly named datatype, but does not link it into th...">H5Tcommit_anon()</a>.</li>
<li>To add additional structure to an existing file so that, for example, an object can be shared among multiple groups.</li>
</ul>
<p><code>lcpl</code> and <code>lapl</code> are the link creation and access property lists associated with the new link.</p>
<dl class="section user"><dt>Example:</dt><dd>To create a new link to an object while simultaneously creating missing intermediate groups: Suppose that an application must create the group C with the path /A/B01/C but may not know at run time whether the groups A and B01 exist. The following code ensures that those groups are created if they are missing: </dd></dl>
<dl class="section user"><dt></dt><dd><div class="fragment"><div class="line"><span class="comment">// Creates a link creation property list (LCPL).</span></div>
<div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#ad2c1d10104f0262c826350ccbf7c49f2">H5P_LINK_CREATE</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Sets "create missing intermediate groups" property in that LCPL.</span></div>
<div class="line"><span class="keywordtype">int</span> status = <a class="code hl_function" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c">H5Pset_create_intermediate_group</a>(lcpl_id, <span class="keyword">true</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Creates a group without linking it into the file structure.</span></div>
<div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gid = <a class="code hl_function" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344">H5Gcreate_anon</a>(file_id, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Links group into file structure.</span></div>
<div class="line">status = <a class="code hl_function" href="#ga2c97dd58e64b67d16325fceb7e02113f">H5Olink</a>(gid, file_id, <span class="stringliteral">"/A/B01/C"</span>, lcpl_id, <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>);</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_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="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_o_html_ga2c97dd58e64b67d16325fceb7e02113f"><div class="ttname"><a href="#ga2c97dd58e64b67d16325fceb7e02113f">H5Olink</a></div><div class="ttdeci">herr_t H5Olink(hid_t obj_id, hid_t new_loc_id, const char *new_name, hid_t lcpl_id, hid_t lapl_id)</div><div class="ttdoc">Creates a hard link to an object in an HDF5 file.</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_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 --></dd></dl>
<dl class="section user"><dt></dt><dd>Note that unless the object is intended to be temporary, the H5O_LINK call is mandatory if an object created with one of the H5*_CREATE_ANON functions (or with H5T_COMMIT_ANON) is to be retained in the file; without an H5O_LINK call, the object will not be linked into the HDF5 file structure and will be deleted when the file is closed.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.1 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga9f635f58c7ddf17f87c253bfbca08bc1" name="ga9f635f58c7ddf17f87c253bfbca08bc1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f635f58c7ddf17f87c253bfbca08bc1">◆ </a></span>H5Oopen()</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> H5Oopen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an object in an HDF5 file by location identifier and path 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 of object. 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>Path to the object; relative to <code>loc_id</code> </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 an object identifier if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a> opens a group, dataset, or committed (named) datatype specified by a location, <code>loc_id</code>, and a path name, <code>name</code>, in an HDF5 file.</p>
<p>This function opens the object in the same manner as <a class="el" href="group___h5_g.html#ga3eca6807deff4f9e51fc5fe0befc2245">H5Gopen()</a>, <a class="el" href="group___h5_t.html#ga1d14b407603fdcedfbed1f723784c209">H5Topen()</a>, and <a class="el" href="_h5version_8h.html#a7dba2e5b2045f31c0932123ffb54f7a3">H5Dopen()</a>. However, <a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a> does not require the type of object to be known beforehand. This can be useful with user-defined links, for instance, when only a path may be known.</p>
<p><a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a> cannot be used to open a dataspace, attribute, property list, or file.</p>
<p>Once an object of an unknown type has been opened with <a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a>, the type of that object can be determined by means of an <a class="el" href="group___h5_i.html#ga4941435d4d64de3d7095d2316f415f2d" title="Retrieves the type of an object.">H5Iget_type()</a> call.</p>
<p><code>loc_id</code> may be a file, group, dataset, named datatype, or attribute. If an attribute is specified for <code>loc_id</code> then the object where the attribute is attached will be accessed.</p>
<p><code>name</code> must be the path to that object relative to <code>loc_id</code>.</p>
<p><code>lapl_id</code> is the link access property list associated with the link pointing to the object. If default link access properties are appropriate, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>.</p>
<p>When it is no longer needed, the opened object should be closed with <a class="el" href="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a>, <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a>, <a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose()</a>, or <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a>.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.1 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga137f3823adab4daaaf8fe87b40453fa2" name="ga137f3823adab4daaaf8fe87b40453fa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga137f3823adab4daaaf8fe87b40453fa2">◆ </a></span>H5Oopen_by_addr()</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> H5Oopen_by_addr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a></td> <td class="paramname"><span class="paramname"><em>addr</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an object using its address 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">loc_id</td><td>Location identifier of object. 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">addr</td><td>Object's address in the file</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an object identifier if successful; otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000057">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga2ea3627cf171d0565307702a5e203262" title="Opens an object in an HDF5 file using its VOL independent token.">H5Oopen_by_token()</a>.</dd></dl>
<p><a class="el" href="#ga137f3823adab4daaaf8fe87b40453fa2" title="Opens an object using its address within an HDF5 file.">H5Oopen_by_addr()</a> opens a group, dataset, or committed (named) datatype using its address within an HDF5 file, <code>addr</code>. The resulting opened object is identical to an object opened with <a class="el" href="#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen()</a> and should be closed with <a class="el" href="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> or an object-type-specific closing function (such as <a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose()</a>) when no longer needed.</p>
<p><code>loc_id</code> is a location identifier in the file.</p>
<p>The object's address within the file, <code>addr</code>, is the byte offset of the first byte of the object header from the beginning of the HDF5 file space, i.e., from the beginning of the superblock (see the “HDF5 Storage Model” section of the The HDF5 Data Model and File Structure chapter of the <em>HDF5 User's Guide</em>.)</p>
<p><code>addr</code> can be obtained via either of two function calls. <a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a> returns the object's address in the <code>objno</code> field of the <a class="el" href="struct_h5_g__stat__t.html">H5G_stat_t</a> <code>struct</code>; <a class="el" href="group___h5_l.html#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a> returns the address in the <code>address</code> field of the <a class="el" href="_h5version_8h.html#af542682cfe46de7b0759e52a1608d1e4">H5L_info_t</a> <code>struct</code>.</p>
<p>The address of the HDF5 file on a physical device has no effect on <a class="el" href="#ga137f3823adab4daaaf8fe87b40453fa2" title="Opens an object using its address within an HDF5 file.">H5Oopen_by_addr()</a>, nor does the use of any file driver. As stated above, the object address is its offset within the HDF5 file; HDF5's file drivers will transparently map this to an address on a storage device.</p>
<dl class="section warning"><dt>Warning</dt><dd>This function must be used with care! </dd>
<dd>
Improper use can lead to inaccessible data, wasted space in the file, or <b><em>file corruption</em></b>. </dd>
<dd>
This function is dangerous if called on an invalid address. The risk can be safely overcome by retrieving the object address with <a class="el" href="group___h5_g.html#gad75244979da933ba0b3ad25258850a6b" title="Returns information about an object.">H5Gget_objinfo()</a> or <a class="el" href="group___h5_l.html#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a> immediately before calling <a class="el" href="#ga137f3823adab4daaaf8fe87b40453fa2" title="Opens an object using its address within an HDF5 file.">H5Oopen_by_addr()</a>. The immediacy of the operation can be important; if time has elapsed and the object has been deleted from the file, the address will be invalid, and file corruption can result.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.4 Fortran subroutine added in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaeb66e5cbb3ca79890fc284a0b06762be" name="gaeb66e5cbb3ca79890fc284a0b06762be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb66e5cbb3ca79890fc284a0b06762be">◆ </a></span>H5Oopen_by_idx()</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> H5Oopen_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></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"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the nth object in 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 of object. 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 group, relative to <code>loc_id</code>, in which object is located </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Object to open </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 an object identifier if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gaeb66e5cbb3ca79890fc284a0b06762be" title="Opens the nth object in a group.">H5Oopen_by_idx()</a> opens the nth object in the group specified by <code>loc_id</code> and <code>group_name</code>.</p>
<p><code>loc_id</code> specifies a location identifier. <code>group_name</code> specifies the group relative to <code>loc_id</code> in which the object can be found. If <code>loc_id</code> fully specifies the group in which the object resides, <code>group_name</code> can be a dot (.).</p>
<p>The specific object to be opened within the group is specified by the three parameters: <code>idx_type</code>, <code>order</code> and <code>n</code>.</p>
<p><code>idx_type</code> specifies the type of index by which objects are ordered. Valid index types include the following:</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><code>order</code> specifies the order in which the objects are to be referenced for the purposes of this function. Valid orders include 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>
<p>Note that for <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a>, rather than implying a particular order, it instructs the HDF5 library to iterate through the objects in the fastest available order, i.e., in a natural order.</p>
<p><code>n</code> specifies the position of the object within the index. Note that this count is zero-based; 0 (zero) indicates that the function will return the value of the first object; if <code>n</code> is 5, the function will return the value of the sixth object; etc.</p>
<p><code>lapl_id</code> specifies the link access property list to be used in accessing the object.</p>
<p>An object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. <a class="el" href="#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> can be used to close groups, datasets, or committed datatypes.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.1 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga2ea3627cf171d0565307702a5e203262" name="ga2ea3627cf171d0565307702a5e203262"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ea3627cf171d0565307702a5e203262">◆ </a></span>H5Oopen_by_token()</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> H5Oopen_by_token </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a></td> <td class="paramname"><span class="paramname"><em>token</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens an object in an HDF5 file using its VOL independent token. </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 of object. 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">token</td><td>Object token</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns an object 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="#ga2ea3627cf171d0565307702a5e203262" title="Opens an object in an HDF5 file using its VOL independent token.">H5Oopen_by_token()</a> opens an object specified by the object identifier, <code>loc_id</code> and object token, <code>token</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gaf0318b68be9ab23a92b8a6bee0af9e2f" name="gaf0318b68be9ab23a92b8a6bee0af9e2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf0318b68be9ab23a92b8a6bee0af9e2f">◆ </a></span>H5Orefresh()</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> H5Orefresh </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>oid</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Refreshes all buffers associated with an HDF5 object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">oid</td><td>Location identifier of object. The identifier may be that of a file, group, dataset, named datatype, or attribute.</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="#gaf0318b68be9ab23a92b8a6bee0af9e2f" title="Refreshes all buffers associated with an HDF5 object.">H5Orefresh()</a> causes all buffers associated with an object to be cleared and immediately re-loaded with updated contents from disk.</p>
<p>This function essentially closes the object, evicts all metadata associated with it from the cache, and then re-opens the object. The reopened object is automatically re-registered with the same identifier.</p>
<p>The object associated with <code>oid</code> can be any named object in an HDF5 file including a dataset, a group, or a committed datatype.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga8b5cf8e916204e29616516046121f631" name="ga8b5cf8e916204e29616516046121f631"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8b5cf8e916204e29616516046121f631">◆ </a></span>H5Oset_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> H5Oset_comment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>comment</em></span> )</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">obj_id</td><td>Location identifier of object. 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">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>
<p><a class="el" href="#ga8b5cf8e916204e29616516046121f631" title="Sets comment for specified object.">H5Oset_comment()</a> sets the comment for the specified object to the contents of <code>comment</code>. Any previously existing comment is overwritten.</p>
<p>The target object is specified by an identifier, <code>obj_id</code>. If <code>comment</code> is an empty string or a null pointer, any existing 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. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers.</p>
<p>If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gafeb5242de7f1080b5c19f4fe19784505" name="gafeb5242de7f1080b5c19f4fe19784505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafeb5242de7f1080b5c19f4fe19784505">◆ </a></span>H5Oset_comment_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> H5Oset_comment_by_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>comment</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</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 of object. 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 object whose comment is to be set or reset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">comment</td><td>The new comment </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="#gafeb5242de7f1080b5c19f4fe19784505" title="Sets comment for specified object.">H5Oset_comment_by_name()</a> sets the comment for the specified object to the contents of <code>comment</code>. Any previously existing comment is overwritten.</p>
<p>The target object is specified by <code>loc_id</code> and <code>name</code>. <code>loc_id</code> can specify any object in the file. <code>name</code> can be one of the following:</p>
<ul>
<li>The name of the object specified as a path 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 an empty string or a null pointer, any existing 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. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers.</p>
<p>If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself.</p>
<p><code>lapl_id</code> contains a link access property list identifier. A link access property list can come into play when traversing links to access an object.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaeb8da4fbe62f8a3cd9146a7ac1093562" name="gaeb8da4fbe62f8a3cd9146a7ac1093562"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeb8da4fbe62f8a3cd9146a7ac1093562">◆ </a></span>H5Otoken_cmp()</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> H5Otoken_cmp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *</td> <td class="paramname"><span class="paramname"><em>token1</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *</td> <td class="paramname"><span class="paramname"><em>token2</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>cmp_value</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two VOL connector object tokens. </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 of object. 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">token1</td><td>First object token </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">token2</td><td>Second object token </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cmp_value</td><td>Comparison value</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="#gaeb8da4fbe62f8a3cd9146a7ac1093562" title="Compares two VOL connector object tokens.">H5Otoken_cmp()</a> compares two VOL connector object tokens, <code>token1</code> and <code>token2</code> for the file or group identifier specified by <code>loc_id</code>. Both object tokens must be from the same VOL connector class.</p>
<p><a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> is defined in <a class="el" href="_h5public_8h.html">H5public.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 hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> {</div>
<div class="line"> uint8_t <a class="code hl_variable" href="struct_h5_o__token__t.html#adaac031833a234d10c1ff3130f6aa4cc">__data</a>[<a class="code hl_define" href="_h5public_8h.html#ac91e46b83ee173747f9792b33755ff0e">H5O_MAX_TOKEN_SIZE</a>];</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a>;</div>
</div><!-- fragment --><p>A comparison value, <code>cmp_value</code>, is returned, which indicates the result of the comparison:</p>
<table class="doxtable">
<tr>
<th>cmp_value </th><th>Result </th></tr>
<tr>
<td>> 0 </td><td><code>token1</code> > <code>token2</code> </td></tr>
<tr>
<td>< 0 </td><td><code>token1</code> < <code>token2</code> </td></tr>
<tr>
<td>0 </td><td><code>token1</code> = <code>token2</code> </td></tr>
</table>
<dl class="section user"><dt>Example</dt><dd>An example snippet from test/links.c: <div class="fragment"><div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#gaeb8da4fbe62f8a3cd9146a7ac1093562">H5Otoken_cmp</a>(file, &oinfo1.<a class="code hl_variable" href="struct_h5_o__info2__t.html#aec1bc6735ca478c420f5ff729bcb3888">token</a>, &oinfo2.<a class="code hl_variable" href="struct_h5_o__info2__t.html#aec1bc6735ca478c420f5ff729bcb3888">token</a>, &token_cmp) < 0)</div>
<div class="line"> FAIL_STACK_ERROR;</div>
<div class="line"> <span class="keywordflow">if</span> (token_cmp) {</div>
<div class="line"> H5_FAILED();</div>
<div class="line"> puts(<span class="stringliteral">" Hard link test failed. Link seems not to point to the "</span>);</div>
<div class="line"> puts(<span class="stringliteral">" expected file location."</span>);</div>
<div class="line"> TEST_ERROR;</div>
<div class="line"> } <span class="comment">/* end if */</span></div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga5136c14b4e907f15007030d7a6d6cd24" name="ga5136c14b4e907f15007030d7a6d6cd24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5136c14b4e907f15007030d7a6d6cd24">◆ </a></span>H5Otoken_from_str()</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> H5Otoken_from_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>token_str</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *</td> <td class="paramname"><span class="paramname"><em>token</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deserializes a string into a connector object token. </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 of object. 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">token_str</td><td>Object token string </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">token</td><td>Connector object token</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="#ga5136c14b4e907f15007030d7a6d6cd24" title="Deserializes a string into a connector object token.">H5Otoken_from_str()</a> deserializes a string, <code>token_str</code>, into a connector object token, <code>token</code>, for the object specified by the location identifier, <code>loc_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga2bdd7528090f7f2c4b361ab4cc7735f6" name="ga2bdd7528090f7f2c4b361ab4cc7735f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bdd7528090f7f2c4b361ab4cc7735f6">◆ </a></span>H5Otoken_to_str()</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> H5Otoken_to_str </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> *</td> <td class="paramname"><span class="paramname"><em>token</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char **</td> <td class="paramname"><span class="paramname"><em>token_str</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serializes a connector's object token into a string. </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 of object. 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">token</td><td>Connector object token </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">token_str</td><td>String for connector object token <code>token</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga2bdd7528090f7f2c4b361ab4cc7735f6" title="Serializes a connector's object token into a string.">H5Otoken_to_str()</a> serializes a connector's object token specified by <code>token</code> and the location identifier for the object, <code>loc_id</code>, into a string, <code>token_str</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga6efdb2a0a9fe9fe46695cc0f7bd993e7" name="ga6efdb2a0a9fe9fe46695cc0f7bd993e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7">◆ </a></span>H5Ovisit1()</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> H5Ovisit1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects accessible from a specified object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier of object. 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">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000064">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> or the macro <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit</a>.</dd></dl>
<p><a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a> is a recursive iteration function to visit the object <code>obj_id</code> and, if <code>obj_id</code> is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <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>.</p>
<p>If <code>obj_id</code> is a group identifier, that group serves as the root of a recursive iteration. If <code>obj_id</code> is a file identifier, that file's root group serves as the root of the recursive iteration. If <code>obj_id</code> is an attribute identifier, then the object where the attribute is attached will be iterated. If <code>obj_id</code> is any other type of object, such as a dataset or named datatype, there is no iteration.</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p><a class="el" href="group___t_r_a_v.html#ga5424ef7043c82147490d027a0e8a59ef" title="Recursively visits all links starting from a specified group.">H5Lvisit1()</a> and <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires. These functions assume that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the resulting behavior is undefined.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.5 The macro <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit</a> was removed and the function <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a> was copied to <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit()</a>. </dd>
<dd>
1.10.3 Function <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit()</a> was copied to <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a>, and the macro <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit</a> was created. </dd>
<dd>
1.8.8 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaa4ab542f581f4fc9a4eaa95debb29c9e" name="gaa4ab542f581f4fc9a4eaa95debb29c9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa4ab542f581f4fc9a4eaa95debb29c9e">◆ </a></span>H5Ovisit2()</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> H5Ovisit2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects accessible from a specified object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier of object. 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">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to be retrieved to the callback <code>op</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000066">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> or the macro <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit</a>.</dd></dl>
<p><a class="el" href="#gaa4ab542f581f4fc9a4eaa95debb29c9e" title="Recursively visits all objects accessible from a specified object.">H5Ovisit2()</a> is a recursive iteration function to visit the object <code>obj_id</code> and, if <code>obj_id</code> is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <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>.</p>
<p>If <code>obj_id</code> is a group identifier, that group serves as the root of a recursive iteration. If <code>obj_id</code> is a file identifier, that file's root group serves as the root of the recursive iteration. If <code>obj_id</code> is an attribute identifier, then the object where the attribute is attached will be iterated. If <code>obj_id</code> is any other type of object, such as a dataset or named datatype, there is no iteration.</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be retrieved by the <code>op</code> callback function. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p><a class="el" href="group___t_r_a_v.html#gac0558936502924d9e898d8b6e041ed69">H5Lvisit()</a> and <a class="el" href="#ga5ce86255fcc34ceaf84a62551cd24233">H5Ovisit()</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires. These functions assume that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the resulting behavior is undefined.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.3 </dd></dl>
</div>
</div>
<a id="ga6d03115ae0e5e5b516bbf35bb492266a" name="ga6d03115ae0e5e5b516bbf35bb492266a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6d03115ae0e5e5b516bbf35bb492266a">◆ </a></span>H5Ovisit3()</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> H5Ovisit3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>obj_id</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects accessible from a specified object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Location identifier of object. 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">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to be retrieved to the callback <code>op</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<p><a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> is a recursive iteration function to visit the object <code>obj_id</code> and, if <code>obj_id</code> is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a>.</p>
<p>If <code>obj_id</code> is a group identifier, that group serves as the root of a recursive iteration. If <code>obj_id</code> is a file identifier, that file's root group serves as the root of the recursive iteration. If <code>obj_id</code> is an attribute identifier, then the object where the attribute is attached will be iterated. If <code>obj_id</code> is any other type of object, such as a dataset or named datatype, there is no iteration.</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p>The <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> <code>op_data</code> parameter is a user-defined pointer to the data required to process objects in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function's <code>op_data</code> parameter.</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be retrieved by the <code>op</code> callback function. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p><a class="el" href="group___t_r_a_v.html#gae1c6f963892a5f4e8922a66fbe338f66" title="Recursively visits all links starting from a specified group.">H5Lvisit2()</a> and <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires. These functions assume that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the resulting behavior is undefined.</p>
<dl class="section user"><dt>Example</dt><dd>An example snippet from test/links.c: <div class="fragment"><div class="line"> </div>
<div class="line"> <span class="comment">/* Visit all the objects reachable from the root group (with file ID) */</span></div>
<div class="line"> udata.idx = 0;</div>
<div class="line"> udata.info = new_format ? ovisit0_new : ovisit0_old;</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga6d03115ae0e5e5b516bbf35bb492266a">H5Ovisit3</a>(fid, <a class="code hl_enumvalue" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="code hl_enumvalue" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, visit_obj_cb, &udata, <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>) < 0)</div>
<div class="line"> FAIL_STACK_ERROR;</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="gaffacf3bd66f4fe074099eae1c80914f2" name="gaffacf3bd66f4fe074099eae1c80914f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaffacf3bd66f4fe074099eae1c80914f2">◆ </a></span>H5Ovisit_by_name1()</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> H5Ovisit_by_name1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>obj_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects starting from a 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 of object. 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">obj_name</td><td>Name of the object, generally relative to <code>loc_id</code>, that will serve as root of the iteration </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object </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>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000065">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a> or the macro <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a>.</dd></dl>
<p><a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a> is a recursive iteration function to visit the object specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair and, if that object is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <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>.</p>
<p>The object serving as the root of the iteration is specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair. <code>loc_id</code> specifies a file or an object in a file; if <code>loc_id</code> is an attribute identifier, the object where the attribute is attached will be used. <code>obj_name</code> specifies either an object in the file (with an absolute name based on the file's root group) or an object name relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, <code>obj_name</code> should be '<code></code>.' (a dot). (Note that when <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a> instead of <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a>.)</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p>The <code>op</code> callback function and the effect of the callback function's return value on the application are described in <a class="el" href="#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1()</a>.</p>
<p>The <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code> is defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> and described in the <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> function entry.</p>
<p>The <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a> <code>op_data</code> parameter is a user-defined pointer to the data required to process objects in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function's <code>op_data</code> parameter.</p>
<p><code>lapl_id</code> is a link access property list. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p><a class="el" href="group___t_r_a_v.html#ga1f1ba1bb4d44f2c111990024809417ac" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name1()</a> and <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.5 The macro <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a> was removed and the function <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a> was copied to <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a>. </dd>
<dd>
1.10.3 The <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name()</a> function was renamed to <a class="el" href="#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1()</a>, and the macro <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a> was created. </dd>
<dd>
1.8.11 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga9c155caf5499405fe403e1eb27b5beb6" name="ga9c155caf5499405fe403e1eb27b5beb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c155caf5499405fe403e1eb27b5beb6">◆ </a></span>H5Ovisit_by_name2()</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> H5Ovisit_by_name2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>obj_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a1e341f3acea3993c4e19b2940a83fd86">H5O_iterate1_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects starting from a 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 of object. 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">obj_name</td><td>Name of the object, generally relative to <code>loc_id</code>, that will serve as root of the iteration </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to be retrieved to the callback function <code>op</code> </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>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000067">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a> or the macro <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a>.</dd></dl>
<p><a class="el" href="#ga9c155caf5499405fe403e1eb27b5beb6" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name2()</a> is a recursive iteration function to visit the object specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair and, if that object is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <a class="el" href="group___t_r_a_v.html#ga55406698106930db68242987c11ba051">H5Literate</a>.</p>
<p>The object serving as the root of the iteration is specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair. <code>loc_id</code> specifies a file or an object in a file; if <code>loc_id</code> is an attribute identifier, the object where the attribute is attached will be used. <code>obj_name</code> specifies either an object in the file (with an absolute name based in the file's root group) or an object name relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, <code>obj_name</code> should be '<code></code>.' (a dot). (Note that when <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="#gaa4ab542f581f4fc9a4eaa95debb29c9e" title="Recursively visits all objects accessible from a specified object.">H5Ovisit2()</a> instead of <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a>.)</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p>The <code>op</code> callback function and the effect of the callback function's return value on the application are described in <a class="el" href="#gaa4ab542f581f4fc9a4eaa95debb29c9e" title="Recursively visits all objects accessible from a specified object.">H5Ovisit2()</a>.</p>
<p>The <a class="el" href="struct_h5_o__info1__t.html">H5O_info1_t</a> <code>struct</code> is defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> and described in the <a class="el" href="#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1()</a> function entry.</p>
<p>The <a class="el" href="#ga9c155caf5499405fe403e1eb27b5beb6" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name2()</a> <code>op_data</code> parameter is a user-defined pointer to the data required to process objects in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function's <code>op_data</code> parameter.</p>
<p><code>lapl_id</code> is a link access property list. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be retrieved by the <code>op</code> callback function. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p><a class="el" href="group___t_r_a_v.html#ga138405315e233673741893e4e250f055">H5Lvisit_by_name</a> and <a class="el" href="#gab02a69e88b11404e7fd61f55344b186c">H5Ovisit_by_name</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.3 </dd></dl>
</div>
</div>
<a id="ga34815400b01df59c4dac19436124885a" name="ga34815400b01df59c4dac19436124885a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga34815400b01df59c4dac19436124885a">◆ </a></span>H5Ovisit_by_name3()</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> H5Ovisit_by_name3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>obj_name</em>, </span></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"><span class="paramname"><em>idx_type</em>, </span></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"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>fields</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Recursively visits all objects accessible from a 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 of object. 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">obj_name</td><td>Name of the object, generally relative to <code>loc_id</code>, that will serve as root of the iteration </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Callback function passing data regarding the object to the calling application </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined pointer to data required by the application for its processing of the object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fields</td><td>Flags specifying the fields to be retrieved to the callback function <code>op</code> </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>On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.</dd>
<dd>
On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.</dd></dl>
<p><a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a> is a recursive iteration function to visit the object specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair and, if that object is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a>.</p>
<p>The object serving as the root of the iteration is specified by the <code>loc_id</code> / <code>obj_name</code> parameter pair. <code>loc_id</code> specifies a file or an object in a file; if <code>loc_id</code> is an attribute identifier, the object where the attribute is attached will be used. <code>obj_name</code> specifies either an object in the file (with an absolute name based on the file's root group) or an object name relative to <code>loc_id</code>. If <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, <code>obj_name</code> should be '<code></code>.' (a dot). (Note that when <code>loc_id</code> fully specifies the object that is to serve as the root of the iteration, the user may wish to consider using <a class="el" href="#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3()</a> instead of <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a>.)</p>
<p>Two parameters are used to establish the iteration: <code>idx_type</code> and <code>order</code>.</p>
<p><code>idx_type</code> specifies the index to be used. If the links in a group have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly.</p>
<p>Note that the index type passed in <code>idx_type</code> is a <em>best effort</em> setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alphanumeric order by name, or <em>name order</em>. (<em>Name order</em> is the native order used by the HDF5 library and is always available.)</p>
<p><code>order</code> specifies the order in which objects are to be inspected along the index specified in <code>idx_type</code>.</p>
<p>The <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a> <code>op_data</code> parameter is a user-defined pointer to the data required to process objects in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function's <code>op_data</code> parameter.</p>
<p><code>lapl_id</code> is a link access property list. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p>The <code>fields</code> parameter contains flags to determine which fields will be retrieved by the <code>op</code> callback function. These flags are defined in the <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a> file: </p><table class="doxtable">
<tr>
<th>Flag</th><th>Purpose</th></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a></td><td>Fill in the fileno, addr, type, and rc fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a></td><td>Fill in the atime, mtime, ctime, and btime fields</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> </td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a></td><td>Fill in the num_attrs field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td><td>Fill in the meta_size field</td></tr>
<tr>
<td><a class="el" href="_h5_opublic_8h.html#a7a2088668e3e0e87ea625fe1d6243a08">H5O_INFO_ALL</a></td><td><a class="el" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a> | <a class="el" href="_h5_opublic_8h.html#a62585d2e7217b5ad3a896bb6035b1bdb">H5O_INFO_TIME</a> | <a class="el" href="_h5_opublic_8h.html#a06bd4abefb70371afef7446ecfb4a72a">H5O_INFO_NUM_ATTRS</a> | <a class="el" href="_h5_opublic_8h.html#ae45a752a2eb50abff7cee4f66361c0c2">H5O_INFO_HDR</a> | <a class="el" href="_h5_opublic_8h.html#af69edf0fc8c8bc8afc139a32f0a5e53a">H5O_INFO_META_SIZE</a></td></tr>
</table>
<p><a class="el" href="group___t_r_a_v.html#gafee93792c7e27a7e78b1ec221876b173" title="Recursively visits all links starting from a specified group.">H5Lvisit_by_name2()</a> and <a class="el" href="#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3()</a> are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.</p>
<dl class="section user"><dt>Example</dt><dd>An example snippet from test/links.c: <div class="fragment"><div class="line"> </div>
<div class="line"> <span class="comment">/* Visit all the objects reachable from the root group (with file ID) */</span></div>
<div class="line"> udata.idx = 0;</div>
<div class="line"> udata.info = new_format ? ovisit0_new : ovisit0_old;</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code hl_function" href="#ga34815400b01df59c4dac19436124885a">H5Ovisit_by_name3</a>(fid, <span class="stringliteral">"/"</span>, <a class="code hl_enumvalue" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="code hl_enumvalue" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a>, visit_obj_cb, &udata, <a class="code hl_define" href="_h5_opublic_8h.html#addd3f3f27f124a16a52c390b8431a878">H5O_INFO_BASIC</a>,</div>
<div class="line"> <a class="code hl_define" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>) < 0)</div>
<div class="line"> FAIL_STACK_ERROR;</div>
<div class="line"> </div>
</div><!-- fragment --></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
