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
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
|
<!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: HDF5 Virtual Object Layer (VOL) Connector Author Guide</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.c3714b9</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('_v_o_l__connector.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><div class="header">
<div class="headertitle"><div class="title">HDF5 Virtual Object Layer (VOL) Connector Author Guide</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Navigate back: <a class="el" href="index.html">Main</a> </p><hr />
<h1><a class="anchor" id="secVOLIntro"></a>
Introduction</h1>
<p>The Virtual Object Layer (VOL) is an abstraction layer in the HDF5 library which intercepts all API calls that could potentially access objects in an HDF5 container and forwards those calls to object drivers referred to as <em>VOL connectors</em>. The architecture of this feature is described in the <a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a> and VOL Architecture and Internals Documentation and will not be duplicated here.</p>
<p>This guide is for people who are interested in developing their own VOL connector for the HDF5 library. It is assumed that the reader has good knowledge of the VOL architecture obtained by reading the VOL architectural design document.</p>
<h1><a class="anchor" id="secVOLCreate"></a>
Creating a New Connector</h1>
<h2><a class="anchor" id="subsecVOLOverview"></a>
Overview</h2>
<p>Creating a new VOL connector can be a complicated process. You will need to map your storage system to the HDF5 data model through the lens of the VOL and this may involve some impedance mismatch that you will have to work around. The good news is that the HDF5 library has been re-engineered to handle arbitrary, connector-specific data structures via the VOL callbacks, so no knowledge of the library internals is necessary to write a VOL connector.</p>
<p>Writing a VOL connector requires these things: </p><ul>
<li>Decide on library vs plugin vs internal. </li>
<li>Set up your build/test files (CMake, Autotools, etc.). </li>
<li>Fill in some boilerplate information in yourH5VLclasststruct. </li>
<li>Decide how you will perform any necessary initialization needed by your storage system. </li>
<li>Map Storage to HDF5 File Objects </li>
<li>Create implementations for the callbacks you need to support. </li>
<li>Test the connector.</li>
</ul>
<p>Each of the steps listed above is described in more detail in this section of the document.</p>
<p>The "model then implement" steps can be performed iteratively. You might begin by only supporting files, datasets, and groups and only allowing basic operations on them. In some cases, this may be all that is needed. As your needs grow, you can repeat those steps and increase the connector's HDF5 API coverage at a pace that makes sense for your users.</p>
<p>Also, note that this document only covers writing VOL connectors using the C programming language. It is often possible to write connectors in other programming languages (e.g.; Python) via the language's C interop facilities, but that topic is out of scope for this document.</p>
<h2><a class="anchor" id="subsecVOL112dep"></a>
The HDF5 1.12.x VOL Interface Is DEPRECATED</h2>
<p>Important changes were made to the VOL interface for HDF5 1.13.0 and, due to binary compatibility issues, these cannot be merged to HDF5 1.12.x. For this reason, VOL connector development should be shifted to target 1.13.0 as no further development of the VOL interface will take place on the 1.12.x branch. Unlike the other development branches of the library, there is no hdf5_1_13 branch - all HDF5 1.13.0 development is taking place in the develop branch of the HDF5 repository and 1.13.x branches will split off from that.</p>
<p>Note also that HDF5 1.13.0 is considered an unstable branch, and the API and file format are subject to change ("unstable" means "not yet finalized", not "buggy"). The VOL feature is under active development and, although it is nearing its final form, may change further before the stable HDF5 1.14.0 release targeted for 2022.</p>
<h2><a class="anchor" id="subsecVOLRelated"></a>
VOL-Related HDF5 Header Files</h2>
<p>Use of the VOL, including topics such as registration and loading VOL plugins, is described in the <a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a>.</p>
<p>Public header Files you will need to be familiar with include: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_v_lpublic_8h.html">H5VLpublic.h</a> </td><td>Public VOL header. </td></tr>
<tr>
<td><a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a> </td><td>Main header for connector authors. Contains definitions for the main VOL struct and callbacks, enum values, etc. </td></tr>
<tr>
<td><a class="el" href="_h5_v_lconnector__passthru_8h.html">H5VLconnector_passthru.h</a> </td><td>Helper routines for passthrough connector authors. </td></tr>
<tr>
<td><a class="el" href="_h5_v_lnative_8h.html">H5VLnative.h</a> </td><td>Native VOL connector header. May be useful if your connector will attempt to implement native HDF5 API calls that are handled via the optional callbacks. </td></tr>
<tr>
<td><a class="el" href="_h5_p_lextern_8h.html">H5PLextern.h</a> </td><td>Needed if your connector will be built as a plugin. </td></tr>
</table>
<p>Many VOL connectors are listed on The HDF Group's VOL plugin registration page, located at: <a href="https://portal.hdfgroup.org/display/support/Registered+VOL+Connectors">Registered VOL Connectors</a>. Not all of these VOL connectors are supported by The HDF Group and the level of completeness varies, but the connectors found there can serve as examples of working implementations</p>
<h2><a class="anchor" id="subsecVOLLPI"></a>
Library vs Plugin vs Internal</h2>
<p>When building a VOL connector, you have several options:</p>
<h4>Library</h4>
<p>The connector can be built as a normal shared or static library. Software that uses your connector will have to link to it just like any other library. This can be convenient since you don't have to deal with plugin paths and searching for the connector at runtime, but it also means that software which uses your connector will have to be built and linked against it.</p>
<h4>Plugin</h4>
<p>You can also build your connector as a dynamically loaded plugin. The mechanism for this is the same mechanism used to dynamically load HDF5 filter plugins. This can allow use of your connector via the VOL environment variable, without modifying the application, but requires your plugin to be discoverable at runtime. See the <a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a> for more information about using HDF5 plugins.</p>
<p>To build your connector as a plugin, you will have to include <b><a class="el" href="_h5_p_lextern_8h.html">H5PLextern.h</a></b> (a public header distributed with the library) and implement the <a class="el" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a> <a class="el" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a> calls, both of which are trivial to code up. It also often requires your connector to be built with certain compile/link options. The VOL connector template does all of these things.</p>
<p>The HDF5 library's plugin loading code will call <a class="el" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a> to determine the type of plugin(e.g.; filter, VOL) and <a class="el" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a> to get the class struct, which allows the library to query the plugin for its name and value to see if it has found a requested plugin. When a match is found, the library will use the class struct to register the connector and map its callbacks.</p>
<p>For the HDF5 library to be able to load an external plugin dynamically, the plugin developer has to define two public routines with the following name and signature: </p><div class="fragment"><div class="line"><a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> <a class="code hl_function" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a>(<span class="keywordtype">void</span>);</div>
<div class="ttc" id="a_h5_p_lextern_8h_html_a11942aa6c2beef4a76faa83b77feacd5"><div class="ttname"><a href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a></div><div class="ttdeci">H5PL_type_t H5PLget_plugin_type(void)</div></div>
<div class="ttc" id="a_h5_p_lextern_8h_html_a12bc51a0ed6df8d85b2fb6c4410cd1cd"><div class="ttname"><a href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a></div><div class="ttdeci">const void * H5PLget_plugin_info(void)</div></div>
<div class="ttc" id="a_h5_p_lpublic_8h_html_a8d48cb770a80a3f84c969ec03b34d86f"><div class="ttname"><a href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a></div><div class="ttdeci">H5PL_type_t</div><div class="ttdef"><b>Definition</b> H5PLpublic.h:34</div></div>
</div><!-- fragment --><p>To show how easy this is to accomplish, here is the complete implementation of those functions in the template VOL connector: </p><div class="fragment"><div class="line"><a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> <a class="code hl_function" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a>; }</div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a>(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> &template_class_g; }</div>
<div class="ttc" id="a_h5_p_lpublic_8h_html_a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0"><div class="ttname"><a href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a></div><div class="ttdeci">@ H5PL_TYPE_VOL</div><div class="ttdef"><b>Definition</b> H5PLpublic.h:37</div></div>
</div><!-- fragment --><p><a class="el" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a> should return the library type which should always be <a class="el" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a>. <a class="el" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a> should return a pointer to the plugin structure defining the VOL plugin with all the callbacks. For example, consider an external plugin defined as: </p><div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> H5VL_foo_g = {</div>
<div class="line"> 2, <span class="comment">// version</span></div>
<div class="line"> 12345, <span class="comment">// value</span></div>
<div class="line"> <span class="stringliteral">"foo"</span>, <span class="comment">// name</span></div>
<div class="line"> ...</div>
<div class="line">}</div>
<div class="ttc" id="astruct_h5_v_l__class__t_html"><div class="ttname"><a href="struct_h5_v_l__class__t.html">H5VL_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1011</div></div>
</div><!-- fragment --><p>The plugin would implement the two routines as: </p><div class="fragment"><div class="line"><a class="code hl_enumeration" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86f">H5PL_type_t</a> <a class="code hl_function" href="_h5_p_lextern_8h.html#a11942aa6c2beef4a76faa83b77feacd5">H5PLget_plugin_type</a>(<span class="keywordtype">void</span>)</div>
<div class="line"> {<span class="keywordflow">return</span> <a class="code hl_enumvalue" href="_h5_p_lpublic_8h.html#a8d48cb770a80a3f84c969ec03b34d86fab01b3951d7e978b43e505590a6431bf0">H5PL_TYPE_VOL</a>;}</div>
<div class="line"><span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_p_lextern_8h.html#a12bc51a0ed6df8d85b2fb6c4410cd1cd">H5PLget_plugin_info</a>(<span class="keywordtype">void</span>)</div>
<div class="line"> {<span class="keywordflow">return</span> &H5VL_foo_g;}</div>
</div><!-- fragment --><h4>Internal</h4>
<p>Your VOL connector can also be constructed as a part of the HDF5 library. This works in the same way as the stdio and multi virtual file drivers (VFDs) and does not require knowledge of HDF5 internals or use of non-public API calls. You simply have to add your connector's files to the Makefile.am and/or CMakeLists.txt files in the source distribution's src directory. This requires maintaining a private build of the library, though, and is not recommended.</p>
<h2><a class="anchor" id="subsecVOLBuild"></a>
Build Files / VOL Template</h2>
<p>We have created a template terminal VOL connector that includes both Autotools and CMake build files. The constructed VOL connector includes no real functionality, but can be registered and loaded as a plugin.</p>
<p>The VOL template can be found here: <a href="https://github.com/HDFGroup/vol-template">VOL template</a></p>
<p>The purpose of this template is to quickly get you to the point where you can begin filling in the callback functions and writing tests. You can copy this code to your own repository to serve as the basis for your new connector.</p>
<p>A template passthrough VOL is also available. This will be discussed in the section on passthrough connectors.</p>
<h2><a class="anchor" id="subsecVOLBoil"></a>
H5VL_class_t Boilerplate</h2>
<p>Several fields in the H5VLclasststruct will need to be filled in.</p>
<p>In HDF5 1.13.0, the <em>version</em> field will be 2, indicating the connector targets version 2 of the <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct. Version 1 of the struct was never formally released and only available in the develop branch of the HDF5 git repository. Version 0 is used in the deprecated HDF5 1.12.x branch.</p>
<p>Every connector needs a <em>name</em> and <em>value</em>. The library will use these when loading and registering the connector (as described in the <a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a>), so they should be unique in your ecosystem.</p>
<p>VOL connector values are integers, with a maximum value of 65535. Values from 0 to 255 are reserved for internal use by The HDF Group. The native VOL connector has a value of 0. Values of 256 to 511 are for connector testing and should not be found in the wild. Values of 512 to 65535 are for external connectors.</p>
<p>As is the case with HDF5 filters, The HDF Group can assign you an official VOL connector value. Please contact <a href="help@hdfgroup.org">help@hdfgroup.org</a> for help with this. We currently do not register connector names, though the name you've chosen will appear on the registered VOL connectors page.</p>
<p>As noted above, registered VOL connectors will be listed at: <a href="https://portal.hdfgroup.org/display/support/Registered+VOL+Connectors">Registered VOL Connectors</a></p>
<p>A new <b>conn_version</b> field has been added to the class struct for 1.13. This field is currently not used by the library so its use is determined by the connector author. Best practices for this field will be determined in the near future and this part of the guide will be updated.</p>
<p>The <b>cap_flags</b> field is used to determine the capabilities of the VOL connector. At this time, the use of this field is limited to indicating thread-safety, asynchronous capabilities, and ability to produce native HDF5 files. Supported flags can be found in <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a>. </p><div class="fragment"><div class="line"><span class="comment">// Capability flags for connector</span></div>
<div class="line"><span class="preprocessor">#define H5VL_CAP_FLAG_NONE 0 </span><span class="comment">// No special connector capabilities</span></div>
<div class="line"><span class="preprocessor">#define H5VL_CAP_FLAG_THREADSAFE 0x01 </span><span class="comment">// Connector is threadsafe</span></div>
<div class="line"><span class="preprocessor">#define H5VL_CAP_FLAG_ASYNC 0x02 </span><span class="comment">// Connector performs operations asynchronously</span></div>
<div class="line"><span class="preprocessor">#define H5VL_CAP_FLAG_NATIVE_FILES 0x04 </span><span class="comment">// Connector produces native file format</span></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLInit"></a>
Initialization and Shutdown</h2>
<p>You'll need to decide how to perform any initialization and shutdown tasks that are required by your connector. There are initialize and terminate callbacks in the <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct to handle this. They are invoked when the connector is registered and unregistered, respectively. The initialize callback can take a VOL initialization property list, so any properties you need for initialization can be applied to it. The HDF5 library currently makes no use of the vipl so there are no default vipl properties.</p>
<p>If this is unsuitable, you may have to create custom connector-specific API calls to handle initialization and termination. It may also be useful to perform operations in a custom API call used to set the VOL connector in the fapl.</p>
<p>The initialization and terminate callbacks: </p><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*initialize)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id); <span class="comment">// Connector initialization callback</span></div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*terminate)(void); <span class="comment">// Connector termination callback</span></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_h5public_8h_html_a3b079ecf932a5c599499cf7e298af160"><div class="ttname"><a href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a></div><div class="ttdeci">int herr_t</div><div class="ttdef"><b>Definition</b> H5public.h:235</div></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLMap"></a>
Map Storage to HDF5 File Objects</h2>
<p>The most difficult part of designing a new VOL connector is going to determining how to support HDF5 file objects and operations using your storage system. There isn't much specific advice to give here, as each connector will have unique needs, but a forthcoming "tutorial" connector will set up a simple connector and demonstrate this process.</p>
<h2><a class="anchor" id="subsecVOLFillIn"></a>
Fill In VOL Callbacks</h2>
<p>For each file object you support in your connector (including the file itself), you will need to create a data struct to hold whatever file object metadata that are needed by your connector. For example, a data structure for a VOL connector based on text files might have a file struct that contains a file pointer for the text file, buffers used for caching data, etc. Pointers to these data structures are where your connector's state is stored and are returned to the HDF5 library from the create/open/etc. callbacks such as <em>dataset create</em>.</p>
<p>Once you have your data structures, you'll need to create your own implementations of the callback functions and map them via your <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct.</p>
<h2><a class="anchor" id="subsecVOLOpt"></a>
Handling Optional Operations</h2>
<p>Handling optional operations has changed significantly in HDF5 1.13.0. In the past, optional operations were specified using an integer <em>opt_type</em> parameter. This proved to be a problem with pass-through connectors, though, as it was possible to have <em>opt_type</em> clash if two connectors used the same <em>opt_type</em> values.</p>
<p>The new scheme allows a connector to register an optional operation with the library and receive a dynamically-allocated <em>opt_type</em> value for the operation.</p>
<p>The following API calls can be used to manage the optional operations: </p><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a>(<a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, <span class="keyword">const</span> <span class="keywordtype">char</span> *op_name, <span class="keywordtype">int</span> *op_val);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector_8h.html#ab3c45344dc248471076e58dc3f66a9ec">H5VLfind_opt_operation</a>(<a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, <span class="keyword">const</span> <span class="keywordtype">char</span> *op_name, <span class="keywordtype">int</span> *op_val);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector_8h.html#aef785a9a3f73d7ce6954ca742e4f8135">H5VLunregister_opt_operation</a>(<a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, <span class="keyword">const</span> <span class="keywordtype">char</span> *op_name)</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a85d2e5bf7c9e947f5a1645bbd0f887d9"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a></div><div class="ttdeci">herr_t H5VLregister_opt_operation(H5VL_subclass_t subcls, const char *op_name, int *op_val)</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab3c45344dc248471076e58dc3f66a9ec"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab3c45344dc248471076e58dc3f66a9ec">H5VLfind_opt_operation</a></div><div class="ttdeci">herr_t H5VLfind_opt_operation(H5VL_subclass_t subcls, const char *op_name, int *op_val)</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_aef785a9a3f73d7ce6954ca742e4f8135"><div class="ttname"><a href="_h5_v_lconnector_8h.html#aef785a9a3f73d7ce6954ca742e4f8135">H5VLunregister_opt_operation</a></div><div class="ttdeci">herr_t H5VLunregister_opt_operation(H5VL_subclass_t subcls, const char *op_name)</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_ga14175ca7d867657e3e5c2f79a154a599"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a></div><div class="ttdeci">H5VL_subclass_t</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:152</div></div>
</div><!-- fragment --><p>The <em>register</em> call is used to register an operation for a subclass (file, etc.) and the <em>opt_type</em> parameter that the library assigned to the operation will be returned via the <em>opt_val</em> parameter. This value can then be passed to one of the subclass-specific API calls (listed below). If you need to find an existing optional call's assigned <em>opt_type</em> value by name, you can use the <em>find</em> call.</p>
<p>One recommended way to handle optional calls is to <em>register</em> all the optional calls at startup, saving the values in connector state, then use these cached values in your optional calls. The assigned values should be unregistered using the <em>unregister</em> call when the connector shuts down.</p>
<p>Subclass-specific optional calls: </p><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a932291eed9ef2abfa4c9bbdff88ef073">H5VLattr_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> attr_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a46bf2c58bb032bcae1794aa4cf6f6b59">H5VLdataset_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dset_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a4ecacacc56f7d4e13fda483f901f1d6d">H5VLdatatype_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, hid_tes_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a9234611f30a8d7bc79d1c315c513c9e6">H5VLfile_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a942d8bb5cc709547097bd30689be4e60">H5VLgroup_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> group_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#ac06a3858e28b503b0d60b13b262a2058">H5VLlink_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_define" href="_h5_v_lconnector_8h.html#a407bdc0c5d16239a9f9e1c7ffeee6c46">H5VLobject_optional_op</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *app_file, <span class="keyword">const</span> <span class="keywordtype">char</span> *app_func, <span class="keywordtype">unsigned</span> app_line,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> es_id);</div>
<div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector_8h.html#af22b04c4bd4cfb8b1f319a3ceac86396">H5VLrequest_optional_op</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a407bdc0c5d16239a9f9e1c7ffeee6c46"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a407bdc0c5d16239a9f9e1c7ffeee6c46">H5VLobject_optional_op</a></div><div class="ttdeci">#define H5VLobject_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1141</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a46bf2c58bb032bcae1794aa4cf6f6b59"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a46bf2c58bb032bcae1794aa4cf6f6b59">H5VLdataset_optional_op</a></div><div class="ttdeci">#define H5VLdataset_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1136</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a4ecacacc56f7d4e13fda483f901f1d6d"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a4ecacacc56f7d4e13fda483f901f1d6d">H5VLdatatype_optional_op</a></div><div class="ttdeci">#define H5VLdatatype_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1137</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9234611f30a8d7bc79d1c315c513c9e6"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9234611f30a8d7bc79d1c315c513c9e6">H5VLfile_optional_op</a></div><div class="ttdeci">#define H5VLfile_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1138</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a932291eed9ef2abfa4c9bbdff88ef073"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a932291eed9ef2abfa4c9bbdff88ef073">H5VLattr_optional_op</a></div><div class="ttdeci">#define H5VLattr_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1135</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a942d8bb5cc709547097bd30689be4e60"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a942d8bb5cc709547097bd30689be4e60">H5VLgroup_optional_op</a></div><div class="ttdeci">#define H5VLgroup_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1139</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ac06a3858e28b503b0d60b13b262a2058"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ac06a3858e28b503b0d60b13b262a2058">H5VLlink_optional_op</a></div><div class="ttdeci">#define H5VLlink_optional_op(...)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1140</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_af22b04c4bd4cfb8b1f319a3ceac86396"><div class="ttname"><a href="_h5_v_lconnector_8h.html#af22b04c4bd4cfb8b1f319a3ceac86396">H5VLrequest_optional_op</a></div><div class="ttdeci">herr_t H5VLrequest_optional_op(void *req, hid_t connector_id, H5VL_optional_args_t *args)</div></div>
<div class="ttc" id="astruct_h5_v_l__optional__args__t_html"><div class="ttname"><a href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:94</div></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLTest"></a>
Testing Your Connector</h2>
<p>At the time of writing, some of the HDF5 library tests have been abstracted out of the library with their native-file-format-only sections removed and added to a VOL test suite available here: <a href="https://github.com/HDFGroup/vol-tests">vol-tests</a></p>
<p>This is an evolving set of tests, so see the documentation in that repository for instructions as to its use. You may want to clone and modify and/or extend these tests for use with your own connector.</p>
<p>In the future, we plan to modify the HDF5 test suite that ships with the library to use a future VOL capabilities flags scheme to selectively run tests that a particular connector supports. As this is a large task, it may be some time before that work is complete.</p>
<h2><a class="anchor" id="subsecVOLPassthrough"></a>
Passthrough Connectors</h2>
<p>Coming Soon</p>
<h2><a class="anchor" id="subsecVOLAsync"></a>
Asynchronous Operations</h2>
<p>Coming Soon</p>
<h1><a class="anchor" id="secVOLRef"></a>
VOL Connector Interface Reference</h1>
<p>Each VOL connector should be of type <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a>: </p><table class="doxtable">
<tr>
<td><em>VOL connector class, <a class="el" href="_h5_v_lpublic_8h.html">H5VLpublic.h</a></em> <div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> {</div>
<div class="line"> <span class="comment">/* Overall connector fields & callbacks */</span></div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a27fe8e82cf2ce359010cc1d08af2e105">version</a>; </div>
<div class="line"> <a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a4531586e75e64de257cf51b4b7c50d70">value</a>; </div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__class__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>; </div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a6566afc54591b6c64dbec7bdc0bf0b58">conn_version</a>; </div>
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_v_l__class__t.html#ac4b405cf0a53f734d273232a82baf247">cap_flags</a>; </div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__class__t.html#a0a18753f3a24e91b75fd802b81f044a7">initialize</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id); </div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__class__t.html#a3da863f4634c64aeffe46cca882db43d">terminate</a>)(void); </div>
<div class="line"> <span class="comment">/* VOL framework */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__info__class__t.html">H5VL_info_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#afdbe51576a0f6360693757d6738111eb">info_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__wrap__class__t.html">H5VL_wrap_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a74d541c08c6c71946cc5a1e105ca5e51">wrap_cls</a>; </div>
<div class="line"> <span class="comment">/* Data Model */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__class__t.html">H5VL_attr_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#aea95f1ef7bfe9d0a06f5d7ba4d992b33">attr_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__dataset__class__t.html">H5VL_dataset_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a38be37dc57b556f87df46b0ea65c9ae0">dataset_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__datatype__class__t.html">H5VL_datatype_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a49a73ac039550d87d60b485727149cce">datatype_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__file__class__t.html">H5VL_file_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a94fcae0c3e55fb9da64b99cf5ec0cc05">file_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__group__class__t.html">H5VL_group_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a6f9e6afe57118c01efbd5805d6f6615d">group_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__link__class__t.html">H5VL_link_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#a3da742717813fedde17f3ef9a739a3a5">link_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__object__class__t.html">H5VL_object_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#aee15298970b7178f78f92de98b7f8211">object_cls</a>; </div>
<div class="line"> <span class="comment">/* Infrastructure / Services */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__introspect__class__t.html">H5VL_introspect_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#aff81b23d1373b396d5eacda97bb4a6c6">introspect_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__request__class__t.html">H5VL_request_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#adc5afcdccffe9dc3608ac8e23e8fea17">request_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__blob__class__t.html">H5VL_blob_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#aee571d79753251a1d6ebc1073254278c">blob_cls</a>; </div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__token__class__t.html">H5VL_token_class_t</a> <a class="code hl_variable" href="struct_h5_v_l__class__t.html#acd39460513ffed8d7d3eab4ebab54bb2">token_cls</a>; </div>
<div class="line"> <span class="comment">/* Catch-all */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req); </div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a>;</div>
</div><!-- fragment --> </td></tr>
</table>
<p>The <em>version</em> field is the version of the <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct. This is identical to how the <em>version</em> field is used in the <a class="el" href="struct_h5_z__class2__t.html">H5Z_class2_t</a> struct for filters.</p>
<p>The <em>value</em> field is a unique integer identifier that should be between 512 and 65535 for external, non-library connectors.</p>
<p>The <em>name</em> field is a string that uniquely identifies the VOL connector name.</p>
<p>The <em>conn_version</em> is the connector version. This is currently not used by the library.</p>
<p>The <em>cap_flags</em> holds bitwise capability/feature flags that determine which operations and capabilities are supported by a the VOL connector. These fields were enumerated in the previous section.</p>
<p>The <em>initialize</em> field is a function pointer to a routine that a connector implements to set up or initialize access to the connector. Implementing this function by the connector is not required since some connectors do not require any set up to start accessing the connector. In that case, the value of the function pointer should be set to NULL. Connector specific variables that are required to be passed from users should be passed through the VOL initialize property list. Generic properties can be added to this property class for user-defined connectors that cannot modify the HDF5 library to add internal properties. For more information consult the property list reference manual pages.</p>
<p>The <em>terminate</em> field is a function pointer to a routine that a connector implements to terminate or finalize access to the connector. Implementing this function by the connector is not required since some connectors do not require any termination phase to the connector. In that case, the value of the function pointer should be set to NULL.</p>
<p>The rest of the fields in the <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct are "subclasses" that define all the VOL function callbacks that are mapped to from the HDF5 API layer. Those subclasses are categorized into three categories, VOL Framework, Data Model, and Infrastructure / Services.</p>
<p>VOL Framework classes provide functionality for working with the VOL connectors themselves (e.g., working with connector strings) and with wrapping and unwrapping objects for passthrough connectors.</p>
<p>Data Model classes are those that provide functionality for accessing an HDF5 container and objects in that container as defined by the HDF5 data model.</p>
<p>Infrastructure / Service classes are those that provide services for users that are not related to the data model specifically. Asynchronous operations, for example, are a service that most connectors can implement, so we add a class for it in the VOL structure.</p>
<p>If a service becomes generic enough and common among many connectors, a class for it should be added to the VOL structure. However, many connectors can/will provide services that are not shared by other connectors. A good way to support these services is through an optional callback in the VOL structure which can be a hook from the API to the connector that provides those services, passing any necessary arguments needed without the HDF5 library having to worry about supporting that service. A similar API operation to allow users to use that service will be added. This API call would be similar to an "ioctl" call where any kind of operation can be supported and passed down to the connector that has enough knowledge from the user to interpret the type of the operation. All classes and their defined callbacks will be detailed in the following sub-sections.</p>
<p>To handle that large set of API routines, each class in the Data Model category has three generic callbacks, <em>get</em>, <em>specific</em>, and <em>optional</em> to handle the three set of API operations outline above respectively. To handle the varying parameters that can be passed to the callback, each callback will take a struct parameter that includes an enum <em>get/specific</em> or integer <em>optional</em> field indicating the operation and a union of the possible parameters <em>get/specific</em> or void pointer to the parameters <em>optional</em>.</p>
<p>The optional args struct used for all optional operations: </p><div class="fragment"><div class="line"><span class="comment">// Struct for all 'optional' callbacks</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> {</div>
<div class="line"> <span class="keywordtype">int</span> <a class="code hl_variable" href="struct_h5_v_l__optional__args__t.html#a6ffc9648ceae4e1ae350df70f097d5f8">op_type</a>; <span class="comment">// Operation to perform</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__optional__args__t.html#add0eb34e0cef9e763462cf9080f9be0a">args</a>; <span class="comment">// Pointer to operation's argument struct</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__optional__args__t_html_a6ffc9648ceae4e1ae350df70f097d5f8"><div class="ttname"><a href="struct_h5_v_l__optional__args__t.html#a6ffc9648ceae4e1ae350df70f097d5f8">H5VL_optional_args_t::op_type</a></div><div class="ttdeci">int op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:95</div></div>
<div class="ttc" id="astruct_h5_v_l__optional__args__t_html_add0eb34e0cef9e763462cf9080f9be0a"><div class="ttname"><a href="struct_h5_v_l__optional__args__t.html#add0eb34e0cef9e763462cf9080f9be0a">H5VL_optional_args_t::args</a></div><div class="ttdeci">void * args</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:96</div></div>
</div><!-- fragment --><p>The <em>opt_type</em> member is the value assigned by the library when the optional operation was registered (or <em>defined</em> in the case of the native VOL connector) and the <em>args</em> member is a pointer to the optional operation's parameters (usually passed in as a struct).</p>
<p>Note that this differs from the HDF5 1.12.x scheme, which used <em>va_lists</em>.</p>
<p>The <em>optional</em> callback is a free for all callback where anything from the API layer is passed in directly. This callback is used to support connector specific operations in the API that other connectors should or would not know about. More information about types and the arguments for each type will be detailed in the corresponding class arguments.</p>
<h2><a class="anchor" id="subsecVOLRefMap"></a>
Mapping the API to the Callbacks</h2>
<p>The callback interface defined for the VOL has to be general enough to handle all the HDF5 API operations that would access the file. Furthermore, it has to capture future additions to the HDF5 library with little to no changes to the callback interface. Changing the interface often whenever new features are added would be discouraging to connector developers since that would mean reworking their VOL connector structure. To remedy this issue, every callback will contain two parameters: </p><ul>
<li>
A data transfer property list (DXPL) which allows that API to put some properties on for the connectors to retrieve if they have to for particular operations, without having to add arguments to the VOL callback function. </li>
<li>
A pointer to a request <em>(void **req)</em> to handle asynchronous operations if the HDF5 library adds support for them in future releases. hat pointer is set by the VOL connector to a request object it creates to manage progress on that asynchronous operation. If the <em>req</em> is <em>NULL</em>, that means that the API operation is blocking and so the connector would not execute the operation asynchronously. If the connector does not support asynchronous operations, it needs not to worry about this field and leaves it unset. </li>
</ul>
<p>In order to keep the number of the VOL object classes and callbacks concise and readable, it was decided not to have a one-to-one mapping between API operation and callbacks. The parameter names and types will be detailed when describing each callback in their respective sections.</p>
<p>The HDF5 library provides several routines to access an object in the container. For example, to open an attribute on a group object, the user could use <a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen</a> and pass the group identifier directly where the attribute needs to be opened. Alternatively, the user could use <a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name</a> or <a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx</a> to open the attribute, which provides a more flexible way of locating the attribute, whether by a starting object location and a path or an index type and traversal order. All those types of accesses usually map to one VOL callback with a parameter that indicates the access type. In the example of opening an attribute, the three API open routine will map to the same VOL open callback but with a different location parameter. The same applies to all types of routines that have multiple types of accesses. The location parameter is a structure defined in:</p>
<p><em>Structure to hold parameters for object locations, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// Structure to hold parameters for object locations.</span></div>
<div class="line"><span class="comment">// either: BY_SELF, BY_NAME, BY_IDX, BY_TOKEN</span></div>
<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_v_l__loc__params__t.html">H5VL_loc_params_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> <a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#a81030798b196a9008fdf5b6021205b20">obj_type</a>; <span class="comment">// The object type of the location object</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2">H5VL_loc_type_t</a> <a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#a83d3dcb9c6e66dabfd9e83536d086008">type</a>; <span class="comment">// The location type</span></div>
<div class="line"> <span class="keyword">union </span>{ <span class="comment">// parameters of the location</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__by__token__t.html">H5VL_loc_by_token_t</a> <a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#aa5a52c5b2a59a6b6b554d6c7c19ad563">loc_by_token</a>;</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__by__name__t.html">H5VL_loc_by_name_t</a> <a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#afe8fbe50a17945ba636392c3210ce0cb">loc_by_name</a>;</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__by__idx__t.html">H5VL_loc_by_idx_t</a> <a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#a0aac324bbf1f0c6f6d6f2e60f0817ad3">loc_by_idx</a>;</div>
<div class="line"> }<a class="code hl_variable" href="struct_h5_v_l__loc__params__t.html#a3f77a51b40d9a38bd89b3938f231854d">loc_data</a>;</div>
<div class="line"> } <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a></div>
<div class="line"> </div>
<div class="line"><span class="comment">//</span></div>
<div class="line"><span class="comment">// Types for different ways that objects are located in an</span></div>
<div class="line"><span class="comment">// HDF5 container.</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2">H5VL_loc_type_t</a> {</div>
<div class="line"> <span class="comment">// starting location is the target object</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a>,</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// location defined by object and path in H5VL_loc_by_name_t</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a>,</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// location defined by object, path, and index in H5VL_loc_by_idx_t</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a4e82e176436dfcd528f38d2e76863a1e">H5VL_OBJECT_BY_IDX</a>,</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// location defined by token (e.g. physical address) in H5VL_loc_by_token_t</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a3b5d0e8f4650eec59183b619174b46cd">H5VL_OBJECT_BY_TOKEN</a>,</div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2">H5VL_loc_type_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>H5VL_loc_by_name {</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name; <span class="comment">// The path relative to the starting location</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id; <span class="comment">// The link access property list</span></div>
<div class="line">}<a class="code hl_struct" href="struct_h5_v_l__loc__by__name__t.html">H5VL_loc_by_name_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>H5VL_loc_by_idx {</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name; <span class="comment">// The path relative to the starting location</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type; <span class="comment">// Type of index</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order; <span class="comment">// Index traversal order</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n; <span class="comment">// Position in index</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id; <span class="comment">// The link access property list</span></div>
<div class="line">}<a class="code hl_struct" href="struct_h5_v_l__loc__by__idx__t.html">H5VL_loc_by_idx_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>H5VL_loc_by_token {</div>
<div class="line"> <span class="keywordtype">void</span> *token; <span class="comment">// arbitrary token (physical address of location in native VOL)</span></div>
<div class="line">}<a class="code hl_struct" href="struct_h5_v_l__loc__by__token__t.html">H5VL_loc_by_token_t</a>;</div>
<div class="ttc" id="a_h5_ipublic_8h_html_a13afe14178faf81b89fa2167e7ab832b"><div class="ttname"><a href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a></div><div class="ttdeci">H5I_type_t</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:34</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a69fb5f76c678a35c3e7bae98c4f2c9f2"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2">H5VL_loc_type_t</a></div><div class="ttdeci">H5VL_loc_type_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:50</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a></div><div class="ttdeci">@ H5VL_OBJECT_BY_NAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:52</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a69fb5f76c678a35c3e7bae98c4f2c9f2a3b5d0e8f4650eec59183b619174b46cd"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a3b5d0e8f4650eec59183b619174b46cd">H5VL_OBJECT_BY_TOKEN</a></div><div class="ttdeci">@ H5VL_OBJECT_BY_TOKEN</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:54</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a69fb5f76c678a35c3e7bae98c4f2c9f2a4e82e176436dfcd528f38d2e76863a1e"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a4e82e176436dfcd528f38d2e76863a1e">H5VL_OBJECT_BY_IDX</a></div><div class="ttdeci">@ H5VL_OBJECT_BY_IDX</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:53</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a></div><div class="ttdeci">@ H5VL_OBJECT_BY_SELF</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:51</div></div>
<div class="ttc" id="a_h5public_8h_html_a6a6ddd1504d1ed61939d46d91d9441b9"><div class="ttname"><a href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></div><div class="ttdeci">H5_iter_order_t</div><div class="ttdef"><b>Definition</b> H5public.h:344</div></div>
<div class="ttc" id="a_h5public_8h_html_a7f81cce70fb546af88da24d9285d3c1c"><div class="ttname"><a href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></div><div class="ttdeci">uint64_t hsize_t</div><div class="ttdef"><b>Definition</b> H5public.h:297</div></div>
<div class="ttc" id="a_h5public_8h_html_a8203c78e10ab2d89d8bce688a31afad3"><div class="ttname"><a href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></div><div class="ttdeci">H5_index_t</div><div class="ttdef"><b>Definition</b> H5public.h:367</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__by__idx__t_html"><div class="ttname"><a href="struct_h5_v_l__loc__by__idx__t.html">H5VL_loc_by_idx_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:62</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__by__name__t_html"><div class="ttname"><a href="struct_h5_v_l__loc__by__name__t.html">H5VL_loc_by_name_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:57</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__by__token__t_html"><div class="ttname"><a href="struct_h5_v_l__loc__by__token__t.html">H5VL_loc_by_token_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:70</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:83</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_a0aac324bbf1f0c6f6d6f2e60f0817ad3"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#a0aac324bbf1f0c6f6d6f2e60f0817ad3">H5VL_loc_params_t::loc_by_idx</a></div><div class="ttdeci">H5VL_loc_by_idx_t loc_by_idx</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:89</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_a3f77a51b40d9a38bd89b3938f231854d"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#a3f77a51b40d9a38bd89b3938f231854d">H5VL_loc_params_t::loc_data</a></div><div class="ttdeci">union H5VL_loc_params_t::@27 loc_data</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_a81030798b196a9008fdf5b6021205b20"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#a81030798b196a9008fdf5b6021205b20">H5VL_loc_params_t::obj_type</a></div><div class="ttdeci">H5I_type_t obj_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:84</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_a83d3dcb9c6e66dabfd9e83536d086008"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#a83d3dcb9c6e66dabfd9e83536d086008">H5VL_loc_params_t::type</a></div><div class="ttdeci">H5VL_loc_type_t type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:85</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_aa5a52c5b2a59a6b6b554d6c7c19ad563"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#aa5a52c5b2a59a6b6b554d6c7c19ad563">H5VL_loc_params_t::loc_by_token</a></div><div class="ttdeci">H5VL_loc_by_token_t loc_by_token</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:87</div></div>
<div class="ttc" id="astruct_h5_v_l__loc__params__t_html_afe8fbe50a17945ba636392c3210ce0cb"><div class="ttname"><a href="struct_h5_v_l__loc__params__t.html#afe8fbe50a17945ba636392c3210ce0cb">H5VL_loc_params_t::loc_by_name</a></div><div class="ttdeci">H5VL_loc_by_name_t loc_by_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:88</div></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLRefConn"></a>
Connector Information Callbacks</h2>
<p>This section's callbacks involve the connector-specific information that will be associated with the VOL in the fapl via <b>H5Pset_fapl_<name></b> et al. This data is copied into the fapl so the library needs these functions to manage this in a way that prevents resource leaks.</p>
<p>The <em>to_str</em> and <em>from_str</em> callbacks are used to convert the connector-specific data to and from a configuration string. There is no official way to construct VOL configuration strings, so the format used (JSON, XML, getopt-style processing, etc.) is up to the connector author. These connector configuration strings can be used to set up a VOL connector via mechanisms like command-line parameters and environment variables.</p>
<p><em>Info class for connector information routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="comment">// VOL connector info fields & callbacks </span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__info__class__t.html">H5VL_info_class_t</a> {</div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__info__class__t.html#a854352f53b148adc24983a58a1866d66">size</a>; <span class="comment">// Size of the VOL info</span></div>
<div class="line"> <span class="keywordtype">void</span> *(*copy)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info); <span class="comment">// Callback to create a copy of the VOL info</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__info__class__t.html#ac9e6950dcb458c72df4857000306e4ea">cmp</a>)(<span class="keywordtype">int</span> *cmp_value, <span class="keyword">const</span> <span class="keywordtype">void</span> *info1, <span class="keyword">const</span> <span class="keywordtype">void</span> *info2); <span class="comment">// Callback to compare VOL info</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__info__class__t.html#aaef036b59719520efc816a744a158818">free</a>)(<span class="keywordtype">void</span> *info); <span class="comment">// Callback to release a VOL info</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__info__class__t.html#a9b52b286e232368e3c2a5846481d2d93">to_str</a>)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, <span class="keywordtype">char</span> **str); <span class="comment">// Callback to serialize connector's info into a string</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__info__class__t.html#a61855a9ef842935572f989e47be760bd">from_str</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, <span class="keywordtype">void</span> **info); <span class="comment">// Callback to deserialize a string into connector's info</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__info__class__t.html">H5VL_info_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html">H5VL_info_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:837</div></div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html_a61855a9ef842935572f989e47be760bd"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html#a61855a9ef842935572f989e47be760bd">H5VL_info_class_t::from_str</a></div><div class="ttdeci">herr_t(* from_str)(const char *str, void **info)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:843</div></div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html_a854352f53b148adc24983a58a1866d66"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html#a854352f53b148adc24983a58a1866d66">H5VL_info_class_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:838</div></div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html_a9b52b286e232368e3c2a5846481d2d93"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html#a9b52b286e232368e3c2a5846481d2d93">H5VL_info_class_t::to_str</a></div><div class="ttdeci">herr_t(* to_str)(const void *info, char **str)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:842</div></div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html_aaef036b59719520efc816a744a158818"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html#aaef036b59719520efc816a744a158818">H5VL_info_class_t::free</a></div><div class="ttdeci">herr_t(* free)(void *info)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:841</div></div>
<div class="ttc" id="astruct_h5_v_l__info__class__t_html_ac9e6950dcb458c72df4857000306e4ea"><div class="ttname"><a href="struct_h5_v_l__info__class__t.html#ac9e6950dcb458c72df4857000306e4ea">H5VL_info_class_t::cmp</a></div><div class="ttdeci">herr_t(* cmp)(int *cmp_value, const void *info1, const void *info2)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:840</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefConnsize"></a>
info: size</h3>
<p>The <em>size</em> field indicates the size required to store any special information that the connector needs.</p>
<p>If the connector requires no special information, set this field to zero. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">size_t</span> size;</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefConncopy"></a>
info: copy</h3>
<p>The <em>copy</em> callback is invoked when the connector is selected for use with <b>H5Pset_fapl_<name></b>, the connector-specific set call, etc. Where possible, the information should be deep copied in such a way that the original data can be freed. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> * (*copy)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">info (IN): The connector-specific info to copy.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefConncmp"></a>
info: cmp</h3>
<p>The <em>cmp</em> callback is used to determine if two connector-specific data structs are identical and helps the library manage connector resources. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*cmp)(<span class="keywordtype">int</span> *cmp_value, <span class="keyword">const</span> <span class="keywordtype">void</span> *info1, <span class="keyword">const</span> <span class="keywordtype">void</span> *info2);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">cmp_value (OUT): A strcmp-like compare value.</div>
<div class="line">info1 (IN): The 1st connector-specific info to copy.</div>
<div class="line">info2 (IN): The 2nd connector-specific info to copy.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefConnfree"></a>
info: free</h3>
<p>The <em>free</em> callback is used to clean up the connector-specific information that was copied when set in the fapl via the <em>copy</em> callback. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*free)(<span class="keywordtype">void</span> *info);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">info (IN): The connector-specific info to free.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefConnto"></a>
info: to_str</h3>
<p>The <em>to_str</em> callback converts a connector-specific information structure to a connector-specific configuration string. It is the opposite of the <em>from_str</em> callback. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*to_str)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, <span class="keywordtype">char</span> **str);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">info (IN): The connector-specific info to convert to a configuration string.</div>
<div class="line">str (OUT): The constructed configuration string.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefConnfrom"></a>
info: from_str</h3>
<p>The <em>from_str</em> callback converts a connector-specific configuration string to a connector-specific information structure. It is the opposite of the <em>to_str</em> callback. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*from_str)(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, <span class="keywordtype">void</span> **info);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">str (IN): The connector-specific configuration string.</div>
<div class="line">info (OUT): The connector-specific info generated from the configuration string.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefWrap"></a>
Object Wrap Callbacks</h2>
<p>The object wrap callbacks are used by passthrough connectors to wrap/unwrap objects and contexts when passing them up and down the VOL chain.</p>
<p><em>Wrap class for object wrapping routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__wrap__class__t.html">H5VL_wrap_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*get_object)(<span class="keyword">const</span> <span class="keywordtype">void</span> *obj); <span class="comment">// Callback to retrieve underlying object</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__wrap__class__t.html#a9fa016d5f49513d81a76662102129c02">get_wrap_ctx</a>)(<span class="keyword">const</span> <span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> **wrap_ctx); <span class="comment">// Callback to retrieve the object wrapping context for the connector</span></div>
<div class="line"> <span class="keywordtype">void</span> *(*wrap_object)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keywordtype">void</span> *wrap_ctx); <span class="comment">// Callback to wrap a library object</span></div>
<div class="line"> <span class="keywordtype">void</span> *(*unwrap_object)(<span class="keywordtype">void</span> *obj); <span class="comment">// Callback to unwrap a library object</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__wrap__class__t.html#a64eb31204961fce4a5e2d7a38f610e19">free_wrap_ctx</a>)(<span class="keywordtype">void</span> *wrap_ctx); <span class="comment">// Callback to release the object wrapping context for the connector</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__wrap__class__t.html">H5VL_wrap_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__wrap__class__t_html"><div class="ttname"><a href="struct_h5_v_l__wrap__class__t.html">H5VL_wrap_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:849</div></div>
<div class="ttc" id="astruct_h5_v_l__wrap__class__t_html_a64eb31204961fce4a5e2d7a38f610e19"><div class="ttname"><a href="struct_h5_v_l__wrap__class__t.html#a64eb31204961fce4a5e2d7a38f610e19">H5VL_wrap_class_t::free_wrap_ctx</a></div><div class="ttdeci">herr_t(* free_wrap_ctx)(void *wrap_ctx)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:857</div></div>
<div class="ttc" id="astruct_h5_v_l__wrap__class__t_html_a9fa016d5f49513d81a76662102129c02"><div class="ttname"><a href="struct_h5_v_l__wrap__class__t.html#a9fa016d5f49513d81a76662102129c02">H5VL_wrap_class_t::get_wrap_ctx</a></div><div class="ttdeci">herr_t(* get_wrap_ctx)(const void *obj, void **wrap_ctx)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:851</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefWrapobj"></a>
wrap: get_object</h3>
<p>Retrieves an underlying object. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> * (*get_object)(<span class="keyword">const</span> <span class="keywordtype">void</span> *obj);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Object being unwrapped.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefWrapctx"></a>
wrap: get_wrap_ctx</h3>
<p>Get a VOL connector's object wrapping context. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get_wrap_ctx)(<span class="keyword">const</span> <span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> **wrap_ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Object for which we need a context.</div>
<div class="line">wrap_ctx (OUT): Context.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefWrapwrap"></a>
wrap: wrap_object</h3>
<p>Asks a connector to wrap an underlying object. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> * (*wrap_object)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keywordtype">void</span> *wrap_ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Object being wrapped.</div>
<div class="line">obj_type (IN): Object type (see H5Ipublic.h).</div>
<div class="line">wrap_ctx (IN): Context.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefWrapunwrap"></a>
wrap: unwrap_object</h3>
<p>Unwrap an object from connector. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> * (*unwrap_object)(<span class="keywordtype">void</span> *obj);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Object being unwrapped.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefWrapfree"></a>
wrap: free_wrap_ctx</h3>
<p>Release a VOL connector's object wrapping context. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*free_wrap_ctx)(<span class="keywordtype">void</span> *wrap_ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">wrap_ctx (IN): Context to be freed.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefAttr"></a>
The Attribute Function Callbacks</h2>
<p>The attribute API routines (<a class="el" href="group___h5_a.html">Attributes (H5A)</a>) allow HDF5 users to create and manage HDF5 attributes. All the <a class="el" href="group___h5_a.html">Attributes (H5A)</a> API routines that modify the HDF5 container map to one of the attribute callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for attribute callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__class__t.html">H5VL_attr_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#a545cd43f5be5217d472e63c850309d1d">read</a>)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#a0fcaa82af4caaf3197036eaff5a23cb5">write</a>)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#ac18dc606174e4606dcfccfe7b9303272">get</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#a646b7141d2d0471d03190ddd82117a5c">specific</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__attr__class__t.html#a6994e0695e38d086ff5cb3b95a305bf1">close</a>)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__class__t.html">H5VL_attr_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html">H5VL_attr_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:862</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_a0fcaa82af4caaf3197036eaff5a23cb5"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#a0fcaa82af4caaf3197036eaff5a23cb5">H5VL_attr_class_t::write</a></div><div class="ttdeci">herr_t(* write)(void *attr, hid_t mem_type_id, const void *buf, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:868</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_a533cec569e2019874f02dd9552bcb68e"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#a533cec569e2019874f02dd9552bcb68e">H5VL_attr_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:872</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_a545cd43f5be5217d472e63c850309d1d"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#a545cd43f5be5217d472e63c850309d1d">H5VL_attr_class_t::read</a></div><div class="ttdeci">herr_t(* read)(void *attr, hid_t mem_type_id, void *buf, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:867</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_a646b7141d2d0471d03190ddd82117a5c"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#a646b7141d2d0471d03190ddd82117a5c">H5VL_attr_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_attr_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:870</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_a6994e0695e38d086ff5cb3b95a305bf1"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#a6994e0695e38d086ff5cb3b95a305bf1">H5VL_attr_class_t::close</a></div><div class="ttdeci">herr_t(* close)(void *attr, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:873</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__class__t_html_ac18dc606174e4606dcfccfe7b9303272"><div class="ttname"><a href="struct_h5_v_l__attr__class__t.html#ac18dc606174e4606dcfccfe7b9303272">H5VL_attr_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, H5VL_attr_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:869</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:125</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:184</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefAttrcreate"></a>
attr: create</h3>
<p>The <em>create</em> callback in the attribute class creates an attribute object in the container of the location object and returns a pointer to the attribute structure containing information to access the attribute in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the attribute needs to be created or where the look-up</div>
<div class="line"> of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">attr_name (IN): The name of the attribute to be created.</div>
<div class="line">type_id (IN): The datatype of the attribute.</div>
<div class="line">space_id (IN): The dataspace of the attribute.</div>
<div class="line">acpl_id (IN): The attribute creation property list.</div>
<div class="line">aapl_id (IN): The attribute access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefAttropen"></a>
attr: open</h3>
<p>The <em>open</em> callback in the attribute class opens an attribute object in the container of the location object and returns a pointer to the attribute structure containing information to access the attribute in future calls.</p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the attribute needs to be opened or where the look-up</div>
<div class="line"> of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">attr_name (IN): The name of the attribute to be opened.</div>
<div class="line">aapl_id (IN): The attribute access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefAttrread"></a>
attr: read</h3>
<p>The <em>read</em> callback in the attribute class reads data from the attribute object and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*read)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">attr (IN): Pointer to the attribute object.</div>
<div class="line">mem_type_id (IN): The memory datatype of the attribute.</div>
<div class="line">buf (OUT): Data buffer to be read into.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefAttrwrite"></a>
attr: write</h3>
<p>The <em>write</em> callback in the attribute class writes data to the attribute object and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*write)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">attr (IN): Pointer to the attribute object.</div>
<div class="line">mem_type_id (IN): The memory datatype of the attribute.</div>
<div class="line">buf (IN): Data buffer to be written.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefAttrget"></a>
attr: get</h3>
<p>The <em>get</em> callback in the attribute class retrieves information about the attribute as specified in the <em>get_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): An attribute or location object where information needs to be retrieved from.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for attribute 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386">H5VL_attr_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a28c828cecf474623e8e0103a1c03a119">H5VL_ATTR_GET_ACPL</a>, <span class="comment">/* creation property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a245c8729545d02ae0b9dcdf3598c17e2">H5VL_ATTR_GET_INFO</a>, <span class="comment">/* info */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a3566d35892e514ccab13b48725d6f6ef">H5VL_ATTR_GET_NAME</a>, <span class="comment">/* access property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a257bbe582665afa336fe112b78d5fdbc">H5VL_ATTR_GET_SPACE</a>, <span class="comment">/* dataspace */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386ab3ad72c306c4a1722505e4b1ad4a415a">H5VL_ATTR_GET_STORAGE_SIZE</a>, <span class="comment">/* storage size */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a02ea42f42ca98b712b63efb52aacbfd1">H5VL_ATTR_GET_TYPE</a> <span class="comment">/* datatype */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386">H5VL_attr_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'get_name' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__get__name__args__t.html">H5VL_attr_get_name_args_t</a> {</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__name__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">loc_params</a>; <span class="comment">/* Location parameters for object access */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__attr__get__name__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of attribute name buffer */</span></div>
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__get__name__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">buf</a>; <span class="comment">/* Buffer for attribute name (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__get__name__args__t.html#af5465ff35213cc3d895523392f07f8fe">attr_name_len</a>; <span class="comment">/* Actual length of attribute name (OUT) */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__get__name__args__t.html">H5VL_attr_get_name_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'get_info' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__get__info__args__t.html">H5VL_attr_get_info_args_t</a> {</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__info__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">loc_params</a>; <span class="comment">/* Location parameters for object access */</span></div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__get__info__args__t.html#a7f2b640f7bd6d1c0a810c2824ad056c7">attr_name</a>; <span class="comment">/* Attribute name (for get_info_by_name) */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_a__info__t.html">H5A_info_t</a> *<a class="code hl_variable" href="struct_h5_v_l__attr__get__info__args__t.html#a2075ca161c7fd1ed39ca4ec2dbec1c20">ainfo</a>; <span class="comment">/* Attribute info (OUT) */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__get__info__args__t.html">H5VL_attr_get_info_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386">H5VL_attr_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a267792a7407e0ff0dfc9b5c1da575117">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_ACPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#ac7e3d57f1868bfe6b8f56f985d94b487">acpl_id</a>; <span class="comment">/* Attribute creation property list ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#ad7e16391814870c0389eab6ec2ade96b">get_acpl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_INFO */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__get__info__args__t.html">H5VL_attr_get_info_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a2fcdf813baa9148a32e271131bb4cc3a">get_info</a>; <span class="comment">/* Attribute info */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_NAME */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__get__name__args__t.html">H5VL_attr_get_name_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#afa0c39c2b18a3edc59ba82462fc1450d">get_name</a>; <span class="comment">/* Attribute name */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_SPACE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a0327c24b4b50fe1c105339cb7ce599ab">space_id</a>; <span class="comment">/* Dataspace ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#ae48ebd10064843595f2a96c762db5d1d">get_space</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_STORAGE_SIZE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *<a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a5817cccb2c952f74883ddea00bc999b4">data_size</a>; <span class="comment">/* Size of attribute in file (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#af94b24bf62fdc285263bd890e89d6e5f">get_storage_size</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_GET_TYPE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">type_id</a>; <span class="comment">/* Datatype ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a8d329aec7090fb674c6b035ded4b9825">get_type</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__get__args__t.html#a703117f68fc3599cf847d17d58ddb8ca">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386">H5VL_attr_get_t</a></div><div class="ttdeci">H5VL_attr_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:100</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386a02ea42f42ca98b712b63efb52aacbfd1"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a02ea42f42ca98b712b63efb52aacbfd1">H5VL_ATTR_GET_TYPE</a></div><div class="ttdeci">@ H5VL_ATTR_GET_TYPE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:106</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386a245c8729545d02ae0b9dcdf3598c17e2"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a245c8729545d02ae0b9dcdf3598c17e2">H5VL_ATTR_GET_INFO</a></div><div class="ttdeci">@ H5VL_ATTR_GET_INFO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:102</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386a257bbe582665afa336fe112b78d5fdbc"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a257bbe582665afa336fe112b78d5fdbc">H5VL_ATTR_GET_SPACE</a></div><div class="ttdeci">@ H5VL_ATTR_GET_SPACE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:104</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386a28c828cecf474623e8e0103a1c03a119"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a28c828cecf474623e8e0103a1c03a119">H5VL_ATTR_GET_ACPL</a></div><div class="ttdeci">@ H5VL_ATTR_GET_ACPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:101</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386a3566d35892e514ccab13b48725d6f6ef"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386a3566d35892e514ccab13b48725d6f6ef">H5VL_ATTR_GET_NAME</a></div><div class="ttdeci">@ H5VL_ATTR_GET_NAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:103</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab1ca6e780261f54b22ab29df7db17386ab3ad72c306c4a1722505e4b1ad4a415a"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab1ca6e780261f54b22ab29df7db17386ab3ad72c306c4a1722505e4b1ad4a415a">H5VL_ATTR_GET_STORAGE_SIZE</a></div><div class="ttdeci">@ H5VL_ATTR_GET_STORAGE_SIZE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:105</div></div>
<div class="ttc" id="astruct_h5_a__info__t_html"><div class="ttname"><a href="struct_h5_a__info__t.html">H5A_info_t</a></div><div class="ttdef"><b>Definition</b> H5Apublic.h:28</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a0327c24b4b50fe1c105339cb7ce599ab"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a0327c24b4b50fe1c105339cb7ce599ab">H5VL_attr_get_args_t::space_id</a></div><div class="ttdeci">hid_t space_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:143</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a267792a7407e0ff0dfc9b5c1da575117"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a267792a7407e0ff0dfc9b5c1da575117">H5VL_attr_get_args_t::op_type</a></div><div class="ttdeci">H5VL_attr_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:126</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a2fcdf813baa9148a32e271131bb4cc3a"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a2fcdf813baa9148a32e271131bb4cc3a">H5VL_attr_get_args_t::get_info</a></div><div class="ttdeci">H5VL_attr_get_info_args_t get_info</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:136</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a5817cccb2c952f74883ddea00bc999b4"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a5817cccb2c952f74883ddea00bc999b4">H5VL_attr_get_args_t::data_size</a></div><div class="ttdeci">hsize_t * data_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:148</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a703117f68fc3599cf847d17d58ddb8ca"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a703117f68fc3599cf847d17d58ddb8ca">H5VL_attr_get_args_t::args</a></div><div class="ttdeci">union H5VL_attr_get_args_t::@28 args</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a89fbb59cdf681f79816c5cab69c5dbac"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">H5VL_attr_get_args_t::type_id</a></div><div class="ttdeci">hid_t type_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:153</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_a8d329aec7090fb674c6b035ded4b9825"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#a8d329aec7090fb674c6b035ded4b9825">H5VL_attr_get_args_t::get_type</a></div><div class="ttdeci">struct H5VL_attr_get_args_t::@28::@32 get_type</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_ac7e3d57f1868bfe6b8f56f985d94b487"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#ac7e3d57f1868bfe6b8f56f985d94b487">H5VL_attr_get_args_t::acpl_id</a></div><div class="ttdeci">hid_t acpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:132</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_ad7e16391814870c0389eab6ec2ade96b"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#ad7e16391814870c0389eab6ec2ade96b">H5VL_attr_get_args_t::get_acpl</a></div><div class="ttdeci">struct H5VL_attr_get_args_t::@28::@29 get_acpl</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_ae48ebd10064843595f2a96c762db5d1d"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#ae48ebd10064843595f2a96c762db5d1d">H5VL_attr_get_args_t::get_space</a></div><div class="ttdeci">struct H5VL_attr_get_args_t::@28::@30 get_space</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_af94b24bf62fdc285263bd890e89d6e5f"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#af94b24bf62fdc285263bd890e89d6e5f">H5VL_attr_get_args_t::get_storage_size</a></div><div class="ttdeci">struct H5VL_attr_get_args_t::@28::@31 get_storage_size</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__args__t_html_afa0c39c2b18a3edc59ba82462fc1450d"><div class="ttname"><a href="struct_h5_v_l__attr__get__args__t.html#afa0c39c2b18a3edc59ba82462fc1450d">H5VL_attr_get_args_t::get_name</a></div><div class="ttdeci">H5VL_attr_get_name_args_t get_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:139</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__info__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__get__info__args__t.html">H5VL_attr_get_info_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:118</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__info__args__t_html_a2075ca161c7fd1ed39ca4ec2dbec1c20"><div class="ttname"><a href="struct_h5_v_l__attr__get__info__args__t.html#a2075ca161c7fd1ed39ca4ec2dbec1c20">H5VL_attr_get_info_args_t::ainfo</a></div><div class="ttdeci">H5A_info_t * ainfo</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:121</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__info__args__t_html_a5bf5017b0f72740c83ee50b1ee3023ad"><div class="ttname"><a href="struct_h5_v_l__attr__get__info__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">H5VL_attr_get_info_args_t::loc_params</a></div><div class="ttdeci">H5VL_loc_params_t loc_params</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:119</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__info__args__t_html_a7f2b640f7bd6d1c0a810c2824ad056c7"><div class="ttname"><a href="struct_h5_v_l__attr__get__info__args__t.html#a7f2b640f7bd6d1c0a810c2824ad056c7">H5VL_attr_get_info_args_t::attr_name</a></div><div class="ttdeci">const char * attr_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:120</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__name__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__get__name__args__t.html">H5VL_attr_get_name_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:110</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__name__args__t_html_a1fe855c208bc17a51a4d34fefdb2d5b1"><div class="ttname"><a href="struct_h5_v_l__attr__get__name__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">H5VL_attr_get_name_args_t::buf</a></div><div class="ttdeci">char * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:113</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__name__args__t_html_a5bf5017b0f72740c83ee50b1ee3023ad"><div class="ttname"><a href="struct_h5_v_l__attr__get__name__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">H5VL_attr_get_name_args_t::loc_params</a></div><div class="ttdeci">H5VL_loc_params_t loc_params</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:111</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__name__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__attr__get__name__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_attr_get_name_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:112</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__get__name__args__t_html_af5465ff35213cc3d895523392f07f8fe"><div class="ttname"><a href="struct_h5_v_l__attr__get__name__args__t.html#af5465ff35213cc3d895523392f07f8fe">H5VL_attr_get_name_args_t::attr_name_len</a></div><div class="ttdeci">size_t * attr_name_len</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:114</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefAttrspec"></a>
attr: specific</h3>
<p>The <em>specific</em> callback in the attribute class implements specific operations on HDF5 attributes as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The location object where the operation needs to happen.</div>
<div class="line">loc_params (IN): A pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for attribute 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1">H5VL_attr_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1ae01237a4f14a54465e5a3a04f18a5c1d">H5VL_ATTR_DELETE</a>, <span class="comment">/* H5Adelete(_by_name) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1acd8869b073aceaa7a843d5d8bbf23e6b">H5VL_ATTR_DELETE_BY_IDX</a>, <span class="comment">/* H5Adelete_by_idx */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1a4c65cce04f97b2affbd8cb27b3161a04">H5VL_ATTR_EXISTS</a>, <span class="comment">/* H5Aexists(_by_name) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1ab28ca25824a3879d755db3845f70ccad">H5VL_ATTR_ITER</a>, <span class="comment">/* H5Aiterate(_by_name) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1a6d0e93c4d1a0c4bd45211d7e0b262269">H5VL_ATTR_RENAME</a> <span class="comment">/* H5Arename(_by_name) */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1">H5VL_attr_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'iterate' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__iterate__args__t.html">H5VL_attr_iterate_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__iterate__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">idx_type</a>; <span class="comment">/* Type of index to iterate over */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__iterate__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">order</a>; <span class="comment">/* Order of index iteration */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *<a class="code hl_variable" href="struct_h5_v_l__attr__iterate__args__t.html#a88b05afb3975738c182e83d77fd6c21d">idx</a>; <span class="comment">/* Start/stop iteration index (IN/OUT) */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__iterate__args__t.html#afc42db8786ce730626f2ef7190e86fb6">op</a>; <span class="comment">/* Iteration callback function */</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__iterate__args__t.html#aa1649fef45b8c728cf110597e5d51f45">op_data</a>; <span class="comment">/* Iteration callback context */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__iterate__args__t.html">H5VL_attr_iterate_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'delete_by_idx' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__delete__by__idx__args__t.html">H5VL_attr_delete_by_idx_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__delete__by__idx__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">idx_type</a>; <span class="comment">/* Type of index to iterate over */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__delete__by__idx__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">order</a>; <span class="comment">/* Order of index iteration */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__delete__by__idx__args__t.html#a615b5c028cce1e117eae499a06a51663">n</a>; <span class="comment">/* Iteration index */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__delete__by__idx__args__t.html">H5VL_attr_delete_by_idx_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for attribute 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1">H5VL_attr_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#ad5e60d51e3bf80f56ba3b895236f8d08">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_ATTR_DELETE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>; <span class="comment">/* Name of attribute to delete */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a4d4a7801079fcbe6f4160c8a0f2258b6">del</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_DELETE_BY_IDX */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__delete__by__idx__args__t.html">H5VL_attr_delete_by_idx_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a7d81e7a1bc7fc97abf5547985104f136">delete_by_idx</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_EXISTS */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>; <span class="comment">/* Name of attribute to check */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>; <span class="comment">/* Whether attribute exists (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_ITER */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__iterate__args__t.html">H5VL_attr_iterate_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a9f8d2ff2f716d444e4e42eed10ec2c04">iterate</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_ATTR_RENAME */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a242c1437f4a5d06f640fa56f1441b808">old_name</a>; <span class="comment">/* Name of attribute to rename */</span></div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#aa7bc4190119c5ebb025fe673fe7b198b">new_name</a>; <span class="comment">/* New attribute name */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a6faf9b5ab465fcb6007773527683ec3b">rename</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__attr__specific__args__t.html#a4b4baf2bc646c404bef0124c709e6247">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_apublic_8h_html_a28fef0ded9a6c0eb12334c0d15dc3e74"><div class="ttname"><a href="_h5_apublic_8h.html#a28fef0ded9a6c0eb12334c0d15dc3e74">H5A_operator2_t</a></div><div class="ttdeci">herr_t(* H5A_operator2_t)(hid_t location_id, const char *attr_name, const H5A_info_t *ainfo, void *op_data)</div><div class="ttdef"><b>Definition</b> H5Apublic.h:55</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1">H5VL_attr_specific_t</a></div><div class="ttdeci">H5VL_attr_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:159</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1a4c65cce04f97b2affbd8cb27b3161a04"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1a4c65cce04f97b2affbd8cb27b3161a04">H5VL_ATTR_EXISTS</a></div><div class="ttdeci">@ H5VL_ATTR_EXISTS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:162</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1a6d0e93c4d1a0c4bd45211d7e0b262269"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1a6d0e93c4d1a0c4bd45211d7e0b262269">H5VL_ATTR_RENAME</a></div><div class="ttdeci">@ H5VL_ATTR_RENAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:164</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1ab28ca25824a3879d755db3845f70ccad"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1ab28ca25824a3879d755db3845f70ccad">H5VL_ATTR_ITER</a></div><div class="ttdeci">@ H5VL_ATTR_ITER</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:163</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1acd8869b073aceaa7a843d5d8bbf23e6b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1acd8869b073aceaa7a843d5d8bbf23e6b">H5VL_ATTR_DELETE_BY_IDX</a></div><div class="ttdeci">@ H5VL_ATTR_DELETE_BY_IDX</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:161</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab8f6ab518f80d1afedd8b16ac3454ac1ae01237a4f14a54465e5a3a04f18a5c1d"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab8f6ab518f80d1afedd8b16ac3454ac1ae01237a4f14a54465e5a3a04f18a5c1d">H5VL_ATTR_DELETE</a></div><div class="ttdeci">@ H5VL_ATTR_DELETE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:160</div></div>
<div class="ttc" id="a_h5public_8h_html_ad470b00eccd2115c707c02de5fa1120d"><div class="ttname"><a href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></div><div class="ttdeci">bool hbool_t</div><div class="ttdef"><b>Definition</b> H5public.h:249</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__delete__by__idx__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__delete__by__idx__args__t.html">H5VL_attr_delete_by_idx_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:177</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__delete__by__idx__args__t_html_a15b19bb0dea4b247157e6f62850ec7a0"><div class="ttname"><a href="struct_h5_v_l__attr__delete__by__idx__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">H5VL_attr_delete_by_idx_args_t::idx_type</a></div><div class="ttdeci">H5_index_t idx_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:178</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__delete__by__idx__args__t_html_a615b5c028cce1e117eae499a06a51663"><div class="ttname"><a href="struct_h5_v_l__attr__delete__by__idx__args__t.html#a615b5c028cce1e117eae499a06a51663">H5VL_attr_delete_by_idx_args_t::n</a></div><div class="ttdeci">hsize_t n</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:180</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__delete__by__idx__args__t_html_aab445f1d17ed2d51e4ae4a268b1742bb"><div class="ttname"><a href="struct_h5_v_l__attr__delete__by__idx__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">H5VL_attr_delete_by_idx_args_t::order</a></div><div class="ttdeci">H5_iter_order_t order</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:179</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html">H5VL_attr_iterate_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:168</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html_a15b19bb0dea4b247157e6f62850ec7a0"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">H5VL_attr_iterate_args_t::idx_type</a></div><div class="ttdeci">H5_index_t idx_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:169</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html_a88b05afb3975738c182e83d77fd6c21d"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html#a88b05afb3975738c182e83d77fd6c21d">H5VL_attr_iterate_args_t::idx</a></div><div class="ttdeci">hsize_t * idx</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:171</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html_aa1649fef45b8c728cf110597e5d51f45"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html#aa1649fef45b8c728cf110597e5d51f45">H5VL_attr_iterate_args_t::op_data</a></div><div class="ttdeci">void * op_data</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:173</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html_aab445f1d17ed2d51e4ae4a268b1742bb"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">H5VL_attr_iterate_args_t::order</a></div><div class="ttdeci">H5_iter_order_t order</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:170</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__iterate__args__t_html_afc42db8786ce730626f2ef7190e86fb6"><div class="ttname"><a href="struct_h5_v_l__attr__iterate__args__t.html#afc42db8786ce730626f2ef7190e86fb6">H5VL_attr_iterate_args_t::op</a></div><div class="ttdeci">H5A_operator2_t op</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:172</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a242c1437f4a5d06f640fa56f1441b808"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a242c1437f4a5d06f640fa56f1441b808">H5VL_attr_specific_args_t::old_name</a></div><div class="ttdeci">const char * old_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:208</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a4b4baf2bc646c404bef0124c709e6247"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a4b4baf2bc646c404bef0124c709e6247">H5VL_attr_specific_args_t::args</a></div><div class="ttdeci">union H5VL_attr_specific_args_t::@33 args</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a4d4a7801079fcbe6f4160c8a0f2258b6"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a4d4a7801079fcbe6f4160c8a0f2258b6">H5VL_attr_specific_args_t::del</a></div><div class="ttdeci">struct H5VL_attr_specific_args_t::@33::@34 del</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a6faf9b5ab465fcb6007773527683ec3b"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a6faf9b5ab465fcb6007773527683ec3b">H5VL_attr_specific_args_t::rename</a></div><div class="ttdeci">struct H5VL_attr_specific_args_t::@33::@36 rename</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a7d81e7a1bc7fc97abf5547985104f136"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a7d81e7a1bc7fc97abf5547985104f136">H5VL_attr_specific_args_t::delete_by_idx</a></div><div class="ttdeci">H5VL_attr_delete_by_idx_args_t delete_by_idx</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:195</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a8f8f80d37794cde9472343e4487ba3eb"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">H5VL_attr_specific_args_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:191</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_a9f8d2ff2f716d444e4e42eed10ec2c04"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#a9f8d2ff2f716d444e4e42eed10ec2c04">H5VL_attr_specific_args_t::iterate</a></div><div class="ttdeci">H5VL_attr_iterate_args_t iterate</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:204</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_aa7bc4190119c5ebb025fe673fe7b198b"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#aa7bc4190119c5ebb025fe673fe7b198b">H5VL_attr_specific_args_t::new_name</a></div><div class="ttdeci">const char * new_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:209</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_ad5e60d51e3bf80f56ba3b895236f8d08"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#ad5e60d51e3bf80f56ba3b895236f8d08">H5VL_attr_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_attr_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:185</div></div>
<div class="ttc" id="astruct_h5_v_l__attr__specific__args__t_html_add8bec1c37b33ec46a87709a31b07e3e"><div class="ttname"><a href="struct_h5_v_l__attr__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">H5VL_attr_specific_args_t::exists</a></div><div class="ttdeci">hbool_t * exists</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:200</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefAttropt"></a>
attr: optional</h3>
<p>The <em>optional</em> callback in the attribute class implements connector specific operations on an HDF5 attribute. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefAttrclose"></a>
attr: close</h3>
<p>The <em>close</em> callback in the attribute class terminates access to the attribute object and free all resources it was consuming, and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*close)(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">attr (IN): Pointer to the attribute object.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefDset"></a>
Dataset Callbacks</h2>
<p>The dataset API routines (<a class="el" href="group___h5_d.html">Datasets (H5D)</a>) allow HDF5 users to create and manage HDF5 datasets. All the <a class="el" href="group___h5_d.html">Datasets (H5D)</a> API routines that modify the HDF5 container map to one of the dataset callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for dataset callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__dataset__class__t.html">H5VL_dataset_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#a7eb6727202a2bfc21d35d1de2d9752e2">read</a>)(<span class="keywordtype">size_t</span> count, <span class="keywordtype">void</span> *dset[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id[],</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> *buf[], <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#a85ef69e00e7fa8389d5e021a5a4b5d09">write</a>)(<span class="keywordtype">size_t</span> count, <span class="keywordtype">void</span> *dset[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id[],</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf[], <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#a90742926de704a6829c191ab19b4b422">get</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#af88a7553cd7b00f16a2a293b4f441a21">specific</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__dataset__specific__args__t.html">H5VL_dataset_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__dataset__class__t.html#a6d5c8d0bd557911bbb792caa52c1a4c1">close</a>)(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__dataset__class__t.html">H5VL_dataset_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html">H5VL_dataset_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:877</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_a533cec569e2019874f02dd9552bcb68e"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#a533cec569e2019874f02dd9552bcb68e">H5VL_dataset_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:888</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_a6d5c8d0bd557911bbb792caa52c1a4c1"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#a6d5c8d0bd557911bbb792caa52c1a4c1">H5VL_dataset_class_t::close</a></div><div class="ttdeci">herr_t(* close)(void *dset, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:889</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_a7eb6727202a2bfc21d35d1de2d9752e2"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#a7eb6727202a2bfc21d35d1de2d9752e2">H5VL_dataset_class_t::read</a></div><div class="ttdeci">herr_t(* read)(size_t count, void *dset[], hid_t mem_type_id[], hid_t mem_space_id[], hid_t file_space_id[], hid_t dxpl_id, void *buf[], void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:882</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_a85ef69e00e7fa8389d5e021a5a4b5d09"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#a85ef69e00e7fa8389d5e021a5a4b5d09">H5VL_dataset_class_t::write</a></div><div class="ttdeci">herr_t(* write)(size_t count, void *dset[], hid_t mem_type_id[], hid_t mem_space_id[], hid_t file_space_id[], hid_t dxpl_id, const void *buf[], void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:884</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_a90742926de704a6829c191ab19b4b422"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#a90742926de704a6829c191ab19b4b422">H5VL_dataset_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, H5VL_dataset_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:886</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__class__t_html_af88a7553cd7b00f16a2a293b4f441a21"><div class="ttname"><a href="struct_h5_v_l__dataset__class__t.html#af88a7553cd7b00f16a2a293b4f441a21">H5VL_dataset_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, H5VL_dataset_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:887</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:228</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html">H5VL_dataset_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:273</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDsetcreate"></a>
dataset: create</h3>
<p>The <em>create</em> callback in the dataset class creates a dataset object in the container of the location object and returns a pointer to the dataset structure containing information to access the dataset in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the dataset needs to be created or where the look-up of</div>
<div class="line"> the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">name (IN): The name of the dataset to be created.</div>
<div class="line">lcpl_id (IN): The link creation property list.</div>
<div class="line">type_id (IN): The datatype of the dataset.</div>
<div class="line">space_id (IN): The dataspace of the dataset.</div>
<div class="line">dcpl_id (IN): The dataset creation property list.</div>
<div class="line">dapl_id (IN): The dataset access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDsetopen"></a>
dataset: open</h3>
<p>The <em>open</em> callback in the dataset class opens a dataset object in the container of the location object and returns a pointer to the dataset structure containing information to access the dataset in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the dataset needs to be opened or where the look-up of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">name (IN): The name of the dataset to be opened.</div>
<div class="line">dapl_id (IN): The dataset access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDsetread"></a>
dataset: read</h3>
<p>The <em>read</em> callback in the dataset class reads data from the dataset object and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*read)(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> *buf, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">dset (IN): Pointer to the dataset object.</div>
<div class="line">mem_type_id (IN): The memory datatype of the data.</div>
<div class="line">mem_space_id (IN): The memory dataspace selection.</div>
<div class="line">file_space_id (IN): The file dataspace selection.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">buf (OUT): Data buffer to be read into.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDsetwrite"></a>
dataset: write</h3>
<p>The <em>write</em> callback in the dataset class writes data to the dataset object and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*write)(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">dset (IN): Pointer to the dataset object.</div>
<div class="line">mem_type_id (IN): The memory datatype of the data.</div>
<div class="line">mem_space_id (IN): The memory dataspace selection.</div>
<div class="line">file_space_id (IN): The file dataspace selection.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">buf (IN): Data buffer to be written from.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDsetget"></a>
dataset: get</h3>
<p>The <em>get</em> callback in the dataset class retrieves information about the dataset as specified in the <em>get_type</em> parameter.It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *dset, <a class="code hl_struct" href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">dset (IN): The dataset object where information needs to be retrieved from.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for dataset 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372">H5VL_dataset_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a04105bc0c224fc85120a6794b1141211">H5VL_DATASET_GET_DAPL</a>, <span class="comment">/* access property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a5c35e81f46b4a93c0efc89e2a0b97550">H5VL_DATASET_GET_DCPL</a>, <span class="comment">/* creation property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a31d5a7839c3c4ece749c4d4b5e5f2ea9">H5VL_DATASET_GET_SPACE</a>, <span class="comment">/* dataspace */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a7514a11451c7d583ac8a247e36e62906">H5VL_DATASET_GET_SPACE_STATUS</a>, <span class="comment">/* space status */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a64752afc213ac4e5fe4d954b78442adc">H5VL_DATASET_GET_STORAGE_SIZE</a>, <span class="comment">/* storage size */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372aa83d7cc17db73e5eb310687f3e2d3a9f">H5VL_DATASET_GET_TYPE</a> <span class="comment">/* datatype */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372">H5VL_dataset_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for dataset 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372">H5VL_dataset_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#acc2d43af01dd0431426e99cb3b7058d2">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_DAPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#a6ee841fff797bec3dab658a3e113b747">dapl_id</a>; <span class="comment">/* Dataset access property list ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#aff38c9cfb0ec5d3400e0c0a6c2742a85">get_dapl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_DCPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#a3b10a61cf12d9536d1d91ae50313a5da">dcpl_id</a>; <span class="comment">/* Dataset creation property list ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#ae537368b3049ece68266be2ea6ba32bb">get_dcpl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_SPACE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#a0327c24b4b50fe1c105339cb7ce599ab">space_id</a>; <span class="comment">/* Dataspace ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#ab778c5feb4108802778b5d20c6db62c4">get_space</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_SPACE_STATUS */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_dpublic_8h.html#a28e60d50e4eaeef27130829f66e39c7a">H5D_space_status_t</a> *<a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#add2a21e9cdd0ea1b51f4956858b999d5">status</a>; <span class="comment">/* Storage space allocation status (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#a3cb52af56ecf36f1befb870c6955e75b">get_space_status</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_STORAGE_SIZE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *<a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#aa1b9b69e3b88a073d07acbd7a2a96f31">storage_size</a>; <span class="comment">/* Size of dataset's storage (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#adaa9d8418b0914e1d2056b0c2bc6655b">get_storage_size</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_GET_TYPE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">type_id</a>; <span class="comment">/* Datatype ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#aa47b9fb3cb3dc61544dca0450ec2c413">get_type</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__get__args__t.html#ae44c1fcd9d4064c117ebd48176b52f4b">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a>;</div>
<div class="ttc" id="a_h5_dpublic_8h_html_a28e60d50e4eaeef27130829f66e39c7a"><div class="ttname"><a href="_h5_dpublic_8h.html#a28e60d50e4eaeef27130829f66e39c7a">H5D_space_status_t</a></div><div class="ttdeci">H5D_space_status_t</div><div class="ttdef"><b>Definition</b> H5Dpublic.h:87</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372">H5VL_dataset_get_t</a></div><div class="ttdeci">H5VL_dataset_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:218</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372a04105bc0c224fc85120a6794b1141211"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a04105bc0c224fc85120a6794b1141211">H5VL_DATASET_GET_DAPL</a></div><div class="ttdeci">@ H5VL_DATASET_GET_DAPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:219</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372a31d5a7839c3c4ece749c4d4b5e5f2ea9"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a31d5a7839c3c4ece749c4d4b5e5f2ea9">H5VL_DATASET_GET_SPACE</a></div><div class="ttdeci">@ H5VL_DATASET_GET_SPACE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:221</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372a5c35e81f46b4a93c0efc89e2a0b97550"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a5c35e81f46b4a93c0efc89e2a0b97550">H5VL_DATASET_GET_DCPL</a></div><div class="ttdeci">@ H5VL_DATASET_GET_DCPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:220</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372a64752afc213ac4e5fe4d954b78442adc"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a64752afc213ac4e5fe4d954b78442adc">H5VL_DATASET_GET_STORAGE_SIZE</a></div><div class="ttdeci">@ H5VL_DATASET_GET_STORAGE_SIZE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:223</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372a7514a11451c7d583ac8a247e36e62906"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372a7514a11451c7d583ac8a247e36e62906">H5VL_DATASET_GET_SPACE_STATUS</a></div><div class="ttdeci">@ H5VL_DATASET_GET_SPACE_STATUS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:222</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab4c18c2151788eaae8f602f4f1b9c372aa83d7cc17db73e5eb310687f3e2d3a9f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab4c18c2151788eaae8f602f4f1b9c372aa83d7cc17db73e5eb310687f3e2d3a9f">H5VL_DATASET_GET_TYPE</a></div><div class="ttdeci">@ H5VL_DATASET_GET_TYPE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:224</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_a0327c24b4b50fe1c105339cb7ce599ab"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#a0327c24b4b50fe1c105339cb7ce599ab">H5VL_dataset_get_args_t::space_id</a></div><div class="ttdeci">hid_t space_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:245</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_a3b10a61cf12d9536d1d91ae50313a5da"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#a3b10a61cf12d9536d1d91ae50313a5da">H5VL_dataset_get_args_t::dcpl_id</a></div><div class="ttdeci">hid_t dcpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:240</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_a3cb52af56ecf36f1befb870c6955e75b"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#a3cb52af56ecf36f1befb870c6955e75b">H5VL_dataset_get_args_t::get_space_status</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@41 get_space_status</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_a6ee841fff797bec3dab658a3e113b747"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#a6ee841fff797bec3dab658a3e113b747">H5VL_dataset_get_args_t::dapl_id</a></div><div class="ttdeci">hid_t dapl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:235</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_a89fbb59cdf681f79816c5cab69c5dbac"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">H5VL_dataset_get_args_t::type_id</a></div><div class="ttdeci">hid_t type_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:260</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_aa1b9b69e3b88a073d07acbd7a2a96f31"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#aa1b9b69e3b88a073d07acbd7a2a96f31">H5VL_dataset_get_args_t::storage_size</a></div><div class="ttdeci">hsize_t * storage_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:255</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_aa47b9fb3cb3dc61544dca0450ec2c413"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#aa47b9fb3cb3dc61544dca0450ec2c413">H5VL_dataset_get_args_t::get_type</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@43 get_type</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_ab778c5feb4108802778b5d20c6db62c4"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#ab778c5feb4108802778b5d20c6db62c4">H5VL_dataset_get_args_t::get_space</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@40 get_space</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_acc2d43af01dd0431426e99cb3b7058d2"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#acc2d43af01dd0431426e99cb3b7058d2">H5VL_dataset_get_args_t::op_type</a></div><div class="ttdeci">H5VL_dataset_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:229</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_adaa9d8418b0914e1d2056b0c2bc6655b"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#adaa9d8418b0914e1d2056b0c2bc6655b">H5VL_dataset_get_args_t::get_storage_size</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@42 get_storage_size</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_add2a21e9cdd0ea1b51f4956858b999d5"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#add2a21e9cdd0ea1b51f4956858b999d5">H5VL_dataset_get_args_t::status</a></div><div class="ttdeci">H5D_space_status_t * status</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:250</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_ae44c1fcd9d4064c117ebd48176b52f4b"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#ae44c1fcd9d4064c117ebd48176b52f4b">H5VL_dataset_get_args_t::args</a></div><div class="ttdeci">union H5VL_dataset_get_args_t::@37 args</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_ae537368b3049ece68266be2ea6ba32bb"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#ae537368b3049ece68266be2ea6ba32bb">H5VL_dataset_get_args_t::get_dcpl</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@39 get_dcpl</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__get__args__t_html_aff38c9cfb0ec5d3400e0c0a6c2742a85"><div class="ttname"><a href="struct_h5_v_l__dataset__get__args__t.html#aff38c9cfb0ec5d3400e0c0a6c2742a85">H5VL_dataset_get_args_t::get_dapl</a></div><div class="ttdeci">struct H5VL_dataset_get_args_t::@37::@38 get_dapl</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDsetspec"></a>
dataset: specific</h3>
<p>The <em>specific</em> callback in the dataset class implements specific operations on HDF5 datasets as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:449</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The dset where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for dataset 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eb">H5VL_dataset_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346ebab34a36df015aa4e63a8da5312cef2b3f">H5VL_DATASET_SET_EXTENT</a>, <span class="comment">/* H5Dset_extent */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eba3a67be065b4404a8521154b7a1d936db">H5VL_DATASET_FLUSH</a>, <span class="comment">/* H5Dflush */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346ebace7df8a591dfcc28ef96d875744ce038">H5VL_DATASET_REFRESH</a> <span class="comment">/* H5Drefresh */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eb">H5VL_dataset_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for dataset 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__dataset__specific__args__t.html">H5VL_dataset_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eb">H5VL_dataset_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#a4c838af488c33410abd5447c5bf69e83">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_DATASET_SET_EXTENT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *<a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#a152917c01cb0cf9c11d4373419f6e172">size</a>; <span class="comment">/* New dataspace extent */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#a8fbb67000cb941509307355c7e555db1">set_extent</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_FLUSH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#ac03a0858609eaef6a8186380453e4867">dset_id</a>; <span class="comment">/* Dataset ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#aae6e9eae498be44e5620d4f3e524112d">flush</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATASET_REFRESH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#ac03a0858609eaef6a8186380453e4867">dset_id</a>; <span class="comment">/* Dataset ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#a18682384e228dd20b98e0a23435f8581">refresh</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__dataset__specific__args__t.html#a9077d60fed27c6a743f0467d8000e53e">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__dataset__specific__args__t.html">H5VL_dataset_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8fefe4297e306615172689a42d2346eb"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eb">H5VL_dataset_specific_t</a></div><div class="ttdeci">H5VL_dataset_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:266</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8fefe4297e306615172689a42d2346eba3a67be065b4404a8521154b7a1d936db"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346eba3a67be065b4404a8521154b7a1d936db">H5VL_DATASET_FLUSH</a></div><div class="ttdeci">@ H5VL_DATASET_FLUSH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:268</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8fefe4297e306615172689a42d2346ebab34a36df015aa4e63a8da5312cef2b3f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346ebab34a36df015aa4e63a8da5312cef2b3f">H5VL_DATASET_SET_EXTENT</a></div><div class="ttdeci">@ H5VL_DATASET_SET_EXTENT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:267</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8fefe4297e306615172689a42d2346ebace7df8a591dfcc28ef96d875744ce038"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8fefe4297e306615172689a42d2346ebace7df8a591dfcc28ef96d875744ce038">H5VL_DATASET_REFRESH</a></div><div class="ttdeci">@ H5VL_DATASET_REFRESH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:269</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_a152917c01cb0cf9c11d4373419f6e172"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#a152917c01cb0cf9c11d4373419f6e172">H5VL_dataset_specific_args_t::size</a></div><div class="ttdeci">const hsize_t * size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:280</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_a18682384e228dd20b98e0a23435f8581"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#a18682384e228dd20b98e0a23435f8581">H5VL_dataset_specific_args_t::refresh</a></div><div class="ttdeci">struct H5VL_dataset_specific_args_t::@44::@47 refresh</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_a4c838af488c33410abd5447c5bf69e83"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#a4c838af488c33410abd5447c5bf69e83">H5VL_dataset_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_dataset_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:274</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_a8fbb67000cb941509307355c7e555db1"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#a8fbb67000cb941509307355c7e555db1">H5VL_dataset_specific_args_t::set_extent</a></div><div class="ttdeci">struct H5VL_dataset_specific_args_t::@44::@45 set_extent</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_a9077d60fed27c6a743f0467d8000e53e"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#a9077d60fed27c6a743f0467d8000e53e">H5VL_dataset_specific_args_t::args</a></div><div class="ttdeci">union H5VL_dataset_specific_args_t::@44 args</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_aae6e9eae498be44e5620d4f3e524112d"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#aae6e9eae498be44e5620d4f3e524112d">H5VL_dataset_specific_args_t::flush</a></div><div class="ttdeci">struct H5VL_dataset_specific_args_t::@44::@46 flush</div></div>
<div class="ttc" id="astruct_h5_v_l__dataset__specific__args__t_html_ac03a0858609eaef6a8186380453e4867"><div class="ttname"><a href="struct_h5_v_l__dataset__specific__args__t.html#ac03a0858609eaef6a8186380453e4867">H5VL_dataset_specific_args_t::dset_id</a></div><div class="ttdeci">hid_t dset_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:285</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDsetopt"></a>
dataset: optional</h3>
<p>The <em>optional</em> callback in the dataset class implements connector specific operations on an HDF5 dataset. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefDsetclose"></a>
dataset: close</h3>
<p>The <em>close</em> callback in the dataset class terminates access to the dataset object and free all resources it was consuming and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*close)(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">dset (IN): Pointer to the dataset object.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefDType"></a>
Datatype Callbacks</h2>
<p>The HDF5 datatype routines (<a class="el" href="group___h5_t.html">Datatypes (H5T)</a>) allow users to create and manage HDF5 datatypes. Those routines are divided into two categories. One that operates on all types of datatypes but do not modify the contents of the container (all in memory), and others that operate on named datatypes by accessing the container. When a user creates an HDF5 datatype, it is still an object in memory space (transient datatype) that has not been added to the HDF5 containers. Only when a user commits the HDF5 datatype, it becomes persistent in the container. Those are called named/committed datatypes. The transient H5T routines should work on named datatypes nevertheless.</p>
<p>All the <a class="el" href="group___h5_t.html">Datatypes (H5T)</a> API routines that modify the HDF5 container map to one of the named datatype callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for datatype callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__datatype__class__t.html">H5VL_datatype_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*commit)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__datatype__class__t.html#afde5bd0d12e9ea0538088342292edbab">get</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__datatype__class__t.html#a25436a00c294004a9f1066696cd4781e">specific</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__datatype__specific__args__t.html">H5VL_datatype_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__datatype__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__datatype__class__t.html#aea0bf6576dffcb8806350946f6a025e8">close</a>)(<span class="keywordtype">void</span> *dt, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__datatype__class__t.html">H5VL_datatype_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__datatype__class__t_html"><div class="ttname"><a href="struct_h5_v_l__datatype__class__t.html">H5VL_datatype_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:893</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__class__t_html_a25436a00c294004a9f1066696cd4781e"><div class="ttname"><a href="struct_h5_v_l__datatype__class__t.html#a25436a00c294004a9f1066696cd4781e">H5VL_datatype_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, H5VL_datatype_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:899</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__class__t_html_a533cec569e2019874f02dd9552bcb68e"><div class="ttname"><a href="struct_h5_v_l__datatype__class__t.html#a533cec569e2019874f02dd9552bcb68e">H5VL_datatype_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:900</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__class__t_html_aea0bf6576dffcb8806350946f6a025e8"><div class="ttname"><a href="struct_h5_v_l__datatype__class__t.html#aea0bf6576dffcb8806350946f6a025e8">H5VL_datatype_class_t::close</a></div><div class="ttdeci">herr_t(* close)(void *dt, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:901</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__class__t_html_afde5bd0d12e9ea0538088342292edbab"><div class="ttname"><a href="struct_h5_v_l__datatype__class__t.html#afde5bd0d12e9ea0538088342292edbab">H5VL_datatype_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, H5VL_datatype_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:898</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:306</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html">H5VL_datatype_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:336</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDTypecommit"></a>
datatype: commit</h3>
<p>The <em>commit</em> callback in the named datatype class creates a datatype object in the container of the location object and returns a pointer to the datatype structure containing information to access the datatype in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*commit)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the datatype needs to be committed or where the look-up of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> In this call, the location type is always <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a>.</div>
<div class="line">name (IN): The name of the datatype to be created.</div>
<div class="line">typeid (IN): The transient datatype identifier to be committed.</div>
<div class="line">lcpl_id (IN): The link creation property list.</div>
<div class="line">tcpl_id (IN): The datatype creation property list.</div>
<div class="line">tapl_id (IN): The datatype access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDTypeopen"></a>
datatype: open</h3>
<p>The <em>open</em> callback in the named datatype class opens a previously committed datatype object in the container of the location object and returns a pointer to the datatype structure containing information to access the datatype in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open) (<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> * name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the datatype needs to be opened or where the look-up</div>
<div class="line"> of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> In this call, the location type is always <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a>.</div>
<div class="line">name (IN): The name of the datatype to be opened.</div>
<div class="line">tapl_id (IN): The datatype access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefDTypeget"></a>
datatype: get</h3>
<p>The <em>get</em> callback in the named datatype class retrieves information about the named datatype as specified in thegettypeparameter.It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get) (<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The named datatype to retrieve information from.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for datatype 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045">H5VL_datatype_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045ac6262bbc02f5f314dd61433ac8eb1ac7">H5VL_DATATYPE_GET_BINARY_SIZE</a>, <span class="comment">/* Get size of serialized form of transient type */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045a7a7beb42dec3775754d11081d8393b3f">H5VL_DATATYPE_GET_BINARY</a>, <span class="comment">/* Get serialized form of transient type */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045acae4838a97a29e1530f208320065fc4d">H5VL_DATATYPE_GET_TCPL</a> <span class="comment">/* Datatype creation property list */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045">H5VL_datatype_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for datatype 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045">H5VL_datatype_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#a4c40da96f9e63b9f4a8b9ad0d6b90fd6">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_DATATYPE_GET_BINARY_SIZE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#ae3c15c00c8f7ae14ae18501067cb5ac4">size</a>; <span class="comment">/* Size of serialized form of datatype (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#a20342e860edeeff7eec3edca0cfc5c84">get_binary_size</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATATYPE_GET_BINARY */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#a5bc5fa69bee375df074734a2c4858604">buf</a>; <span class="comment">/* Buffer to store serialized form of datatype (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of serialized datatype buffer */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#a8a714120511e822d1936ab6bc4de6755">get_binary</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATATYPE_GET_TCPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#aff53ff9d15547e7a8e31a4ff39295349">tcpl_id</a>; <span class="comment">/* Named datatype creation property list ID (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#ae171984fb7f2ce6823ada293feee4ac6">get_tcpl</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__get__args__t.html#abb71005c83fbbb2b13d578c56a7dc638">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a50c0522b08c0dcb658b82f089b82f045"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045">H5VL_datatype_get_t</a></div><div class="ttdeci">H5VL_datatype_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:299</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a50c0522b08c0dcb658b82f089b82f045a7a7beb42dec3775754d11081d8393b3f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045a7a7beb42dec3775754d11081d8393b3f">H5VL_DATATYPE_GET_BINARY</a></div><div class="ttdeci">@ H5VL_DATATYPE_GET_BINARY</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:301</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a50c0522b08c0dcb658b82f089b82f045ac6262bbc02f5f314dd61433ac8eb1ac7"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045ac6262bbc02f5f314dd61433ac8eb1ac7">H5VL_DATATYPE_GET_BINARY_SIZE</a></div><div class="ttdeci">@ H5VL_DATATYPE_GET_BINARY_SIZE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:300</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a50c0522b08c0dcb658b82f089b82f045acae4838a97a29e1530f208320065fc4d"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a50c0522b08c0dcb658b82f089b82f045acae4838a97a29e1530f208320065fc4d">H5VL_DATATYPE_GET_TCPL</a></div><div class="ttdeci">@ H5VL_DATATYPE_GET_TCPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:302</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_a20342e860edeeff7eec3edca0cfc5c84"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#a20342e860edeeff7eec3edca0cfc5c84">H5VL_datatype_get_args_t::get_binary_size</a></div><div class="ttdeci">struct H5VL_datatype_get_args_t::@48::@49 get_binary_size</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_a4c40da96f9e63b9f4a8b9ad0d6b90fd6"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#a4c40da96f9e63b9f4a8b9ad0d6b90fd6">H5VL_datatype_get_args_t::op_type</a></div><div class="ttdeci">H5VL_datatype_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:307</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_a5bc5fa69bee375df074734a2c4858604"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#a5bc5fa69bee375df074734a2c4858604">H5VL_datatype_get_args_t::buf</a></div><div class="ttdeci">void * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:318</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_a8a714120511e822d1936ab6bc4de6755"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#a8a714120511e822d1936ab6bc4de6755">H5VL_datatype_get_args_t::get_binary</a></div><div class="ttdeci">struct H5VL_datatype_get_args_t::@48::@50 get_binary</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_abb71005c83fbbb2b13d578c56a7dc638"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#abb71005c83fbbb2b13d578c56a7dc638">H5VL_datatype_get_args_t::args</a></div><div class="ttdeci">union H5VL_datatype_get_args_t::@48 args</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_ae171984fb7f2ce6823ada293feee4ac6"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#ae171984fb7f2ce6823ada293feee4ac6">H5VL_datatype_get_args_t::get_tcpl</a></div><div class="ttdeci">struct H5VL_datatype_get_args_t::@48::@51 get_tcpl</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_ae3c15c00c8f7ae14ae18501067cb5ac4"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#ae3c15c00c8f7ae14ae18501067cb5ac4">H5VL_datatype_get_args_t::size</a></div><div class="ttdeci">size_t * size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:313</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_datatype_get_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:319</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__get__args__t_html_aff53ff9d15547e7a8e31a4ff39295349"><div class="ttname"><a href="struct_h5_v_l__datatype__get__args__t.html#aff53ff9d15547e7a8e31a4ff39295349">H5VL_datatype_get_args_t::tcpl_id</a></div><div class="ttdeci">hid_t tcpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:324</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDTypespec"></a>
datatype: specific</h3>
<p>The <em>specific</em> callback in the datatype class implements specific operations on HDF5 named datatypes as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:726</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for datatype 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581">H5VL_datatype_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581a31de802d1231e3f005667efdbd9e849b">H5VL_DATATYPE_FLUSH</a>, <span class="comment">/* H5Tflush */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581a789ab10e1a6d5b33b7fbe769ee97bdc1">H5VL_DATATYPE_REFRESH</a> <span class="comment">/* H5Trefresh */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581">H5VL_datatype_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for datatype 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__datatype__specific__args__t.html">H5VL_datatype_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581">H5VL_datatype_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#aed7261f32ee4fa0b6e71e00f56f3a005">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_DATATYPE_FLUSH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">type_id</a>; <span class="comment">/* Named datatype ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#a1c163071973a35b9dbf19b01420f28af">flush</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_DATATYPE_REFRESH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">type_id</a>; <span class="comment">/* Named datatype ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#ad2751300170da757b5f5acb0e5891fbc">refresh</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__datatype__specific__args__t.html#ad768316a8ff41bfe40917d11acec95af">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__datatype__specific__args__t.html">H5VL_datatype_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a3717bbb5258f48e253ff646f4255b581"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581">H5VL_datatype_specific_t</a></div><div class="ttdeci">H5VL_datatype_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:330</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a3717bbb5258f48e253ff646f4255b581a31de802d1231e3f005667efdbd9e849b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581a31de802d1231e3f005667efdbd9e849b">H5VL_DATATYPE_FLUSH</a></div><div class="ttdeci">@ H5VL_DATATYPE_FLUSH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:331</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a3717bbb5258f48e253ff646f4255b581a789ab10e1a6d5b33b7fbe769ee97bdc1"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a3717bbb5258f48e253ff646f4255b581a789ab10e1a6d5b33b7fbe769ee97bdc1">H5VL_DATATYPE_REFRESH</a></div><div class="ttdeci">@ H5VL_DATATYPE_REFRESH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:332</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html_a1c163071973a35b9dbf19b01420f28af"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html#a1c163071973a35b9dbf19b01420f28af">H5VL_datatype_specific_args_t::flush</a></div><div class="ttdeci">struct H5VL_datatype_specific_args_t::@52::@53 flush</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html_a89fbb59cdf681f79816c5cab69c5dbac"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html#a89fbb59cdf681f79816c5cab69c5dbac">H5VL_datatype_specific_args_t::type_id</a></div><div class="ttdeci">hid_t type_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:343</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html_ad2751300170da757b5f5acb0e5891fbc"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html#ad2751300170da757b5f5acb0e5891fbc">H5VL_datatype_specific_args_t::refresh</a></div><div class="ttdeci">struct H5VL_datatype_specific_args_t::@52::@54 refresh</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html_ad768316a8ff41bfe40917d11acec95af"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html#ad768316a8ff41bfe40917d11acec95af">H5VL_datatype_specific_args_t::args</a></div><div class="ttdeci">union H5VL_datatype_specific_args_t::@52 args</div></div>
<div class="ttc" id="astruct_h5_v_l__datatype__specific__args__t_html_aed7261f32ee4fa0b6e71e00f56f3a005"><div class="ttname"><a href="struct_h5_v_l__datatype__specific__args__t.html#aed7261f32ee4fa0b6e71e00f56f3a005">H5VL_datatype_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_datatype_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:337</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefDTypeopt"></a>
datatype: optional</h3>
<p>The <em>optional</em> callback in the datatype class implements connector specific operations on an HDF5 datatype. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefDTypeclose"></a>
datatype: close</h3>
<p>The <em>close</em> callback in the named datatype class terminates access to the datatype object and free all resources it was consuming and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*close) (<span class="keywordtype">void</span> *dt, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">dt (IN): Pointer to the datatype object.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefFile"></a>
File Callbacks</h2>
<p>The file API routines (<a class="el" href="group___h5_f.html">Files (H5F)</a>) allow HDF5 users to create and manage HDF5 containers. All the <a class="el" href="group___h5_f.html">Files (H5F)</a> API routines that modify the HDF5 container map to one of the file callback routines in his class that the connector needs to implement.</p>
<p><em>File class for file API routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__class__t.html">H5VL_file_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*create)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__file__class__t.html#ae3c7ab10f6778059d88b1faa157d8330">get</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__file__class__t.html#ad2a8b6931916532d625283c956acf5fb">specific</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__file__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__file__class__t.html#aef7d9442ff871e92439d02c356e93813">close</a>)(<span class="keywordtype">void</span> *file, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__class__t.html">H5VL_file_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__file__class__t_html"><div class="ttname"><a href="struct_h5_v_l__file__class__t.html">H5VL_file_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:905</div></div>
<div class="ttc" id="astruct_h5_v_l__file__class__t_html_a533cec569e2019874f02dd9552bcb68e"><div class="ttname"><a href="struct_h5_v_l__file__class__t.html#a533cec569e2019874f02dd9552bcb68e">H5VL_file_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:911</div></div>
<div class="ttc" id="astruct_h5_v_l__file__class__t_html_ad2a8b6931916532d625283c956acf5fb"><div class="ttname"><a href="struct_h5_v_l__file__class__t.html#ad2a8b6931916532d625283c956acf5fb">H5VL_file_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, H5VL_file_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:910</div></div>
<div class="ttc" id="astruct_h5_v_l__file__class__t_html_ae3c7ab10f6778059d88b1faa157d8330"><div class="ttname"><a href="struct_h5_v_l__file__class__t.html#ae3c7ab10f6778059d88b1faa157d8330">H5VL_file_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, H5VL_file_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:909</div></div>
<div class="ttc" id="astruct_h5_v_l__file__class__t_html_aef7d9442ff871e92439d02c356e93813"><div class="ttname"><a href="struct_h5_v_l__file__class__t.html#aef7d9442ff871e92439d02c356e93813">H5VL_file_class_t::close</a></div><div class="ttdeci">herr_t(* close)(void *file, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:912</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:395</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefFilecreate"></a>
file: create</h3>
<p>The <em>create</em> callback in the file class should create a container and returns a pointer to the file structure created by the connector containing information to access the container in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*create)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, hid_tdxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">name (IN): The name of the container to be created.</div>
<div class="line">flags (IN): The creation flags of the container.</div>
<div class="line">fcpl_id (IN): The file creation property list.</div>
<div class="line">fapl_id (IN): The file access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefFileopen"></a>
file: open</h3>
<p>The <em>open</em> callback in the file class should open a container and returns a pointer to the file structure created by the connector containing information to access the container in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">name (IN): The name of the container to open.</div>
<div class="line">flags (IN): The open flags of the container.</div>
<div class="line">fapl_id (IN): The file access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefFileget"></a>
file: get</h3>
<p>The <em>get</em> callback in the file class should retrieve information about the container as specified in the <em>get_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where information needs to be retrieved from.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Info for H5VL_FILE_GET_CONT_INFO */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__cont__info__t.html">H5VL_file_cont_info_t</a> {</div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__file__cont__info__t.html#a27fe8e82cf2ce359010cc1d08af2e105">version</a>; <span class="comment">/* version information (keep first) */</span></div>
<div class="line"> uint64_t <a class="code hl_variable" href="struct_h5_v_l__file__cont__info__t.html#aaccbcc3ce862dbe5af189ee0c3e345b1">feature_flags</a>; <span class="comment">/* Container feature flags */</span></div>
<div class="line"> <span class="comment">/* (none currently defined) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__file__cont__info__t.html#a40f79c034c355480666082eb5e853285">token_size</a>; <span class="comment">/* Size of tokens */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__file__cont__info__t.html#a46853bd7d88b56b5a47092ed3ee693e8">blob_id_size</a>; <span class="comment">/* Size of blob IDs */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__cont__info__t.html">H5VL_file_cont_info_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Values for file 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178c">H5VL_file_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca2d6b91c14df76dcdc5377e9986a8d2c2">H5VL_FILE_GET_CONT_INFO</a>, <span class="comment">/* file get container info */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178caf109918eace3f4c77307a26eb4a1361b">H5VL_FILE_GET_FAPL</a>, <span class="comment">/* file access property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cad82b76eeca240549fff75668a8a07ffa">H5VL_FILE_GET_FCPL</a>, <span class="comment">/* file creation property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca1ba678b6d0c35c09eebba9491a906a5b">H5VL_FILE_GET_FILENO</a>, <span class="comment">/* file number */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cae81f8cf07e88734b01bff3106d04050d">H5VL_FILE_GET_INTENT</a>, <span class="comment">/* file intent */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cafd2f1b2c691bb05a4c1efa44efcc8ce8">H5VL_FILE_GET_NAME</a>, <span class="comment">/* file name */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cadec494437e2cd833c094952e0e7b1757">H5VL_FILE_GET_OBJ_COUNT</a>, <span class="comment">/* object count in file */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca97119fe8729739f6be9c61e4ef52d92a">H5VL_FILE_GET_OBJ_IDS</a> <span class="comment">/* object ids in file */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178c">H5VL_file_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for file 'get_name' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__get__name__args__t.html">H5VL_file_get_name_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__name__args__t.html#aed263436f49d4b0e9f6889d041634200">type</a>; <span class="comment">/* ID type of object pointer */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__file__get__name__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of file name buffer (IN) */</span></div>
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__name__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">buf</a>; <span class="comment">/* Buffer for file name (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__name__args__t.html#a9b27b1e1c81fee81e63db805f270ca64">file_name_len</a>; <span class="comment">/* Actual length of file name (OUT) */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__get__name__args__t.html">H5VL_file_get_name_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for file 'get_obj_ids' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__get__obj__ids__args__t.html">H5VL_file_get_obj_ids_args_t</a> {</div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__file__get__obj__ids__args__t.html#ace3d9a8e1cec29ba4fbf44ecab4d3dd2">types</a>; <span class="comment">/* Type of objects to count */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__file__get__obj__ids__args__t.html#a5ea7cf00bccd42358f3668bf9a82fd0a">max_objs</a>; <span class="comment">/* Size of array of object IDs */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> *<a class="code hl_variable" href="struct_h5_v_l__file__get__obj__ids__args__t.html#a8cd7b9cccd7b6ac70bce954b004eabaa">oid_list</a>; <span class="comment">/* Array of object IDs (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__obj__ids__args__t.html#a32a30b3c1412ce372e776115c3825505">count</a>; <span class="comment">/* # of objects (OUT) */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__get__obj__ids__args__t.html">H5VL_file_get_obj_ids_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for file 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178c">H5VL_file_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a6713bc30bd7a9b2d9b597cc3d1359d20">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_CONT_INFO */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__file__cont__info__t.html">H5VL_file_cont_info_t</a> *<a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a4c19224661b5a5184376f04a091f8887">info</a>; <span class="comment">/* Container info (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a6f780a5ddd3a5bfbd479e50538a55af9">get_cont_info</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_FAPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#ace4df3bcfdb5bb309d7994bc043d4e5e">fapl_id</a>; <span class="comment">/* File access property list (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#adbe3156ff9172cf9651e9b3aaaa2546b">get_fapl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_FCPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#adfee2c69a82af269e6e472f9288c3441">fcpl_id</a>; <span class="comment">/* File creation property list (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#acdd9006742eb29d0969c2574b0fedd97">get_fcpl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_FILENO */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a5ef8cd3d2955adb5cd189a93c01daf03">fileno</a>; <span class="comment">/* File "number" (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a73481f2667d91185ad319a9b9be52894">get_fileno</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_INTENT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">unsigned</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#afcd9ab20c1d046b60e462bf2895ae09b">flags</a>; <span class="comment">/* File open/create intent flags (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a6edde3b8c627898ffc83b0564539745c">get_intent</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_NAME */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__file__get__name__args__t.html">H5VL_file_get_name_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a36ebc67270b0fb5c4d1de185940efdd7">get_name</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_OBJ_COUNT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#ace3d9a8e1cec29ba4fbf44ecab4d3dd2">types</a>; <span class="comment">/* Type of objects to count */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a32a30b3c1412ce372e776115c3825505">count</a>; <span class="comment">/* # of objects (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a2449b1682e95e6a9eb1089678fd1c7ea">get_obj_count</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_GET_OBJ_IDS */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__file__get__obj__ids__args__t.html">H5VL_file_get_obj_ids_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#a4c29f47671bd907a78c2bca4290fb6f9">get_obj_ids</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__get__args__t.html#ac1e6c788e2dd4c9e9673bf8812e3a6bc">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178c"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178c">H5VL_file_get_t</a></div><div class="ttdeci">H5VL_file_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:367</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178ca1ba678b6d0c35c09eebba9491a906a5b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca1ba678b6d0c35c09eebba9491a906a5b">H5VL_FILE_GET_FILENO</a></div><div class="ttdeci">@ H5VL_FILE_GET_FILENO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:371</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178ca2d6b91c14df76dcdc5377e9986a8d2c2"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca2d6b91c14df76dcdc5377e9986a8d2c2">H5VL_FILE_GET_CONT_INFO</a></div><div class="ttdeci">@ H5VL_FILE_GET_CONT_INFO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:368</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178ca97119fe8729739f6be9c61e4ef52d92a"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178ca97119fe8729739f6be9c61e4ef52d92a">H5VL_FILE_GET_OBJ_IDS</a></div><div class="ttdeci">@ H5VL_FILE_GET_OBJ_IDS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:375</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178cad82b76eeca240549fff75668a8a07ffa"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cad82b76eeca240549fff75668a8a07ffa">H5VL_FILE_GET_FCPL</a></div><div class="ttdeci">@ H5VL_FILE_GET_FCPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:370</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178cadec494437e2cd833c094952e0e7b1757"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cadec494437e2cd833c094952e0e7b1757">H5VL_FILE_GET_OBJ_COUNT</a></div><div class="ttdeci">@ H5VL_FILE_GET_OBJ_COUNT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:374</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178cae81f8cf07e88734b01bff3106d04050d"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cae81f8cf07e88734b01bff3106d04050d">H5VL_FILE_GET_INTENT</a></div><div class="ttdeci">@ H5VL_FILE_GET_INTENT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:372</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178caf109918eace3f4c77307a26eb4a1361b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178caf109918eace3f4c77307a26eb4a1361b">H5VL_FILE_GET_FAPL</a></div><div class="ttdeci">@ H5VL_FILE_GET_FAPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:369</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a693343d9d502ed7728883b7c53dc178cafd2f1b2c691bb05a4c1efa44efcc8ce8"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a693343d9d502ed7728883b7c53dc178cafd2f1b2c691bb05a4c1efa44efcc8ce8">H5VL_FILE_GET_NAME</a></div><div class="ttdeci">@ H5VL_FILE_GET_NAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:373</div></div>
<div class="ttc" id="astruct_h5_v_l__file__cont__info__t_html"><div class="ttname"><a href="struct_h5_v_l__file__cont__info__t.html">H5VL_file_cont_info_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:358</div></div>
<div class="ttc" id="astruct_h5_v_l__file__cont__info__t_html_a27fe8e82cf2ce359010cc1d08af2e105"><div class="ttname"><a href="struct_h5_v_l__file__cont__info__t.html#a27fe8e82cf2ce359010cc1d08af2e105">H5VL_file_cont_info_t::version</a></div><div class="ttdeci">unsigned version</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:359</div></div>
<div class="ttc" id="astruct_h5_v_l__file__cont__info__t_html_a40f79c034c355480666082eb5e853285"><div class="ttname"><a href="struct_h5_v_l__file__cont__info__t.html#a40f79c034c355480666082eb5e853285">H5VL_file_cont_info_t::token_size</a></div><div class="ttdeci">size_t token_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:362</div></div>
<div class="ttc" id="astruct_h5_v_l__file__cont__info__t_html_a46853bd7d88b56b5a47092ed3ee693e8"><div class="ttname"><a href="struct_h5_v_l__file__cont__info__t.html#a46853bd7d88b56b5a47092ed3ee693e8">H5VL_file_cont_info_t::blob_id_size</a></div><div class="ttdeci">size_t blob_id_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:363</div></div>
<div class="ttc" id="astruct_h5_v_l__file__cont__info__t_html_aaccbcc3ce862dbe5af189ee0c3e345b1"><div class="ttname"><a href="struct_h5_v_l__file__cont__info__t.html#aaccbcc3ce862dbe5af189ee0c3e345b1">H5VL_file_cont_info_t::feature_flags</a></div><div class="ttdeci">uint64_t feature_flags</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:360</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a2449b1682e95e6a9eb1089678fd1c7ea"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a2449b1682e95e6a9eb1089678fd1c7ea">H5VL_file_get_args_t::get_obj_count</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@61 get_obj_count</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a32a30b3c1412ce372e776115c3825505"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a32a30b3c1412ce372e776115c3825505">H5VL_file_get_args_t::count</a></div><div class="ttdeci">size_t * count</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:431</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a36ebc67270b0fb5c4d1de185940efdd7"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a36ebc67270b0fb5c4d1de185940efdd7">H5VL_file_get_args_t::get_name</a></div><div class="ttdeci">H5VL_file_get_name_args_t get_name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:426</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a4c19224661b5a5184376f04a091f8887"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a4c19224661b5a5184376f04a091f8887">H5VL_file_get_args_t::info</a></div><div class="ttdeci">H5VL_file_cont_info_t * info</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:402</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a4c29f47671bd907a78c2bca4290fb6f9"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a4c29f47671bd907a78c2bca4290fb6f9">H5VL_file_get_args_t::get_obj_ids</a></div><div class="ttdeci">H5VL_file_get_obj_ids_args_t get_obj_ids</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:435</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a5ef8cd3d2955adb5cd189a93c01daf03"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a5ef8cd3d2955adb5cd189a93c01daf03">H5VL_file_get_args_t::fileno</a></div><div class="ttdeci">unsigned long * fileno</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:417</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a6713bc30bd7a9b2d9b597cc3d1359d20"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a6713bc30bd7a9b2d9b597cc3d1359d20">H5VL_file_get_args_t::op_type</a></div><div class="ttdeci">H5VL_file_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:396</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a6edde3b8c627898ffc83b0564539745c"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a6edde3b8c627898ffc83b0564539745c">H5VL_file_get_args_t::get_intent</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@60 get_intent</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a6f780a5ddd3a5bfbd479e50538a55af9"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a6f780a5ddd3a5bfbd479e50538a55af9">H5VL_file_get_args_t::get_cont_info</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@56 get_cont_info</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_a73481f2667d91185ad319a9b9be52894"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#a73481f2667d91185ad319a9b9be52894">H5VL_file_get_args_t::get_fileno</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@59 get_fileno</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_ac1e6c788e2dd4c9e9673bf8812e3a6bc"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#ac1e6c788e2dd4c9e9673bf8812e3a6bc">H5VL_file_get_args_t::args</a></div><div class="ttdeci">union H5VL_file_get_args_t::@55 args</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_acdd9006742eb29d0969c2574b0fedd97"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#acdd9006742eb29d0969c2574b0fedd97">H5VL_file_get_args_t::get_fcpl</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@58 get_fcpl</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_ace3d9a8e1cec29ba4fbf44ecab4d3dd2"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#ace3d9a8e1cec29ba4fbf44ecab4d3dd2">H5VL_file_get_args_t::types</a></div><div class="ttdeci">unsigned types</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:430</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_ace4df3bcfdb5bb309d7994bc043d4e5e"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#ace4df3bcfdb5bb309d7994bc043d4e5e">H5VL_file_get_args_t::fapl_id</a></div><div class="ttdeci">hid_t fapl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:407</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_adbe3156ff9172cf9651e9b3aaaa2546b"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#adbe3156ff9172cf9651e9b3aaaa2546b">H5VL_file_get_args_t::get_fapl</a></div><div class="ttdeci">struct H5VL_file_get_args_t::@55::@57 get_fapl</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_adfee2c69a82af269e6e472f9288c3441"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#adfee2c69a82af269e6e472f9288c3441">H5VL_file_get_args_t::fcpl_id</a></div><div class="ttdeci">hid_t fcpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:412</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__args__t_html_afcd9ab20c1d046b60e462bf2895ae09b"><div class="ttname"><a href="struct_h5_v_l__file__get__args__t.html#afcd9ab20c1d046b60e462bf2895ae09b">H5VL_file_get_args_t::flags</a></div><div class="ttdeci">unsigned * flags</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:422</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__name__args__t_html"><div class="ttname"><a href="struct_h5_v_l__file__get__name__args__t.html">H5VL_file_get_name_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:379</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__name__args__t_html_a1fe855c208bc17a51a4d34fefdb2d5b1"><div class="ttname"><a href="struct_h5_v_l__file__get__name__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">H5VL_file_get_name_args_t::buf</a></div><div class="ttdeci">char * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:382</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__name__args__t_html_a9b27b1e1c81fee81e63db805f270ca64"><div class="ttname"><a href="struct_h5_v_l__file__get__name__args__t.html#a9b27b1e1c81fee81e63db805f270ca64">H5VL_file_get_name_args_t::file_name_len</a></div><div class="ttdeci">size_t * file_name_len</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:383</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__name__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__file__get__name__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_file_get_name_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:381</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__name__args__t_html_aed263436f49d4b0e9f6889d041634200"><div class="ttname"><a href="struct_h5_v_l__file__get__name__args__t.html#aed263436f49d4b0e9f6889d041634200">H5VL_file_get_name_args_t::type</a></div><div class="ttdeci">H5I_type_t type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:380</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__obj__ids__args__t_html"><div class="ttname"><a href="struct_h5_v_l__file__get__obj__ids__args__t.html">H5VL_file_get_obj_ids_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:387</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__obj__ids__args__t_html_a32a30b3c1412ce372e776115c3825505"><div class="ttname"><a href="struct_h5_v_l__file__get__obj__ids__args__t.html#a32a30b3c1412ce372e776115c3825505">H5VL_file_get_obj_ids_args_t::count</a></div><div class="ttdeci">size_t * count</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:391</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__obj__ids__args__t_html_a5ea7cf00bccd42358f3668bf9a82fd0a"><div class="ttname"><a href="struct_h5_v_l__file__get__obj__ids__args__t.html#a5ea7cf00bccd42358f3668bf9a82fd0a">H5VL_file_get_obj_ids_args_t::max_objs</a></div><div class="ttdeci">size_t max_objs</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:389</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__obj__ids__args__t_html_a8cd7b9cccd7b6ac70bce954b004eabaa"><div class="ttname"><a href="struct_h5_v_l__file__get__obj__ids__args__t.html#a8cd7b9cccd7b6ac70bce954b004eabaa">H5VL_file_get_obj_ids_args_t::oid_list</a></div><div class="ttdeci">hid_t * oid_list</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:390</div></div>
<div class="ttc" id="astruct_h5_v_l__file__get__obj__ids__args__t_html_ace3d9a8e1cec29ba4fbf44ecab4d3dd2"><div class="ttname"><a href="struct_h5_v_l__file__get__obj__ids__args__t.html#ace3d9a8e1cec29ba4fbf44ecab4d3dd2">H5VL_file_get_obj_ids_args_t::types</a></div><div class="ttdeci">unsigned types</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:388</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefFilespec"></a>
file: specific</h3>
<p>The <em>specific</em> callback in the file class implements specific operations on HDF5 files as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for file 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776c">H5VL_file_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776cabb47ec2cb5403edfbb59a86045914939">H5VL_FILE_FLUSH</a>, <span class="comment">/* Flush file */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776ca4aeac39fe8593cbf9b0a0d582e910b3f">H5VL_FILE_REOPEN</a>, <span class="comment">/* Reopen the file */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776caae709fc8e384a5795762ebdfd19156a7">H5VL_FILE_IS_ACCESSIBLE</a>, <span class="comment">/* Check if a file is accessible */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776cab0272350bc97edc2b75aaf8d00f243be">H5VL_FILE_DELETE</a>, <span class="comment">/* Delete a file */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776ca7302e73192f78efa10ac83ca91de50b3">H5VL_FILE_IS_EQUAL</a> <span class="comment">/* Check if two files are the same */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776c">H5VL_file_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for file 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776c">H5VL_file_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a40b4ab4d783c540283bacde5b875248c">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_FILE_FLUSH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a81030798b196a9008fdf5b6021205b20">obj_type</a>; <span class="comment">/* Type of object to use */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdf">H5F_scope_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a08d0f6a39d80f3bf72e02eb4f412b98c">scope</a>; <span class="comment">/* Scope of flush operation */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a9d84672c2a1e2a1d226285212858e558">flush</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_REOPEN */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">void</span> **<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a763d005405f708ac1e07281969678423">file</a>; <span class="comment">/* File object for new file (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a1ccd954a6d73ee8d6756d2f2771d5166">reopen</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_IS_ACCESSIBLE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a7efa5e9c7494c7d4586359300221aa5d">filename</a>; <span class="comment">/* Name of file to check */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#ace4df3bcfdb5bb309d7994bc043d4e5e">fapl_id</a>; <span class="comment">/* File access property list to use */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a437b959a2cfb16b66cf30c47fca51405">accessible</a>; <span class="comment">/* Whether file is accessible with FAPL settings (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#ab8fe418ed0ab9ec40583ba0783f8ab8b">is_accessible</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_DELETE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a7efa5e9c7494c7d4586359300221aa5d">filename</a>; <span class="comment">/* Name of file to delete */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#ace4df3bcfdb5bb309d7994bc043d4e5e">fapl_id</a>; <span class="comment">/* File access property list to use */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#aa2e2d9ef1ee896cca0f4de66bf51e99e">del</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_FILE_IS_EQUAL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#ac2e6d717320d1b0aa4cc910db54a84e1">obj2</a>; <span class="comment">/* Second file object to compare against */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#aa9e470d8c63cf76ec096dc912842439b">same_file</a>; <span class="comment">/* Whether files are the same (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#af8e96523c498892bf3de1b1e5fe22a16">is_equal</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__file__specific__args__t.html#a77e79a12e8c35c289a6b333d06d531fa">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_fpublic_8h_html_ac9db1b1211555797021daed9b54b8cdf"><div class="ttname"><a href="_h5_fpublic_8h.html#ac9db1b1211555797021daed9b54b8cdf">H5F_scope_t</a></div><div class="ttdeci">H5F_scope_t</div><div class="ttdef"><b>Definition</b> H5Fpublic.h:101</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776c"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776c">H5VL_file_specific_t</a></div><div class="ttdeci">H5VL_file_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:440</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776ca4aeac39fe8593cbf9b0a0d582e910b3f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776ca4aeac39fe8593cbf9b0a0d582e910b3f">H5VL_FILE_REOPEN</a></div><div class="ttdeci">@ H5VL_FILE_REOPEN</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:442</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776ca7302e73192f78efa10ac83ca91de50b3"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776ca7302e73192f78efa10ac83ca91de50b3">H5VL_FILE_IS_EQUAL</a></div><div class="ttdeci">@ H5VL_FILE_IS_EQUAL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:445</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776caae709fc8e384a5795762ebdfd19156a7"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776caae709fc8e384a5795762ebdfd19156a7">H5VL_FILE_IS_ACCESSIBLE</a></div><div class="ttdeci">@ H5VL_FILE_IS_ACCESSIBLE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:443</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776cab0272350bc97edc2b75aaf8d00f243be"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776cab0272350bc97edc2b75aaf8d00f243be">H5VL_FILE_DELETE</a></div><div class="ttdeci">@ H5VL_FILE_DELETE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:444</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a0677561e907e85a084c9d7eb8463776cabb47ec2cb5403edfbb59a86045914939"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a0677561e907e85a084c9d7eb8463776cabb47ec2cb5403edfbb59a86045914939">H5VL_FILE_FLUSH</a></div><div class="ttdeci">@ H5VL_FILE_FLUSH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:441</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a08d0f6a39d80f3bf72e02eb4f412b98c"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a08d0f6a39d80f3bf72e02eb4f412b98c">H5VL_file_specific_args_t::scope</a></div><div class="ttdeci">H5F_scope_t scope</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:457</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a1ccd954a6d73ee8d6756d2f2771d5166"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a1ccd954a6d73ee8d6756d2f2771d5166">H5VL_file_specific_args_t::reopen</a></div><div class="ttdeci">struct H5VL_file_specific_args_t::@62::@64 reopen</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a40b4ab4d783c540283bacde5b875248c"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a40b4ab4d783c540283bacde5b875248c">H5VL_file_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_file_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:450</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a437b959a2cfb16b66cf30c47fca51405"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a437b959a2cfb16b66cf30c47fca51405">H5VL_file_specific_args_t::accessible</a></div><div class="ttdeci">hbool_t * accessible</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:469</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a763d005405f708ac1e07281969678423"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a763d005405f708ac1e07281969678423">H5VL_file_specific_args_t::file</a></div><div class="ttdeci">void ** file</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:462</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a77e79a12e8c35c289a6b333d06d531fa"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a77e79a12e8c35c289a6b333d06d531fa">H5VL_file_specific_args_t::args</a></div><div class="ttdeci">union H5VL_file_specific_args_t::@62 args</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a7efa5e9c7494c7d4586359300221aa5d"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a7efa5e9c7494c7d4586359300221aa5d">H5VL_file_specific_args_t::filename</a></div><div class="ttdeci">const char * filename</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:467</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a81030798b196a9008fdf5b6021205b20"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a81030798b196a9008fdf5b6021205b20">H5VL_file_specific_args_t::obj_type</a></div><div class="ttdeci">H5I_type_t obj_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:456</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_a9d84672c2a1e2a1d226285212858e558"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#a9d84672c2a1e2a1d226285212858e558">H5VL_file_specific_args_t::flush</a></div><div class="ttdeci">struct H5VL_file_specific_args_t::@62::@63 flush</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_aa2e2d9ef1ee896cca0f4de66bf51e99e"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#aa2e2d9ef1ee896cca0f4de66bf51e99e">H5VL_file_specific_args_t::del</a></div><div class="ttdeci">struct H5VL_file_specific_args_t::@62::@66 del</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_aa9e470d8c63cf76ec096dc912842439b"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#aa9e470d8c63cf76ec096dc912842439b">H5VL_file_specific_args_t::same_file</a></div><div class="ttdeci">hbool_t * same_file</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:481</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_ab8fe418ed0ab9ec40583ba0783f8ab8b"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#ab8fe418ed0ab9ec40583ba0783f8ab8b">H5VL_file_specific_args_t::is_accessible</a></div><div class="ttdeci">struct H5VL_file_specific_args_t::@62::@65 is_accessible</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_ac2e6d717320d1b0aa4cc910db54a84e1"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#ac2e6d717320d1b0aa4cc910db54a84e1">H5VL_file_specific_args_t::obj2</a></div><div class="ttdeci">void * obj2</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:480</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_ace4df3bcfdb5bb309d7994bc043d4e5e"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#ace4df3bcfdb5bb309d7994bc043d4e5e">H5VL_file_specific_args_t::fapl_id</a></div><div class="ttdeci">hid_t fapl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:468</div></div>
<div class="ttc" id="astruct_h5_v_l__file__specific__args__t_html_af8e96523c498892bf3de1b1e5fe22a16"><div class="ttname"><a href="struct_h5_v_l__file__specific__args__t.html#af8e96523c498892bf3de1b1e5fe22a16">H5VL_file_specific_args_t::is_equal</a></div><div class="ttdeci">struct H5VL_file_specific_args_t::@62::@67 is_equal</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefFileopt"></a>
file: optional</h3>
<p>The <em>optional</em> callback in the file class implements connector specific operations on an HDF5 container. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefFileclose"></a>
file: close</h3>
<p>The <em>close</em> callback in the file class should terminate access to the file object and free all resources it was consuming, and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*close)(<span class="keywordtype">void</span> *file, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">file (IN): Pointer to the file.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefGrp"></a>
Group Callbacks</h2>
<p>The group API routines (<a class="el" href="group___h5_g.html">Groups (H5G)</a>) allow HDF5 users to create and manage HDF5 groups. All the <a class="el" href="group___h5_g.html">Groups (H5G)</a> API routines that modify the HDF5 container map to one of the group callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for group callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__group__class__t.html">H5VL_group_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__group__class__t.html#a6bf29d69e71a9c4ddfa9db2f93c7bb6f">get</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__group__class__t.html#a6ec368486c41afebad682ca7830bf5f6">specific</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__group__specific__args__t.html">H5VL_group_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__group__class__t.html#a533cec569e2019874f02dd9552bcb68e">optional</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__group__class__t.html#ac5564377c35a9a35da188e9af2fe1ec9">close</a>)(<span class="keywordtype">void</span> *grp, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__group__class__t.html">H5VL_group_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__group__class__t_html"><div class="ttname"><a href="struct_h5_v_l__group__class__t.html">H5VL_group_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:916</div></div>
<div class="ttc" id="astruct_h5_v_l__group__class__t_html_a533cec569e2019874f02dd9552bcb68e"><div class="ttname"><a href="struct_h5_v_l__group__class__t.html#a533cec569e2019874f02dd9552bcb68e">H5VL_group_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:923</div></div>
<div class="ttc" id="astruct_h5_v_l__group__class__t_html_a6bf29d69e71a9c4ddfa9db2f93c7bb6f"><div class="ttname"><a href="struct_h5_v_l__group__class__t.html#a6bf29d69e71a9c4ddfa9db2f93c7bb6f">H5VL_group_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, H5VL_group_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:921</div></div>
<div class="ttc" id="astruct_h5_v_l__group__class__t_html_a6ec368486c41afebad682ca7830bf5f6"><div class="ttname"><a href="struct_h5_v_l__group__class__t.html#a6ec368486c41afebad682ca7830bf5f6">H5VL_group_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, H5VL_group_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:922</div></div>
<div class="ttc" id="astruct_h5_v_l__group__class__t_html_ac5564377c35a9a35da188e9af2fe1ec9"><div class="ttname"><a href="struct_h5_v_l__group__class__t.html#ac5564377c35a9a35da188e9af2fe1ec9">H5VL_group_class_t::close</a></div><div class="ttdeci">herr_t(* close)(void *grp, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:924</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:502</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html">H5VL_group_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:533</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefGrpcreate"></a>
group: create</h3>
<p>The <em>create</em> callback in the group class creates a group object in the container of the location object and returns a pointer to the group structure containing information to access the group in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*create)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gcpl_id,<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the group needs to be created or where the look-up of</div>
<div class="line"> the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">name (IN): The name of the group to be created.</div>
<div class="line">dcpl_id (IN): The group creation property list. It contains all the group creation properties in</div>
<div class="line"> addition to the link creation property list of the create operation (an <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a>) that can be</div>
<div class="line"> retrieved with the property H5VL_GRP_LCPL_ID.</div>
<div class="line">gapl_id (IN): The group access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefGrpopen"></a>
group: open</h3>
<p>The <em>open</em> callback in the group class opens a group object in the container of the location object and returns a pointer to the group structure containing information to access the group in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to an object where the group needs to be opened or where the look-up of the target object needs to start.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">name (IN): The name of the group to be opened.</div>
<div class="line">gapl_id (IN): The group access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefGrpget"></a>
group: get</h3>
<p>The <em>get</em> callback in the group class retrieves information about the group as specified in the <em>get_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The group object where information needs to be retrieved from.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for group 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdf">H5VL_group_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdfae39c8b6a3da705544c0c2d71cf89d1de">H5VL_GROUP_GET_GCPL</a>, <span class="comment">/* group creation property list */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdfa3b16d763cbaf30054b1eccfe4b18738e">H5VL_GROUP_GET_INFO</a> <span class="comment">/* group info */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdf">H5VL_group_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for group 'get_info' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__group__get__info__args__t.html">H5VL_group_get_info_args_t</a> {</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__get__info__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">loc_params</a>; <span class="comment">/* Location parameters for object access */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_g__info__t.html">H5G_info_t</a> *<a class="code hl_variable" href="struct_h5_v_l__group__get__info__args__t.html#a7201e515498e21b8b16300b02a868597">ginfo</a>; <span class="comment">/* Group info (OUT) */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__group__get__info__args__t.html">H5VL_group_get_info_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for group 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdf">H5VL_group_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__get__args__t.html#a10ca985fc59599e9bf24d86c6a40ca39">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_GROUP_GET_GCPL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__get__args__t.html#adaa50b67271240ed208c995eb2407245">gcpl_id</a>; <span class="comment">/* Group creation property list (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__get__args__t.html#a2b17b1408c994752591b96ba14759670">get_gcpl</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_GROUP_GET_INFO */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__group__get__info__args__t.html">H5VL_group_get_info_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__get__args__t.html#a578d5d1bb73d5528b90c0fbd8e7a5797">get_info</a>; <span class="comment">/* Group info */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__get__args__t.html#ae036134e1252861178559207f1ade3cd">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a65f430c05c745b39b8f9664780bd1cdf"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdf">H5VL_group_get_t</a></div><div class="ttdeci">H5VL_group_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:490</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a65f430c05c745b39b8f9664780bd1cdfa3b16d763cbaf30054b1eccfe4b18738e"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdfa3b16d763cbaf30054b1eccfe4b18738e">H5VL_GROUP_GET_INFO</a></div><div class="ttdeci">@ H5VL_GROUP_GET_INFO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:492</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a65f430c05c745b39b8f9664780bd1cdfae39c8b6a3da705544c0c2d71cf89d1de"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a65f430c05c745b39b8f9664780bd1cdfae39c8b6a3da705544c0c2d71cf89d1de">H5VL_GROUP_GET_GCPL</a></div><div class="ttdeci">@ H5VL_GROUP_GET_GCPL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:491</div></div>
<div class="ttc" id="astruct_h5_g__info__t_html"><div class="ttname"><a href="struct_h5_g__info__t.html">H5G_info_t</a></div><div class="ttdef"><b>Definition</b> H5Gpublic.h:55</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html_a10ca985fc59599e9bf24d86c6a40ca39"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html#a10ca985fc59599e9bf24d86c6a40ca39">H5VL_group_get_args_t::op_type</a></div><div class="ttdeci">H5VL_group_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:503</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html_a2b17b1408c994752591b96ba14759670"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html#a2b17b1408c994752591b96ba14759670">H5VL_group_get_args_t::get_gcpl</a></div><div class="ttdeci">struct H5VL_group_get_args_t::@68::@69 get_gcpl</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html_a578d5d1bb73d5528b90c0fbd8e7a5797"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html#a578d5d1bb73d5528b90c0fbd8e7a5797">H5VL_group_get_args_t::get_info</a></div><div class="ttdeci">H5VL_group_get_info_args_t get_info</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:513</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html_adaa50b67271240ed208c995eb2407245"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html#adaa50b67271240ed208c995eb2407245">H5VL_group_get_args_t::gcpl_id</a></div><div class="ttdeci">hid_t gcpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:509</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__args__t_html_ae036134e1252861178559207f1ade3cd"><div class="ttname"><a href="struct_h5_v_l__group__get__args__t.html#ae036134e1252861178559207f1ade3cd">H5VL_group_get_args_t::args</a></div><div class="ttdeci">union H5VL_group_get_args_t::@68 args</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__info__args__t_html"><div class="ttname"><a href="struct_h5_v_l__group__get__info__args__t.html">H5VL_group_get_info_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:496</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__info__args__t_html_a5bf5017b0f72740c83ee50b1ee3023ad"><div class="ttname"><a href="struct_h5_v_l__group__get__info__args__t.html#a5bf5017b0f72740c83ee50b1ee3023ad">H5VL_group_get_info_args_t::loc_params</a></div><div class="ttdeci">H5VL_loc_params_t loc_params</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:497</div></div>
<div class="ttc" id="astruct_h5_v_l__group__get__info__args__t_html_a7201e515498e21b8b16300b02a868597"><div class="ttname"><a href="struct_h5_v_l__group__get__info__args__t.html#a7201e515498e21b8b16300b02a868597">H5VL_group_get_info_args_t::ginfo</a></div><div class="ttdeci">H5G_info_t * ginfo</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:498</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefGrpspec"></a>
group: specific</h3>
<p>The <em>specific</em> callback in the group class implements specific operations on HDF5 groups as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for group 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565">H5VL_group_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565a91fb48cd8903ad3bb8a87a71ec734102">H5VL_GROUP_MOUNT</a>, <span class="comment">/* Mount a file on a group */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565a9fe35ebb106d610ef36a97de8f545416">H5VL_GROUP_UNMOUNT</a>, <span class="comment">/* Unmount a file on a group */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565aadb42eba4ff1867d6cd809b640dcc667">H5VL_GROUP_FLUSH</a>, <span class="comment">/* H5Gflush */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565afe3c3a9224e00ec7b2dba2b79298ddcd">H5VL_GROUP_REFRESH</a> <span class="comment">/* H5Grefresh */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565">H5VL_group_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for group 'mount' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__group__spec__mount__args__t.html">H5VL_group_spec_mount_args_t</a> {</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__group__spec__mount__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>; <span class="comment">/* Name of location to mount child file */</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__group__spec__mount__args__t.html#aa523d41172cd3fc7b2c9d93dd168e290">child_file</a>; <span class="comment">/* Pointer to child file object */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__spec__mount__args__t.html#a606ab1869ed77d03e087837269790234">fmpl_id</a>; <span class="comment">/* File mount property list to use */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__group__spec__mount__args__t.html">H5VL_group_spec_mount_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for group 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__group__specific__args__t.html">H5VL_group_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565">H5VL_group_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#aae9e2c88692475ef2b8bee6e116bb7fc">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_GROUP_MOUNT */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__group__spec__mount__args__t.html">H5VL_group_spec_mount_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#ac833b1d756df4c0920ae2e5ec5c6a742">mount</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_GROUP_UNMOUNT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>; <span class="comment">/* Name of location to unmount child file */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a6543e2b4f311f62826cb02f5087fc577">unmount</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_GROUP_FLUSH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a450c9c74199b4e8e327320e0f11e1a1b">grp_id</a>; <span class="comment">/* Group ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a3571f840e9cc6583b6816d82ec04f460">flush</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_GROUP_REFRESH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a450c9c74199b4e8e327320e0f11e1a1b">grp_id</a>; <span class="comment">/* Group ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#a72c492de80515dafe43d77c49b59893a">refresh</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__group__specific__args__t.html#af0df77b7f3e4501fdd0fd78ecca4e116">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__group__specific__args__t.html">H5VL_group_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a2d6bb6bde1b8723c9813b572db9e1565"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565">H5VL_group_specific_t</a></div><div class="ttdeci">H5VL_group_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:518</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a2d6bb6bde1b8723c9813b572db9e1565a91fb48cd8903ad3bb8a87a71ec734102"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565a91fb48cd8903ad3bb8a87a71ec734102">H5VL_GROUP_MOUNT</a></div><div class="ttdeci">@ H5VL_GROUP_MOUNT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:519</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a2d6bb6bde1b8723c9813b572db9e1565a9fe35ebb106d610ef36a97de8f545416"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565a9fe35ebb106d610ef36a97de8f545416">H5VL_GROUP_UNMOUNT</a></div><div class="ttdeci">@ H5VL_GROUP_UNMOUNT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:520</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a2d6bb6bde1b8723c9813b572db9e1565aadb42eba4ff1867d6cd809b640dcc667"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565aadb42eba4ff1867d6cd809b640dcc667">H5VL_GROUP_FLUSH</a></div><div class="ttdeci">@ H5VL_GROUP_FLUSH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:521</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a2d6bb6bde1b8723c9813b572db9e1565afe3c3a9224e00ec7b2dba2b79298ddcd"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a2d6bb6bde1b8723c9813b572db9e1565afe3c3a9224e00ec7b2dba2b79298ddcd">H5VL_GROUP_REFRESH</a></div><div class="ttdeci">@ H5VL_GROUP_REFRESH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:522</div></div>
<div class="ttc" id="astruct_h5_v_l__group__spec__mount__args__t_html"><div class="ttname"><a href="struct_h5_v_l__group__spec__mount__args__t.html">H5VL_group_spec_mount_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:526</div></div>
<div class="ttc" id="astruct_h5_v_l__group__spec__mount__args__t_html_a606ab1869ed77d03e087837269790234"><div class="ttname"><a href="struct_h5_v_l__group__spec__mount__args__t.html#a606ab1869ed77d03e087837269790234">H5VL_group_spec_mount_args_t::fmpl_id</a></div><div class="ttdeci">hid_t fmpl_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:529</div></div>
<div class="ttc" id="astruct_h5_v_l__group__spec__mount__args__t_html_a8f8f80d37794cde9472343e4487ba3eb"><div class="ttname"><a href="struct_h5_v_l__group__spec__mount__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">H5VL_group_spec_mount_args_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:527</div></div>
<div class="ttc" id="astruct_h5_v_l__group__spec__mount__args__t_html_aa523d41172cd3fc7b2c9d93dd168e290"><div class="ttname"><a href="struct_h5_v_l__group__spec__mount__args__t.html#aa523d41172cd3fc7b2c9d93dd168e290">H5VL_group_spec_mount_args_t::child_file</a></div><div class="ttdeci">void * child_file</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:528</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_a3571f840e9cc6583b6816d82ec04f460"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#a3571f840e9cc6583b6816d82ec04f460">H5VL_group_specific_args_t::flush</a></div><div class="ttdeci">struct H5VL_group_specific_args_t::@70::@72 flush</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_a450c9c74199b4e8e327320e0f11e1a1b"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#a450c9c74199b4e8e327320e0f11e1a1b">H5VL_group_specific_args_t::grp_id</a></div><div class="ttdeci">hid_t grp_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:548</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_a6543e2b4f311f62826cb02f5087fc577"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#a6543e2b4f311f62826cb02f5087fc577">H5VL_group_specific_args_t::unmount</a></div><div class="ttdeci">struct H5VL_group_specific_args_t::@70::@71 unmount</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_a72c492de80515dafe43d77c49b59893a"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#a72c492de80515dafe43d77c49b59893a">H5VL_group_specific_args_t::refresh</a></div><div class="ttdeci">struct H5VL_group_specific_args_t::@70::@73 refresh</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_a8f8f80d37794cde9472343e4487ba3eb"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#a8f8f80d37794cde9472343e4487ba3eb">H5VL_group_specific_args_t::name</a></div><div class="ttdeci">const char * name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:543</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_aae9e2c88692475ef2b8bee6e116bb7fc"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#aae9e2c88692475ef2b8bee6e116bb7fc">H5VL_group_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_group_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:534</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_ac833b1d756df4c0920ae2e5ec5c6a742"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#ac833b1d756df4c0920ae2e5ec5c6a742">H5VL_group_specific_args_t::mount</a></div><div class="ttdeci">H5VL_group_spec_mount_args_t mount</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:539</div></div>
<div class="ttc" id="astruct_h5_v_l__group__specific__args__t_html_af0df77b7f3e4501fdd0fd78ecca4e116"><div class="ttname"><a href="struct_h5_v_l__group__specific__args__t.html#af0df77b7f3e4501fdd0fd78ecca4e116">H5VL_group_specific_args_t::args</a></div><div class="ttdeci">union H5VL_group_specific_args_t::@70 args</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefGrpopt"></a>
group: optional</h3>
<p>The <em>optional</em> callback in the group class implements connector specific operations on an HDF5 group. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where the operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefGrpclose"></a>
group: close</h3>
<p>The <em>close</em> callback in the group class terminates access to the group object and frees all resources it was consuming, and returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*close)(<span class="keywordtype">void</span> *group, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">group (IN): Pointer to the group object.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefLink"></a>
Link Callbacks</h2>
<p>The link API routines (<a class="el" href="group___h5_l.html">Links (H5L)</a>) allow HDF5 users to create and manage HDF5 links. All the <a class="el" href="group___h5_l.html">Links (H5L)</a> API routines that modify the HDF5 container map to one of the link callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for link callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__link__class__t.html">H5VL_link_class_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#a31c1efa3aa9177bc80cdf14b50f52421">create</a>)(<a class="code hl_struct" href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a> *args, <span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#ab6342d2e7c8deb513e55175f64d471c5">copy</a>)(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#a48572bc238a0dbbb444a5ce24cc24110">move</a>)(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#ac2629a96b496170f387a7ef1c1e142c2">get</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#aeb33703224992df8bddbf470b7f5d84f">specific</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__link__class__t.html#acddb852f82f03004c66c253403b105e2">optional</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__link__class__t.html">H5VL_link_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html">H5VL_link_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:928</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_a31c1efa3aa9177bc80cdf14b50f52421"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#a31c1efa3aa9177bc80cdf14b50f52421">H5VL_link_class_t::create</a></div><div class="ttdeci">herr_t(* create)(H5VL_link_create_args_t *args, void *obj, const H5VL_loc_params_t *loc_params, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:929</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_a48572bc238a0dbbb444a5ce24cc24110"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#a48572bc238a0dbbb444a5ce24cc24110">H5VL_link_class_t::move</a></div><div class="ttdeci">herr_t(* move)(void *src_obj, const H5VL_loc_params_t *loc_params1, void *dst_obj, const H5VL_loc_params_t *loc_params2, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:934</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_ab6342d2e7c8deb513e55175f64d471c5"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#ab6342d2e7c8deb513e55175f64d471c5">H5VL_link_class_t::copy</a></div><div class="ttdeci">herr_t(* copy)(void *src_obj, const H5VL_loc_params_t *loc_params1, void *dst_obj, const H5VL_loc_params_t *loc_params2, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:931</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_ac2629a96b496170f387a7ef1c1e142c2"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#ac2629a96b496170f387a7ef1c1e142c2">H5VL_link_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_link_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:937</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_acddb852f82f03004c66c253403b105e2"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#acddb852f82f03004c66c253403b105e2">H5VL_link_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:941</div></div>
<div class="ttc" id="astruct_h5_v_l__link__class__t_html_aeb33703224992df8bddbf470b7f5d84f"><div class="ttname"><a href="struct_h5_v_l__link__class__t.html#aeb33703224992df8bddbf470b7f5d84f">H5VL_link_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_link_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:939</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:569</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:602</div></div>
<div class="ttc" id="astruct_h5_v_l__link__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:645</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefLinkcreate"></a>
link: create</h3>
<p>The <em>create</em> callback in the group class creates a hard, soft, external, or user-defined link in the container. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*create)(<a class="code hl_struct" href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a> *args, <span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">obj (IN): Pointer to an object where the link needs to be created from.</div>
<div class="line">loc_params (IN): Pointer to the location parameters as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span> for the source object.</div>
<div class="line">lcplid (IN): The link creation property list. It contains all the link creation properties in</div>
<div class="line"> addition to other API parameters depending on the creation type, which will be detailed next.</div>
<div class="line">laplid (IN): The link access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Link create types for VOL */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386">H5VL_link_create_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386a52dc945ab2bef1f954db9d642fa5a56f">H5VL_LINK_CREATE_HARD</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386afa2ce5d5f8fd7ef2ae93f68771211588">H5VL_LINK_CREATE_SOFT</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386a4f51850fd35490934f90e300a5126f20">H5VL_LINK_CREATE_UD</a></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386">H5VL_link_create_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for link 'create' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386">H5VL_link_create_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#a225b85a2fd064cdd25120b1c082c76cc">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_LINK_CREATE_HARD */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#aa5cb00f19493e7ae2dc7d21ea4124669">curr_obj</a>; <span class="comment">/* Current object */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#a5b798d62ea87bdd52fe4f7ff94f9370f">curr_loc_params</a>; <span class="comment">/* Location parameters for current object */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#ac33c90d0964c3caaa55a933c736a5eb8">hard</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_CREATE_SOFT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#afc76fdef3b70ccc173ac51c07b738b9d">target</a>; <span class="comment">/* Target of soft link */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#af64e19f18f0c91c5ceb6cbfb72cc2bf9">soft</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_CREATE_UD */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#a7c59b7f846e24f72fc4c6d21e16ed0ee">type</a>; <span class="comment">/* Type of link to create */</span></div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#a0ccd7535cf45ea4a389b855324c47142">buf</a>; <span class="comment">/* Buffer that contains link info */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of link info buffer */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#ab211b6358e9054c2da7c238629198956">ud</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__create__args__t.html#a2890e6baf9e2b68e0110d5280c383380">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a>;</div>
<div class="ttc" id="a_h5_lpublic_8h_html_a1e3c5d37c60e7a59b0179e26a4094a48"><div class="ttname"><a href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a></div><div class="ttdeci">H5L_type_t</div><div class="ttdoc">Link class types.</div><div class="ttdef"><b>Definition</b> H5Lpublic.h:63</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8cef93e549a23b3fb2b4da12de7b0386"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386">H5VL_link_create_t</a></div><div class="ttdeci">H5VL_link_create_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:562</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8cef93e549a23b3fb2b4da12de7b0386a4f51850fd35490934f90e300a5126f20"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386a4f51850fd35490934f90e300a5126f20">H5VL_LINK_CREATE_UD</a></div><div class="ttdeci">@ H5VL_LINK_CREATE_UD</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:565</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8cef93e549a23b3fb2b4da12de7b0386a52dc945ab2bef1f954db9d642fa5a56f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386a52dc945ab2bef1f954db9d642fa5a56f">H5VL_LINK_CREATE_HARD</a></div><div class="ttdeci">@ H5VL_LINK_CREATE_HARD</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:563</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a8cef93e549a23b3fb2b4da12de7b0386afa2ce5d5f8fd7ef2ae93f68771211588"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a8cef93e549a23b3fb2b4da12de7b0386afa2ce5d5f8fd7ef2ae93f68771211588">H5VL_LINK_CREATE_SOFT</a></div><div class="ttdeci">@ H5VL_LINK_CREATE_SOFT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:564</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_a0ccd7535cf45ea4a389b855324c47142"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#a0ccd7535cf45ea4a389b855324c47142">H5VL_link_create_args_t::buf</a></div><div class="ttdeci">const void * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:588</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_a225b85a2fd064cdd25120b1c082c76cc"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#a225b85a2fd064cdd25120b1c082c76cc">H5VL_link_create_args_t::op_type</a></div><div class="ttdeci">H5VL_link_create_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:570</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_a2890e6baf9e2b68e0110d5280c383380"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#a2890e6baf9e2b68e0110d5280c383380">H5VL_link_create_args_t::args</a></div><div class="ttdeci">union H5VL_link_create_args_t::@74 args</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_a5b798d62ea87bdd52fe4f7ff94f9370f"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#a5b798d62ea87bdd52fe4f7ff94f9370f">H5VL_link_create_args_t::curr_loc_params</a></div><div class="ttdeci">H5VL_loc_params_t curr_loc_params</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:577</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_a7c59b7f846e24f72fc4c6d21e16ed0ee"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#a7c59b7f846e24f72fc4c6d21e16ed0ee">H5VL_link_create_args_t::type</a></div><div class="ttdeci">H5L_type_t type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:587</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_aa5cb00f19493e7ae2dc7d21ea4124669"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#aa5cb00f19493e7ae2dc7d21ea4124669">H5VL_link_create_args_t::curr_obj</a></div><div class="ttdeci">void * curr_obj</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:576</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_ab211b6358e9054c2da7c238629198956"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#ab211b6358e9054c2da7c238629198956">H5VL_link_create_args_t::ud</a></div><div class="ttdeci">struct H5VL_link_create_args_t::@74::@77 ud</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_ac33c90d0964c3caaa55a933c736a5eb8"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#ac33c90d0964c3caaa55a933c736a5eb8">H5VL_link_create_args_t::hard</a></div><div class="ttdeci">struct H5VL_link_create_args_t::@74::@75 hard</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_link_create_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:589</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_af64e19f18f0c91c5ceb6cbfb72cc2bf9"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#af64e19f18f0c91c5ceb6cbfb72cc2bf9">H5VL_link_create_args_t::soft</a></div><div class="ttdeci">struct H5VL_link_create_args_t::@74::@76 soft</div></div>
<div class="ttc" id="astruct_h5_v_l__link__create__args__t_html_afc76fdef3b70ccc173ac51c07b738b9d"><div class="ttname"><a href="struct_h5_v_l__link__create__args__t.html#afc76fdef3b70ccc173ac51c07b738b9d">H5VL_link_create_args_t::target</a></div><div class="ttdeci">const char * target</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:582</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefLinkcopy"></a>
link: copy</h3>
<p>The <em>copy</em> callback in the link class copies a link within the HDF5 container. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*copy)(<span class="keywordtype">void</span> *src_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">src_obj (IN): original/source object or file.</div>
<div class="line">loc_params1 (IN): Pointer to the location parameters for the source object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a> in this callback.</div>
<div class="line">dst_obj (IN): destination object or file.</div>
<div class="line">loc_params2 (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a> in this callback.</div>
<div class="line">lcpl_id (IN): The link creation property list.</div>
<div class="line">lapl_id (IN): The link access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefLinkmove"></a>
link: move</h3>
<p>The <em>move</em> callback in the link class moves a link within the HDF5 container. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*move)(<span class="keywordtype">void</span> *src_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">src_obj (IN): original/source object or file.</div>
<div class="line">loc_params1 (IN): Pointer to the location parameters for the source object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a> in this callback.</div>
<div class="line">dst_obj (IN): destination object or file.</div>
<div class="line">loc_params2 (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a> in this callback.</div>
<div class="line">lcpl_id (IN): The link creation property list.</div>
<div class="line">lapl_id (IN): The link access property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefLinkget"></a>
link: get</h3>
<p>The <em>get</em> callback in the link class retrieves information about links as specified in the <em>get_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The file or group object where information needs to be retrieved from.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a256902987e95589efc0a75b709ae9288">H5VL_OBJECT_BY_NAME</a> or <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2a4e82e176436dfcd528f38d2e76863a1e">H5VL_OBJECT_BY_IDX</a> in this callback.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for link 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5">H5VL_link_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5adfae11f356f74a4c75efb11f18aaf024">H5VL_LINK_GET_INFO</a>, <span class="comment">/* link info */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5a0291fdc5dfdb06f8eebb46e5abf6f9e1">H5VL_LINK_GET_NAME</a>, <span class="comment">/* link name */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5a0d6e014f38ca9e25747bca316c848b36">H5VL_LINK_GET_VAL</a> <span class="comment">/* link value */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5">H5VL_link_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for link 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5">H5VL_link_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#ac0f81331269da3fccb92179c11e77cab">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_LINK_GET_INFO */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_l__info2__t.html">H5L_info2_t</a> *<a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a15d1f85f84b49d204d695eb516f91955">linfo</a>; <span class="comment">/* Pointer to link's info (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a1f702c05e5011ea6b75cc20e98554fd8">get_info</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_GET_NAME */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#ab0cc47d2d65ccc71536a76101750e961">name_size</a>; <span class="comment">/* Size of link name buffer (IN) */</span></div>
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a5ac083a645d964373f022d03df4849c8">name</a>; <span class="comment">/* Buffer for link name (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#ad809338ce51cfdc277261c27b9e11619">name_len</a>; <span class="comment">/* Actual length of link name (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#abadb7c6e0bb155d3ce86fa25ed10044b">get_name</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_GET_VAL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of link value buffer (IN) */</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a5bc5fa69bee375df074734a2c4858604">buf</a>; <span class="comment">/* Buffer for link value (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a36db84aa053963671d2f32813c6c8339">get_val</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__get__args__t.html#a610db1890849ca939668d83b685f3d15">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ad839695aa27e548b79a80416133e35e5"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5">H5VL_link_get_t</a></div><div class="ttdeci">H5VL_link_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:595</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ad839695aa27e548b79a80416133e35e5a0291fdc5dfdb06f8eebb46e5abf6f9e1"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5a0291fdc5dfdb06f8eebb46e5abf6f9e1">H5VL_LINK_GET_NAME</a></div><div class="ttdeci">@ H5VL_LINK_GET_NAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:597</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ad839695aa27e548b79a80416133e35e5a0d6e014f38ca9e25747bca316c848b36"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5a0d6e014f38ca9e25747bca316c848b36">H5VL_LINK_GET_VAL</a></div><div class="ttdeci">@ H5VL_LINK_GET_VAL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:598</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ad839695aa27e548b79a80416133e35e5adfae11f356f74a4c75efb11f18aaf024"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ad839695aa27e548b79a80416133e35e5adfae11f356f74a4c75efb11f18aaf024">H5VL_LINK_GET_INFO</a></div><div class="ttdeci">@ H5VL_LINK_GET_INFO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:596</div></div>
<div class="ttc" id="astruct_h5_l__info2__t_html"><div class="ttname"><a href="struct_h5_l__info2__t.html">H5L_info2_t</a></div><div class="ttdoc">Information struct for links.</div><div class="ttdef"><b>Definition</b> H5Lpublic.h:87</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a15d1f85f84b49d204d695eb516f91955"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a15d1f85f84b49d204d695eb516f91955">H5VL_link_get_args_t::linfo</a></div><div class="ttdeci">H5L_info2_t * linfo</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:609</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a1f702c05e5011ea6b75cc20e98554fd8"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a1f702c05e5011ea6b75cc20e98554fd8">H5VL_link_get_args_t::get_info</a></div><div class="ttdeci">struct H5VL_link_get_args_t::@78::@79 get_info</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a36db84aa053963671d2f32813c6c8339"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a36db84aa053963671d2f32813c6c8339">H5VL_link_get_args_t::get_val</a></div><div class="ttdeci">struct H5VL_link_get_args_t::@78::@81 get_val</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a5ac083a645d964373f022d03df4849c8"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a5ac083a645d964373f022d03df4849c8">H5VL_link_get_args_t::name</a></div><div class="ttdeci">char * name</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:615</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a5bc5fa69bee375df074734a2c4858604"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a5bc5fa69bee375df074734a2c4858604">H5VL_link_get_args_t::buf</a></div><div class="ttdeci">void * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:622</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_a610db1890849ca939668d83b685f3d15"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#a610db1890849ca939668d83b685f3d15">H5VL_link_get_args_t::args</a></div><div class="ttdeci">union H5VL_link_get_args_t::@78 args</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_ab0cc47d2d65ccc71536a76101750e961"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#ab0cc47d2d65ccc71536a76101750e961">H5VL_link_get_args_t::name_size</a></div><div class="ttdeci">size_t name_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:614</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_abadb7c6e0bb155d3ce86fa25ed10044b"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#abadb7c6e0bb155d3ce86fa25ed10044b">H5VL_link_get_args_t::get_name</a></div><div class="ttdeci">struct H5VL_link_get_args_t::@78::@80 get_name</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_ac0f81331269da3fccb92179c11e77cab"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#ac0f81331269da3fccb92179c11e77cab">H5VL_link_get_args_t::op_type</a></div><div class="ttdeci">H5VL_link_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:603</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_ad809338ce51cfdc277261c27b9e11619"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#ad809338ce51cfdc277261c27b9e11619">H5VL_link_get_args_t::name_len</a></div><div class="ttdeci">size_t * name_len</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:616</div></div>
<div class="ttc" id="astruct_h5_v_l__link__get__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__link__get__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_link_get_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:621</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefLinkspec"></a>
link: specific</h3>
<p>The <em>specific</em> callback in the link class implements specific operations on HDF5 links as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The location object where operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for link 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60">H5VL_link_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60ab15e04ae2e2c683fa7c54b0e11a690ef">H5VL_LINK_DELETE</a>, <span class="comment">/* H5Ldelete(_by_idx) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60a9ca6090641c2257302d39018f7c16ba8">H5VL_LINK_EXISTS</a>, <span class="comment">/* link existence */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60a050e4e3a3f7ecd206614cc6f533ae9af">H5VL_LINK_ITER</a> <span class="comment">/* H5Literate/visit(_by_name) */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60">H5VL_link_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for link 'iterate' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__link__iterate__args__t.html">H5VL_link_iterate_args_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#a5fb2ab505fcb956faa180d2ad2ed92ed">recursive</a>; <span class="comment">/* Whether iteration is recursive */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">idx_type</a>; <span class="comment">/* Type of index to iterate over */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">order</a>; <span class="comment">/* Order of index iteration */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *<a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#a1cf8ef76fd3b75d2be1e39b8ce46e838">idx_p</a>; <span class="comment">/* Start/stop iteration index (OUT) */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_lpublic_8h.html#a9f26d305724d0969b3b25e100a109fc9">H5L_iterate2_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#ac1731fba626bde475761b0a7a1780b90">op</a>; <span class="comment">/* Iteration callback function */</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__link__iterate__args__t.html#aa1649fef45b8c728cf110597e5d51f45">op_data</a>; <span class="comment">/* Iteration callback context */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__link__iterate__args__t.html">H5VL_link_iterate_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for link 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60">H5VL_link_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__specific__args__t.html#a8eeab7f9a50027e1d0216c762eaa313d">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_LINK_DELETE */</span></div>
<div class="line"> <span class="comment">/* No args */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_EXISTS */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__link__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>; <span class="comment">/* Whether link exists (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_LINK_ITER */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__link__iterate__args__t.html">H5VL_link_iterate_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__link__specific__args__t.html#ac6ba2eb1ed6310ec6879ffe1ed55c558">iterate</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__link__specific__args__t.html#aa87638654477279709bc6034833b0035">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_lpublic_8h_html_a9f26d305724d0969b3b25e100a109fc9"><div class="ttname"><a href="_h5_lpublic_8h.html#a9f26d305724d0969b3b25e100a109fc9">H5L_iterate2_t</a></div><div class="ttdeci">herr_t(* H5L_iterate2_t)(hid_t group, const char *name, const H5L_info2_t *info, void *op_data)</div><div class="ttdoc">Prototype for H5Literate2(), H5Literate_by_name2() operator.</div><div class="ttdef"><b>Definition</b> H5Lpublic.h:105</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a03bf895394e4414592f12930030e4f60"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60">H5VL_link_specific_t</a></div><div class="ttdeci">H5VL_link_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:628</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a03bf895394e4414592f12930030e4f60a050e4e3a3f7ecd206614cc6f533ae9af"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60a050e4e3a3f7ecd206614cc6f533ae9af">H5VL_LINK_ITER</a></div><div class="ttdeci">@ H5VL_LINK_ITER</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:631</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a03bf895394e4414592f12930030e4f60a9ca6090641c2257302d39018f7c16ba8"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60a9ca6090641c2257302d39018f7c16ba8">H5VL_LINK_EXISTS</a></div><div class="ttdeci">@ H5VL_LINK_EXISTS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:630</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a03bf895394e4414592f12930030e4f60ab15e04ae2e2c683fa7c54b0e11a690ef"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a03bf895394e4414592f12930030e4f60ab15e04ae2e2c683fa7c54b0e11a690ef">H5VL_LINK_DELETE</a></div><div class="ttdeci">@ H5VL_LINK_DELETE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:629</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html">H5VL_link_iterate_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:635</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_a15b19bb0dea4b247157e6f62850ec7a0"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">H5VL_link_iterate_args_t::idx_type</a></div><div class="ttdeci">H5_index_t idx_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:637</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_a1cf8ef76fd3b75d2be1e39b8ce46e838"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#a1cf8ef76fd3b75d2be1e39b8ce46e838">H5VL_link_iterate_args_t::idx_p</a></div><div class="ttdeci">hsize_t * idx_p</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:639</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_a5fb2ab505fcb956faa180d2ad2ed92ed"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#a5fb2ab505fcb956faa180d2ad2ed92ed">H5VL_link_iterate_args_t::recursive</a></div><div class="ttdeci">hbool_t recursive</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:636</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_aa1649fef45b8c728cf110597e5d51f45"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#aa1649fef45b8c728cf110597e5d51f45">H5VL_link_iterate_args_t::op_data</a></div><div class="ttdeci">void * op_data</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:641</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_aab445f1d17ed2d51e4ae4a268b1742bb"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">H5VL_link_iterate_args_t::order</a></div><div class="ttdeci">H5_iter_order_t order</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:638</div></div>
<div class="ttc" id="astruct_h5_v_l__link__iterate__args__t_html_ac1731fba626bde475761b0a7a1780b90"><div class="ttname"><a href="struct_h5_v_l__link__iterate__args__t.html#ac1731fba626bde475761b0a7a1780b90">H5VL_link_iterate_args_t::op</a></div><div class="ttdeci">H5L_iterate2_t op</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:640</div></div>
<div class="ttc" id="astruct_h5_v_l__link__specific__args__t_html_a8eeab7f9a50027e1d0216c762eaa313d"><div class="ttname"><a href="struct_h5_v_l__link__specific__args__t.html#a8eeab7f9a50027e1d0216c762eaa313d">H5VL_link_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_link_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:646</div></div>
<div class="ttc" id="astruct_h5_v_l__link__specific__args__t_html_aa87638654477279709bc6034833b0035"><div class="ttname"><a href="struct_h5_v_l__link__specific__args__t.html#aa87638654477279709bc6034833b0035">H5VL_link_specific_args_t::args</a></div><div class="ttdeci">union H5VL_link_specific_args_t::@82 args</div></div>
<div class="ttc" id="astruct_h5_v_l__link__specific__args__t_html_ac6ba2eb1ed6310ec6879ffe1ed55c558"><div class="ttname"><a href="struct_h5_v_l__link__specific__args__t.html#ac6ba2eb1ed6310ec6879ffe1ed55c558">H5VL_link_specific_args_t::iterate</a></div><div class="ttdeci">H5VL_link_iterate_args_t iterate</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:659</div></div>
<div class="ttc" id="astruct_h5_v_l__link__specific__args__t_html_add8bec1c37b33ec46a87709a31b07e3e"><div class="ttname"><a href="struct_h5_v_l__link__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">H5VL_link_specific_args_t::exists</a></div><div class="ttdeci">hbool_t * exists</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:655</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefLinkopt"></a>
link: optional</h3>
<p>The <em>optional</em> callback in the link class implements connector specific operations on an HDF5 link. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h2><a class="anchor" id="subsecVOLRefObj"></a>
Object Callbacks</h2>
<p>The object API routines (<a class="el" href="group___h5_o.html">Objects (H5O)</a>) allow HDF5 users to manage HDF5 group, dataset, and named datatype objects. All the <a class="el" href="group___h5_o.html">Objects (H5O)</a> API routines that modify the HDF5 container map to one of the object callback routines in this class that the connector needs to implement.</p>
<p><em>Structure for object callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__object__class__t.html">H5VL_object_class_t</a> {</div>
<div class="line"> <span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> *opened_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__object__class__t.html#ae4e60ba7b856841b2d49a36c19ef4631">copy</a>)(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keyword">const</span> <span class="keywordtype">char</span> *src_name, <span class="keywordtype">void</span> *dst_obj,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <span class="keyword">const</span> <span class="keywordtype">char</span> *dst_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> ocpypl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__object__class__t.html#a1d17d87fc70e8360290c0f9e8ac9dd19">get</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__object__class__t.html#a834de40803b304f7d867649fed037aa6">specific</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__object__class__t.html#acddb852f82f03004c66c253403b105e2">optional</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__object__class__t.html">H5VL_object_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__object__class__t_html"><div class="ttname"><a href="struct_h5_v_l__object__class__t.html">H5VL_object_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:946</div></div>
<div class="ttc" id="astruct_h5_v_l__object__class__t_html_a1d17d87fc70e8360290c0f9e8ac9dd19"><div class="ttname"><a href="struct_h5_v_l__object__class__t.html#a1d17d87fc70e8360290c0f9e8ac9dd19">H5VL_object_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_object_get_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:952</div></div>
<div class="ttc" id="astruct_h5_v_l__object__class__t_html_a834de40803b304f7d867649fed037aa6"><div class="ttname"><a href="struct_h5_v_l__object__class__t.html#a834de40803b304f7d867649fed037aa6">H5VL_object_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_object_specific_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:954</div></div>
<div class="ttc" id="astruct_h5_v_l__object__class__t_html_acddb852f82f03004c66c253403b105e2"><div class="ttname"><a href="struct_h5_v_l__object__class__t.html#acddb852f82f03004c66c253403b105e2">H5VL_object_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, const H5VL_loc_params_t *loc_params, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:956</div></div>
<div class="ttc" id="astruct_h5_v_l__object__class__t_html_ae4e60ba7b856841b2d49a36c19ef4631"><div class="ttname"><a href="struct_h5_v_l__object__class__t.html#ae4e60ba7b856841b2d49a36c19ef4631">H5VL_object_class_t::copy</a></div><div class="ttdeci">herr_t(* copy)(void *src_obj, const H5VL_loc_params_t *loc_params1, const char *src_name, void *dst_obj, const H5VL_loc_params_t *loc_params2, const char *dst_name, hid_t ocpypl_id, hid_t lcpl_id, hid_t dxpl_id, void **req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:949</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:676</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefObjopen"></a>
object: open</h3>
<p>The <em>open</em> callback in the object class opens the object in the container of the location object and returns a pointer to the object structure containing information to access the object in future calls. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *(*open)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> *opened_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The container or object where operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">opened_type (OUT): Buffer to return the type of the object opened (<a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a> or <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a> or <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a>).</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
<div class="ttc" id="a_h5_ipublic_8h_html_a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6"><div class="ttname"><a href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a></div><div class="ttdeci">@ H5I_GROUP</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:38</div></div>
<div class="ttc" id="a_h5_ipublic_8h_html_a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987"><div class="ttname"><a href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a></div><div class="ttdeci">@ H5I_DATASET</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:41</div></div>
<div class="ttc" id="a_h5_ipublic_8h_html_a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64"><div class="ttname"><a href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a></div><div class="ttdeci">@ H5I_DATATYPE</div><div class="ttdef"><b>Definition</b> H5Ipublic.h:39</div></div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefObjcopy"></a>
object: copy</h3>
<p>The <em>copy</em> callback in the object class copies the object from the source object to the destination object. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*copy)(<span class="keywordtype">void</span> *src_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keyword">const</span> <span class="keywordtype">char</span> *src_name, <span class="keywordtype">void</span> *dst_obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <span class="keyword">const</span> <span class="keywordtype">char</span> *dst_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> ocpypl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">src_obj (IN): Pointer to location of the source object to be copied.</div>
<div class="line">loc_params1 (IN): Pointer to the location parameters for the source object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">src_name (IN): Name of the source object to be copied.</div>
<div class="line">dst_obj (IN): Pointer to location of the destination object or file.</div>
<div class="line">loc_params2 (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line"> The type can be only <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a69fb5f76c678a35c3e7bae98c4f2c9f2ad0da87ca147a4a0507862eb8455c4b0e">H5VL_OBJECT_BY_SELF</a> in this callback.</div>
<div class="line">dst_name (IN): Name o be assigned to the new copy.</div>
<div class="line">ocpypl_id (IN): The object copy property list.</div>
<div class="line">lcpl_id (IN): The link creation property list.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req (IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefObjget"></a>
object: get</h3>
<p>The <em>get</em> callback in the object class retrieves information about the object as specified in the <em>get_type</em> parameter.It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): A location object where information needs to be retrieved from.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for object 'get' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526e">H5VL_object_get_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eaa179e57b1c18a9fd2c5f7cb0cd138692">H5VL_OBJECT_GET_FILE</a>, <span class="comment">/* object file */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eac0fe97360433711d6a7060cd536e6242">H5VL_OBJECT_GET_NAME</a>, <span class="comment">/* object name */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526ea6a873ff5fcd4060f3c179552b44ebb44">H5VL_OBJECT_GET_TYPE</a>, <span class="comment">/* object type */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eaf66f04c3e08e2d2f26b794102dd94f1f">H5VL_OBJECT_GET_INFO</a> <span class="comment">/* H5Oget_info(_by_idx|name) */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526e">H5VL_object_get_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for object 'get' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526e">H5VL_object_get_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#aa70fcb2e2b1a6c10b5fb4c83f011c352">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_GET_FILE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">void</span> **<a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a763d005405f708ac1e07281969678423">file</a>; <span class="comment">/* File object (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a5a7448d9b7c63539efb6d7fba3c653c9">get_file</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_GET_NAME */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#ae6563dde7454192031694b48405393d7">buf_size</a>; <span class="comment">/* Size of name buffer (IN) */</span></div>
<div class="line"> <span class="keywordtype">char</span> *<a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">buf</a>; <span class="comment">/* Buffer for name (OUT) */</span></div>
<div class="line"> <span class="keywordtype">size_t</span> *<a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#ad809338ce51cfdc277261c27b9e11619">name_len</a>; <span class="comment">/* Actual length of name (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a3edcc75be0a5e02fa98d06e4c8167724">get_name</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_GET_TYPE */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> *<a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#af82707bd9c96143c0aeeebd4692ec91e">obj_type</a>; <span class="comment">/* Type of object (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a9f2ccb4c12181eb9bb72750d2167a2e5">get_type</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_GET_INFO */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a807484b480420922f8646f90f5fe3bda">fields</a>; <span class="comment">/* Flags for fields to retrieve */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_o__info2__t.html">H5O_info2_t</a> *<a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a8ad8fad4efc6ec1733a37ecade29646a">oinfo</a>; <span class="comment">/* Pointer to object info (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#a1db5d057c2031ce0a3d58f5d2ad14712">get_info</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__get__args__t.html#aaac2e32312c1a4b38944b20e1a10c27c">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a>;</div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdec"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a></div><div class="ttdeci">H5O_type_t</div><div class="ttdef"><b>Definition</b> H5Opublic.h:107</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab745a5955edee348875cb2312c9d526e"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526e">H5VL_object_get_t</a></div><div class="ttdeci">H5VL_object_get_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:668</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab745a5955edee348875cb2312c9d526ea6a873ff5fcd4060f3c179552b44ebb44"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526ea6a873ff5fcd4060f3c179552b44ebb44">H5VL_OBJECT_GET_TYPE</a></div><div class="ttdeci">@ H5VL_OBJECT_GET_TYPE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:671</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab745a5955edee348875cb2312c9d526eaa179e57b1c18a9fd2c5f7cb0cd138692"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eaa179e57b1c18a9fd2c5f7cb0cd138692">H5VL_OBJECT_GET_FILE</a></div><div class="ttdeci">@ H5VL_OBJECT_GET_FILE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:669</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab745a5955edee348875cb2312c9d526eac0fe97360433711d6a7060cd536e6242"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eac0fe97360433711d6a7060cd536e6242">H5VL_OBJECT_GET_NAME</a></div><div class="ttdeci">@ H5VL_OBJECT_GET_NAME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:670</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_ab745a5955edee348875cb2312c9d526eaf66f04c3e08e2d2f26b794102dd94f1f"><div class="ttname"><a href="_h5_v_lconnector_8h.html#ab745a5955edee348875cb2312c9d526eaf66f04c3e08e2d2f26b794102dd94f1f">H5VL_OBJECT_GET_INFO</a></div><div class="ttdeci">@ H5VL_OBJECT_GET_INFO</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:672</div></div>
<div class="ttc" id="astruct_h5_o__info2__t_html"><div class="ttname"><a href="struct_h5_o__info2__t.html">H5O_info2_t</a></div><div class="ttdef"><b>Definition</b> H5Opublic.h:145</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a1db5d057c2031ce0a3d58f5d2ad14712"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a1db5d057c2031ce0a3d58f5d2ad14712">H5VL_object_get_args_t::get_info</a></div><div class="ttdeci">struct H5VL_object_get_args_t::@84::@88 get_info</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a1fe855c208bc17a51a4d34fefdb2d5b1"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a1fe855c208bc17a51a4d34fefdb2d5b1">H5VL_object_get_args_t::buf</a></div><div class="ttdeci">char * buf</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:689</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a3edcc75be0a5e02fa98d06e4c8167724"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a3edcc75be0a5e02fa98d06e4c8167724">H5VL_object_get_args_t::get_name</a></div><div class="ttdeci">struct H5VL_object_get_args_t::@84::@86 get_name</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a5a7448d9b7c63539efb6d7fba3c653c9"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a5a7448d9b7c63539efb6d7fba3c653c9">H5VL_object_get_args_t::get_file</a></div><div class="ttdeci">struct H5VL_object_get_args_t::@84::@85 get_file</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a763d005405f708ac1e07281969678423"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a763d005405f708ac1e07281969678423">H5VL_object_get_args_t::file</a></div><div class="ttdeci">void ** file</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:683</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a807484b480420922f8646f90f5fe3bda"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a807484b480420922f8646f90f5fe3bda">H5VL_object_get_args_t::fields</a></div><div class="ttdeci">unsigned fields</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:700</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a8ad8fad4efc6ec1733a37ecade29646a"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a8ad8fad4efc6ec1733a37ecade29646a">H5VL_object_get_args_t::oinfo</a></div><div class="ttdeci">H5O_info2_t * oinfo</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:701</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_a9f2ccb4c12181eb9bb72750d2167a2e5"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#a9f2ccb4c12181eb9bb72750d2167a2e5">H5VL_object_get_args_t::get_type</a></div><div class="ttdeci">struct H5VL_object_get_args_t::@84::@87 get_type</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_aa70fcb2e2b1a6c10b5fb4c83f011c352"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#aa70fcb2e2b1a6c10b5fb4c83f011c352">H5VL_object_get_args_t::op_type</a></div><div class="ttdeci">H5VL_object_get_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:677</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_aaac2e32312c1a4b38944b20e1a10c27c"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#aaac2e32312c1a4b38944b20e1a10c27c">H5VL_object_get_args_t::args</a></div><div class="ttdeci">union H5VL_object_get_args_t::@84 args</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_ad809338ce51cfdc277261c27b9e11619"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#ad809338ce51cfdc277261c27b9e11619">H5VL_object_get_args_t::name_len</a></div><div class="ttdeci">size_t * name_len</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:690</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_ae6563dde7454192031694b48405393d7"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#ae6563dde7454192031694b48405393d7">H5VL_object_get_args_t::buf_size</a></div><div class="ttdeci">size_t buf_size</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:688</div></div>
<div class="ttc" id="astruct_h5_v_l__object__get__args__t_html_af82707bd9c96143c0aeeebd4692ec91e"><div class="ttname"><a href="struct_h5_v_l__object__get__args__t.html#af82707bd9c96143c0aeeebd4692ec91e">H5VL_object_get_args_t::obj_type</a></div><div class="ttdeci">H5O_type_t * obj_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:695</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefObjspec"></a>
object: specific</h3>
<p>The <em>specific</em> callback in the object class implements specific operations on HDF5 objects as specified in the <em>specific_type</em> parameter. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): A location object where he operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for object 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867">H5VL_object_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a360f6e624b31a3acc685dd9718a22348">H5VL_OBJECT_CHANGE_REF_COUNT</a>, <span class="comment">/* H5Oincr/decr_refcount */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a028b6cfd944dffb3bc87a598e52890ec">H5VL_OBJECT_EXISTS</a>, <span class="comment">/* H5Oexists_by_name */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a5f61abca48ce2e96f476894572c73250">H5VL_OBJECT_LOOKUP</a>, <span class="comment">/* Lookup object */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867ab2b90a1c6de2d3a0ea2a54a1b1143ab3">H5VL_OBJECT_VISIT</a>, <span class="comment">/* H5Ovisit(_by_name) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867acc85e8ba48c6f3af0f1c88076d5be7f5">H5VL_OBJECT_FLUSH</a>, <span class="comment">/* H5{D|G|O|T}flush */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867aeae649ec107e77a2e82057aac1459b8b">H5VL_OBJECT_REFRESH</a> <span class="comment">/* H5{D|G|O|T}refresh */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867">H5VL_object_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for object 'visit' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__object__visit__args__t.html">H5VL_object_visit_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__visit__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">idx_type</a>; <span class="comment">/* Type of index to iterate over */</span></div>
<div class="line"> <a class="code hl_enumeration" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__visit__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">order</a>; <span class="comment">/* Order of index iteration */</span></div>
<div class="line"> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="struct_h5_v_l__object__visit__args__t.html#a807484b480420922f8646f90f5fe3bda">fields</a>; <span class="comment">/* Flags for fields to provide in 'info' object for 'op' callback */</span></div>
<div class="line"> <a class="code hl_typedef" href="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__visit__args__t.html#a3e5fd7b970d501a1bc3ff144ded1daba">op</a>; <span class="comment">/* Iteration callback function */</span></div>
<div class="line"> <span class="keywordtype">void</span> *<a class="code hl_variable" href="struct_h5_v_l__object__visit__args__t.html#aa1649fef45b8c728cf110597e5d51f45">op_data</a>; <span class="comment">/* Iteration callback context */</span></div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__object__visit__args__t.html">H5VL_object_visit_args_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for object 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867">H5VL_object_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a2b1418bc18b1dcaa0c06e2fc6bd06833">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_CHANGE_REF_COUNT */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keywordtype">int</span> <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a1dfcb70b9229f2da17dd5922b87ecf2c">delta</a>; <span class="comment">/* Amount to modify object's refcount */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a06cb2ffa88eb6ac402193853f975876d">change_rc</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_EXISTS */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>; <span class="comment">/* Whether object exists (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">exists</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_LOOKUP */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *<a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#acd436138e228843c3d6e9eb44621b6fd">token_ptr</a>; <span class="comment">/* Pointer to token for lookup (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a0842c6127a08a66ee6cb1ca3d1048d0d">lookup</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_VISIT */</span></div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__object__visit__args__t.html">H5VL_object_visit_args_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a02994fae7c880caf93c076e4ed930ded">visit</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_FLUSH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a94ecc5a5534ea8f4f1a5d5020ac1e5ce">obj_id</a>; <span class="comment">/* Object ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a809781ac38823a22519b352ef1675295">flush</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_OBJECT_REFRESH */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a94ecc5a5534ea8f4f1a5d5020ac1e5ce">obj_id</a>; <span class="comment">/* Object ID (IN) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#a4a4ee88f91fc4763a24a3649dd5ca123">refresh</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__object__specific__args__t.html#adfe15d007833cc6e1f50d9ae33c84acc">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_opublic_8h_html_a564cec62aef0389091ad21d235aa321c"><div class="ttname"><a href="_h5_opublic_8h.html#a564cec62aef0389091ad21d235aa321c">H5O_iterate2_t</a></div><div class="ttdeci">herr_t(* H5O_iterate2_t)(hid_t obj, const char *name, const H5O_info2_t *info, void *op_data)</div><div class="ttdef"><b>Definition</b> H5Opublic.h:193</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867">H5VL_object_specific_t</a></div><div class="ttdeci">H5VL_object_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:707</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867a028b6cfd944dffb3bc87a598e52890ec"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a028b6cfd944dffb3bc87a598e52890ec">H5VL_OBJECT_EXISTS</a></div><div class="ttdeci">@ H5VL_OBJECT_EXISTS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:709</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867a360f6e624b31a3acc685dd9718a22348"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a360f6e624b31a3acc685dd9718a22348">H5VL_OBJECT_CHANGE_REF_COUNT</a></div><div class="ttdeci">@ H5VL_OBJECT_CHANGE_REF_COUNT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:708</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867a5f61abca48ce2e96f476894572c73250"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867a5f61abca48ce2e96f476894572c73250">H5VL_OBJECT_LOOKUP</a></div><div class="ttdeci">@ H5VL_OBJECT_LOOKUP</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:710</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867ab2b90a1c6de2d3a0ea2a54a1b1143ab3"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867ab2b90a1c6de2d3a0ea2a54a1b1143ab3">H5VL_OBJECT_VISIT</a></div><div class="ttdeci">@ H5VL_OBJECT_VISIT</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:711</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867acc85e8ba48c6f3af0f1c88076d5be7f5"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867acc85e8ba48c6f3af0f1c88076d5be7f5">H5VL_OBJECT_FLUSH</a></div><div class="ttdeci">@ H5VL_OBJECT_FLUSH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:712</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a21596f5008ac90a1daec63fa330d5867aeae649ec107e77a2e82057aac1459b8b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a21596f5008ac90a1daec63fa330d5867aeae649ec107e77a2e82057aac1459b8b">H5VL_OBJECT_REFRESH</a></div><div class="ttdeci">@ H5VL_OBJECT_REFRESH</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:713</div></div>
<div class="ttc" id="astruct_h5_o__token__t_html"><div class="ttname"><a href="struct_h5_o__token__t.html">H5O_token_t</a></div><div class="ttdef"><b>Definition</b> H5public.h:400</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a02994fae7c880caf93c076e4ed930ded"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a02994fae7c880caf93c076e4ed930ded">H5VL_object_specific_args_t::visit</a></div><div class="ttdeci">H5VL_object_visit_args_t visit</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:747</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a06cb2ffa88eb6ac402193853f975876d"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a06cb2ffa88eb6ac402193853f975876d">H5VL_object_specific_args_t::change_rc</a></div><div class="ttdeci">struct H5VL_object_specific_args_t::@89::@90 change_rc</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a0842c6127a08a66ee6cb1ca3d1048d0d"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a0842c6127a08a66ee6cb1ca3d1048d0d">H5VL_object_specific_args_t::lookup</a></div><div class="ttdeci">struct H5VL_object_specific_args_t::@89::@92 lookup</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a1dfcb70b9229f2da17dd5922b87ecf2c"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a1dfcb70b9229f2da17dd5922b87ecf2c">H5VL_object_specific_args_t::delta</a></div><div class="ttdeci">int delta</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:733</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a2b1418bc18b1dcaa0c06e2fc6bd06833"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a2b1418bc18b1dcaa0c06e2fc6bd06833">H5VL_object_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_object_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:727</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a4a4ee88f91fc4763a24a3649dd5ca123"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a4a4ee88f91fc4763a24a3649dd5ca123">H5VL_object_specific_args_t::refresh</a></div><div class="ttdeci">struct H5VL_object_specific_args_t::@89::@94 refresh</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a809781ac38823a22519b352ef1675295"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a809781ac38823a22519b352ef1675295">H5VL_object_specific_args_t::flush</a></div><div class="ttdeci">struct H5VL_object_specific_args_t::@89::@93 flush</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_a94ecc5a5534ea8f4f1a5d5020ac1e5ce"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#a94ecc5a5534ea8f4f1a5d5020ac1e5ce">H5VL_object_specific_args_t::obj_id</a></div><div class="ttdeci">hid_t obj_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:751</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_acd436138e228843c3d6e9eb44621b6fd"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#acd436138e228843c3d6e9eb44621b6fd">H5VL_object_specific_args_t::token_ptr</a></div><div class="ttdeci">H5O_token_t * token_ptr</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:743</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_add8bec1c37b33ec46a87709a31b07e3e"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#add8bec1c37b33ec46a87709a31b07e3e">H5VL_object_specific_args_t::exists</a></div><div class="ttdeci">hbool_t * exists</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:738</div></div>
<div class="ttc" id="astruct_h5_v_l__object__specific__args__t_html_adfe15d007833cc6e1f50d9ae33c84acc"><div class="ttname"><a href="struct_h5_v_l__object__specific__args__t.html#adfe15d007833cc6e1f50d9ae33c84acc">H5VL_object_specific_args_t::args</a></div><div class="ttdeci">union H5VL_object_specific_args_t::@89 args</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html">H5VL_object_visit_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:717</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html_a15b19bb0dea4b247157e6f62850ec7a0"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html#a15b19bb0dea4b247157e6f62850ec7a0">H5VL_object_visit_args_t::idx_type</a></div><div class="ttdeci">H5_index_t idx_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:718</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html_a3e5fd7b970d501a1bc3ff144ded1daba"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html#a3e5fd7b970d501a1bc3ff144ded1daba">H5VL_object_visit_args_t::op</a></div><div class="ttdeci">H5O_iterate2_t op</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:721</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html_a807484b480420922f8646f90f5fe3bda"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html#a807484b480420922f8646f90f5fe3bda">H5VL_object_visit_args_t::fields</a></div><div class="ttdeci">unsigned fields</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:720</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html_aa1649fef45b8c728cf110597e5d51f45"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html#aa1649fef45b8c728cf110597e5d51f45">H5VL_object_visit_args_t::op_data</a></div><div class="ttdeci">void * op_data</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:722</div></div>
<div class="ttc" id="astruct_h5_v_l__object__visit__args__t_html_aab445f1d17ed2d51e4ae4a268b1742bb"><div class="ttname"><a href="struct_h5_v_l__object__visit__args__t.html#aab445f1d17ed2d51e4ae4a268b1742bb">H5VL_object_visit_args_t::order</a></div><div class="ttdeci">H5_iter_order_t order</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:719</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefObjopt"></a>
object: optional</h3>
<p>The <em>optional</em> callback in the object class implements connector specific operations on an HDF5 object. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): A container or object where he operation needs to happen.</div>
<div class="line">loc_params (IN): Pointer to the location parameters for the destination object as explained in <span class="stringliteral">"Mapping the API to the Callbacks"</span>.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h2><a class="anchor" id="subsecVOLRefIntrospect"></a>
Introspection Callbacks</h2>
<p><em>Structure for VOL connector introspection callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__introspect__class__t.html">H5VL_introspect_class_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__introspect__class__t.html#a2b1626a2b2a7ecc76c34de7b5c23017b">get_conn_cls</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a> lvl, <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> **conn_cls);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__introspect__class__t.html#a4269a6123ef519ae06305f6e95bbfca9">get_cap_flags</a>)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, uint64_t *cap_flags);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__introspect__class__t.html#a51f75a0a76567bfd0430adb68f87101b">opt_query</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> cls, <span class="keywordtype">int</span> opt_type, uint64_t *flags);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__introspect__class__t.html">H5VL_introspect_class_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a72dd04b7264916fe5cdfc5970fe8ae21"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a></div><div class="ttdeci">H5VL_get_conn_lvl_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:964</div></div>
<div class="ttc" id="astruct_h5_v_l__introspect__class__t_html"><div class="ttname"><a href="struct_h5_v_l__introspect__class__t.html">H5VL_introspect_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:975</div></div>
<div class="ttc" id="astruct_h5_v_l__introspect__class__t_html_a2b1626a2b2a7ecc76c34de7b5c23017b"><div class="ttname"><a href="struct_h5_v_l__introspect__class__t.html#a2b1626a2b2a7ecc76c34de7b5c23017b">H5VL_introspect_class_t::get_conn_cls</a></div><div class="ttdeci">herr_t(* get_conn_cls)(void *obj, H5VL_get_conn_lvl_t lvl, const struct H5VL_class_t **conn_cls)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:976</div></div>
<div class="ttc" id="astruct_h5_v_l__introspect__class__t_html_a4269a6123ef519ae06305f6e95bbfca9"><div class="ttname"><a href="struct_h5_v_l__introspect__class__t.html#a4269a6123ef519ae06305f6e95bbfca9">H5VL_introspect_class_t::get_cap_flags</a></div><div class="ttdeci">herr_t(* get_cap_flags)(const void *info, uint64_t *cap_flags)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:977</div></div>
<div class="ttc" id="astruct_h5_v_l__introspect__class__t_html_a51f75a0a76567bfd0430adb68f87101b"><div class="ttname"><a href="struct_h5_v_l__introspect__class__t.html#a51f75a0a76567bfd0430adb68f87101b">H5VL_introspect_class_t::opt_query</a></div><div class="ttdeci">herr_t(* opt_query)(void *obj, H5VL_subclass_t cls, int opt_type, uint64_t *flags)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:978</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefIntrospectcls"></a>
introspect: get_conn_cls</h3>
<p>Get a connector's <a class="el" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> struct. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get_conn_cls)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a> lvl, <span class="keyword">const</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> **conn_cls);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The VOL object.</div>
<div class="line">lvl (IN): Current or terminal connector.</div>
<div class="line">cls (OUT): A const pointer to the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "lvl" argument is an enum:</em> </p><div class="fragment"><div class="line"><span class="comment">/* "Levels" for 'get connector class' introspection callback */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21a8eca5ca176588a85afabb74ef23a5393">H5VL_GET_CONN_LVL_CURR</a>, <span class="comment">/* Get "current" connector (for this object) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21a7849c0441ebf9d6064ac1d2ee44357e2">H5VL_GET_CONN_LVL_TERM</a> <span class="comment">/* Get "terminal" connector (for this object) */</span></div>
<div class="line"> <span class="comment">/* (Recursively called, for pass-through connectors) */</span></div>
<div class="line"> <span class="comment">/* (Connectors that "split" must choose which connector to return) */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a72dd04b7264916fe5cdfc5970fe8ae21a7849c0441ebf9d6064ac1d2ee44357e2"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21a7849c0441ebf9d6064ac1d2ee44357e2">H5VL_GET_CONN_LVL_TERM</a></div><div class="ttdeci">@ H5VL_GET_CONN_LVL_TERM</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:966</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a72dd04b7264916fe5cdfc5970fe8ae21a8eca5ca176588a85afabb74ef23a5393"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21a8eca5ca176588a85afabb74ef23a5393">H5VL_GET_CONN_LVL_CURR</a></div><div class="ttdeci">@ H5VL_GET_CONN_LVL_CURR</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:965</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefIntrospecflags"></a>
introspect: get_cap_flags</h3>
<p>Get a connector's capability flags. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get_cap_flags)(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, <span class="keywordtype">unsigned</span> *<a class="code hl_variable" href="struct_h5_v_l__class__t.html#ac4b405cf0a53f734d273232a82baf247">cap_flags</a>)</div>
<div class="ttc" id="astruct_h5_v_l__class__t_html_ac4b405cf0a53f734d273232a82baf247"><div class="ttname"><a href="struct_h5_v_l__class__t.html#ac4b405cf0a53f734d273232a82baf247">H5VL_class_t::cap_flags</a></div><div class="ttdeci">uint64_t cap_flags</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1017</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">info (IN): A const pointer to pertinent VOL info.</div>
<div class="line"><a class="code hl_variable" href="struct_h5_v_l__class__t.html#ac4b405cf0a53f734d273232a82baf247">cap_flags</a> (OUT): A pointer to capability flags.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefIntrospecquery"></a>
introspect: opt_query</h3>
<p>Query a class for a capability or functionality. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*opt_query)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> cls, <span class="keywordtype">int</span> opt_type, <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *supported);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The VOL object.</div>
<div class="line">cls (IN): The VOL <span class="stringliteral">'class'</span> to query.</div>
<div class="line">opt_type (IN): The specific option to query.</div>
<div class="line">supported (OUT): Whether the operation is supported or not.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "cls" argument is an enum:</em> </p><div class="fragment"><div class="line"><span class="comment">// Enum type for each VOL subclass</span></div>
<div class="line"><span class="comment">// (Used for various queries, etc)</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac05e9c424f4c57ab04bb8a0f27680765">H5VL_SUBCLS_NONE</a>, <span class="comment">// Operations outside of a subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6382b83356def3b14a27c06488a46b62">H5VL_SUBCLS_INFO</a>, <span class="comment">// 'Info' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a834b756ff01e1edb2979a0be92c3518b">H5VL_SUBCLS_WRAP</a>, <span class="comment">// 'Wrap' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac49cca2c43d9a93d28ded5b9dc9a14d1">H5VL_SUBCLS_ATTR</a>, <span class="comment">// 'Attribute' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac9b25c8d8ea5205bf8f0fb654d29a57b">H5VL_SUBCLS_DATASET</a>, <span class="comment">// 'Dataset' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6f3df58583ad3a02b32f1ea9e9a233c7">H5VL_SUBCLS_DATATYPE</a>, <span class="comment">// 'Named datatype' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a8611b474759b782775d303acd28c512f">H5VL_SUBCLS_FILE</a>, <span class="comment">// 'File' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599aeb711151c2a908ae42e18e80bb7a8f1d">H5VL_SUBCLS_GROUP</a>, <span class="comment">// 'Group' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6d1475a46f9db62a48b9362362016e83">H5VL_SUBCLS_LINK</a>, <span class="comment">// 'Link' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a82eb9b3d6f086cafcb446eb86534a813">H5VL_SUBCLS_OBJECT</a>, <span class="comment">// 'Object' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ad23e1011cd67c7280a90ec903f210c08">H5VL_SUBCLS_REQUEST</a>, <span class="comment">// 'Request' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599af6ba173c8e6b99d3df13f26d4f943e66">H5VL_SUBCLS_BLOB</a>, <span class="comment">// 'Blob' subclass</span></div>
<div class="line"> <a class="code hl_enumvalue" href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a3a4313ed710d7a5a5dbfb9ccc354c8ac">H5VL_SUBCLS_TOKEN</a> <span class="comment">// 'Token' subclass</span></div>
<div class="line">} <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a>;</div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a3a4313ed710d7a5a5dbfb9ccc354c8ac"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a3a4313ed710d7a5a5dbfb9ccc354c8ac">H5VL_SUBCLS_TOKEN</a></div><div class="ttdeci">@ H5VL_SUBCLS_TOKEN</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:165</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a6382b83356def3b14a27c06488a46b62"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6382b83356def3b14a27c06488a46b62">H5VL_SUBCLS_INFO</a></div><div class="ttdeci">@ H5VL_SUBCLS_INFO</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:154</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a6d1475a46f9db62a48b9362362016e83"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6d1475a46f9db62a48b9362362016e83">H5VL_SUBCLS_LINK</a></div><div class="ttdeci">@ H5VL_SUBCLS_LINK</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:161</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a6f3df58583ad3a02b32f1ea9e9a233c7"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a6f3df58583ad3a02b32f1ea9e9a233c7">H5VL_SUBCLS_DATATYPE</a></div><div class="ttdeci">@ H5VL_SUBCLS_DATATYPE</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:158</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a82eb9b3d6f086cafcb446eb86534a813"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a82eb9b3d6f086cafcb446eb86534a813">H5VL_SUBCLS_OBJECT</a></div><div class="ttdeci">@ H5VL_SUBCLS_OBJECT</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:162</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a834b756ff01e1edb2979a0be92c3518b"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a834b756ff01e1edb2979a0be92c3518b">H5VL_SUBCLS_WRAP</a></div><div class="ttdeci">@ H5VL_SUBCLS_WRAP</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:155</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599a8611b474759b782775d303acd28c512f"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599a8611b474759b782775d303acd28c512f">H5VL_SUBCLS_FILE</a></div><div class="ttdeci">@ H5VL_SUBCLS_FILE</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:159</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599ac05e9c424f4c57ab04bb8a0f27680765"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac05e9c424f4c57ab04bb8a0f27680765">H5VL_SUBCLS_NONE</a></div><div class="ttdeci">@ H5VL_SUBCLS_NONE</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:153</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599ac49cca2c43d9a93d28ded5b9dc9a14d1"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac49cca2c43d9a93d28ded5b9dc9a14d1">H5VL_SUBCLS_ATTR</a></div><div class="ttdeci">@ H5VL_SUBCLS_ATTR</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:156</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599ac9b25c8d8ea5205bf8f0fb654d29a57b"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ac9b25c8d8ea5205bf8f0fb654d29a57b">H5VL_SUBCLS_DATASET</a></div><div class="ttdeci">@ H5VL_SUBCLS_DATASET</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:157</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599ad23e1011cd67c7280a90ec903f210c08"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599ad23e1011cd67c7280a90ec903f210c08">H5VL_SUBCLS_REQUEST</a></div><div class="ttdeci">@ H5VL_SUBCLS_REQUEST</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:163</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599aeb711151c2a908ae42e18e80bb7a8f1d"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599aeb711151c2a908ae42e18e80bb7a8f1d">H5VL_SUBCLS_GROUP</a></div><div class="ttdeci">@ H5VL_SUBCLS_GROUP</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:160</div></div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_gga14175ca7d867657e3e5c2f79a154a599af6ba173c8e6b99d3df13f26d4f943e66"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#gga14175ca7d867657e3e5c2f79a154a599af6ba173c8e6b99d3df13f26d4f943e66">H5VL_SUBCLS_BLOB</a></div><div class="ttdeci">@ H5VL_SUBCLS_BLOB</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:164</div></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLRefReq"></a>
Request (Async) Callbacks</h2>
<p><em>Structure for async request callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__request__class__t.html">H5VL_request_class_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#a614f5a3d40d4598ea76af50389048265">wait</a>)(<span class="keywordtype">void</span> *req, uint64_t timeout, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#a0b3c8b20e55448d39028caf60abc1d29">notify</a>)(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_v_lconnector_8h.html#a418e1ef08bd10c57dc12f04b1e22f784">H5VL_request_notify_t</a> cb, <span class="keywordtype">void</span> *ctx);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#acea4b5168303e98a0a1d0d1645847108">cancel</a>)(<span class="keywordtype">void</span> *req, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#a7532a1d5f94078199da4dd8e3003583f">specific</a>)(<span class="keywordtype">void</span> *req, <a class="code hl_struct" href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a> *args);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#afe15b6d73a47c3fdcc392bf0291bf632">optional</a>)(<span class="keywordtype">void</span> *req, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__request__class__t.html#acab3db113efe3489c4428d09e0505e30">free</a>)(<span class="keywordtype">void</span> *req);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__request__class__t.html">H5VL_request_class_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a418e1ef08bd10c57dc12f04b1e22f784"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a418e1ef08bd10c57dc12f04b1e22f784">H5VL_request_notify_t</a></div><div class="ttdeci">herr_t(* H5VL_request_notify_t)(void *ctx, H5VL_request_status_t status)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:961</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a></div><div class="ttdeci">H5VL_request_status_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:765</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html">H5VL_request_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:982</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_a0b3c8b20e55448d39028caf60abc1d29"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#a0b3c8b20e55448d39028caf60abc1d29">H5VL_request_class_t::notify</a></div><div class="ttdeci">herr_t(* notify)(void *req, H5VL_request_notify_t cb, void *ctx)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:984</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_a614f5a3d40d4598ea76af50389048265"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#a614f5a3d40d4598ea76af50389048265">H5VL_request_class_t::wait</a></div><div class="ttdeci">herr_t(* wait)(void *req, uint64_t timeout, H5VL_request_status_t *status)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:983</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_a7532a1d5f94078199da4dd8e3003583f"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#a7532a1d5f94078199da4dd8e3003583f">H5VL_request_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *req, H5VL_request_specific_args_t *args)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:986</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_acab3db113efe3489c4428d09e0505e30"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#acab3db113efe3489c4428d09e0505e30">H5VL_request_class_t::free</a></div><div class="ttdeci">herr_t(* free)(void *req)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:988</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_acea4b5168303e98a0a1d0d1645847108"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#acea4b5168303e98a0a1d0d1645847108">H5VL_request_class_t::cancel</a></div><div class="ttdeci">herr_t(* cancel)(void *req, H5VL_request_status_t *status)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:985</div></div>
<div class="ttc" id="astruct_h5_v_l__request__class__t_html_afe15b6d73a47c3fdcc392bf0291bf632"><div class="ttname"><a href="struct_h5_v_l__request__class__t.html#afe15b6d73a47c3fdcc392bf0291bf632">H5VL_request_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *req, H5VL_optional_args_t *args)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:987</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:784</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefReqwait"></a>
request: wait</h3>
<p>Wait (with a timeout) for an async operation to complete. Releases the request if the operation has completed and the connector callback succeeds. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*wait)(<span class="keywordtype">void</span> *req, uint64_t timeout, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request on which to wait.</div>
<div class="line">timeout (IN): The timeout value.</div>
<div class="line">status (IN): The status.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "status" argument is an enum:</em> </p><div class="fragment"><div class="line"><span class="comment">/* Status values for async request operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bae94eba28d39f16c3a3fdf82032c8865b">H5VL_REQUEST_STATUS_IN_PROGRESS</a>, <span class="comment">/* Operation has not yet completed */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba73dca0b9688c46dc9b483fd0fac7fab7">H5VL_REQUEST_STATUS_SUCCEED</a>, <span class="comment">/* Operation has completed, successfully */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bad3b05e3bbcd11850d901da87a1b6cd3a">H5VL_REQUEST_STATUS_FAIL</a>, <span class="comment">/* Operation has completed, but failed */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba77d6a4532e6296c217c54963c1281810">H5VL_REQUEST_STATUS_CANT_CANCEL</a>, <span class="comment">/* An attempt to cancel this operation was made, but it */</span></div>
<div class="line"> <span class="comment">/* can't be canceled immediately. The operation has */</span></div>
<div class="line"> <span class="comment">/* not completed successfully or failed, and is not yet */</span></div>
<div class="line"> <span class="comment">/* in progress. Another attempt to cancel it may be */</span></div>
<div class="line"> <span class="comment">/* attempted and may (or may not) succeed. */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bab369014a266b97505966381bfa9b75bd">H5VL_REQUEST_STATUS_CANCELED</a> <span class="comment">/* Operation has not completed and was canceled */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3ba73dca0b9688c46dc9b483fd0fac7fab7"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba73dca0b9688c46dc9b483fd0fac7fab7">H5VL_REQUEST_STATUS_SUCCEED</a></div><div class="ttdeci">@ H5VL_REQUEST_STATUS_SUCCEED</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:767</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3ba77d6a4532e6296c217c54963c1281810"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba77d6a4532e6296c217c54963c1281810">H5VL_REQUEST_STATUS_CANT_CANCEL</a></div><div class="ttdeci">@ H5VL_REQUEST_STATUS_CANT_CANCEL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:769</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3bab369014a266b97505966381bfa9b75bd"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bab369014a266b97505966381bfa9b75bd">H5VL_REQUEST_STATUS_CANCELED</a></div><div class="ttdeci">@ H5VL_REQUEST_STATUS_CANCELED</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:774</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3bad3b05e3bbcd11850d901da87a1b6cd3a"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bad3b05e3bbcd11850d901da87a1b6cd3a">H5VL_REQUEST_STATUS_FAIL</a></div><div class="ttdeci">@ H5VL_REQUEST_STATUS_FAIL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:768</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a9861877746c10d523dc8d5148f18ac3bae94eba28d39f16c3a3fdf82032c8865b"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bae94eba28d39f16c3a3fdf82032c8865b">H5VL_REQUEST_STATUS_IN_PROGRESS</a></div><div class="ttdeci">@ H5VL_REQUEST_STATUS_IN_PROGRESS</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:766</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefReqnotify"></a>
request: notify</h3>
<p>Registers a user callback to be invoked when an asynchronous operation completes. Releases the request if connector callback succeeds. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*notify)(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_v_lconnector_8h.html#a418e1ef08bd10c57dc12f04b1e22f784">H5VL_request_notify_t</a> cb, <span class="keywordtype">void</span> *ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request that will receive the notify callback.</div>
<div class="line">cb (IN): The notify callback for the request.</div>
<div class="line">ctx (IN): The request<span class="stringliteral">'s context.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "cb" argument is an enum:</em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_v_lconnector_8h.html#a418e1ef08bd10c57dc12f04b1e22f784">H5VL_request_notify_t</a>)(<span class="keywordtype">void</span> *ctx, <a class="code hl_enumeration" href="_h5_e_spublic_8h.html#aec6fb3387e2a9225fcbeaa7cf5d20365">H5ES_status_t</a> status)</div>
<div class="ttc" id="a_h5_e_spublic_8h_html_aec6fb3387e2a9225fcbeaa7cf5d20365"><div class="ttname"><a href="_h5_e_spublic_8h.html#aec6fb3387e2a9225fcbeaa7cf5d20365">H5ES_status_t</a></div><div class="ttdeci">H5ES_status_t</div><div class="ttdef"><b>Definition</b> H5ESpublic.h:49</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefReqcancel"></a>
request: cancel</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*cancel)(<span class="keywordtype">void</span> *req, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request to be cancelled.</div>
<div class="line">status (IN): The status.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "status" argument is an enum:</em> </p><div class="fragment"><div class="line"><span class="comment">/* Status values for async request operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bae94eba28d39f16c3a3fdf82032c8865b">H5VL_REQUEST_STATUS_IN_PROGRESS</a>, <span class="comment">/* Operation has not yet completed */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba73dca0b9688c46dc9b483fd0fac7fab7">H5VL_REQUEST_STATUS_SUCCEED</a>, <span class="comment">/* Operation has completed, successfully */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bad3b05e3bbcd11850d901da87a1b6cd3a">H5VL_REQUEST_STATUS_FAIL</a>, <span class="comment">/* Operation has completed, but failed */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3ba77d6a4532e6296c217c54963c1281810">H5VL_REQUEST_STATUS_CANT_CANCEL</a>, <span class="comment">/* An attempt to cancel this operation was made, but it */</span></div>
<div class="line"> <span class="comment">/* can't be canceled immediately. The operation has */</span></div>
<div class="line"> <span class="comment">/* not completed successfully or failed, and is not yet */</span></div>
<div class="line"> <span class="comment">/* in progress. Another attempt to cancel it may be */</span></div>
<div class="line"> <span class="comment">/* attempted and may (or may not) succeed. */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3bab369014a266b97505966381bfa9b75bd">H5VL_REQUEST_STATUS_CANCELED</a> <span class="comment">/* Operation has not completed and was canceled */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a>;</div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefReqspec"></a>
request: specific</h3>
<p>Perform a specific operation on an asynchronous request. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *req, <a class="code hl_struct" href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a> *args);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request on which to perform the operation.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for async request 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1">H5VL_request_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1a68408be0a2baea1c71776339a4268f79">H5VL_REQUEST_GET_ERR_STACK</a>, <span class="comment">/* Retrieve error stack for failed operation */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1ab21c6d87c43f2b7ed354cfb8dce138cb">H5VL_REQUEST_GET_EXEC_TIME</a> <span class="comment">/* Retrieve execution time for operation */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1">H5VL_request_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for request 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1">H5VL_request_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#ae6ab742777db24bb7e609d486cd74e5c">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_REQUEST_GET_ERR_STACK */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#ac717c89bff4c1eac778f760deec58c31">err_stack_id</a>; <span class="comment">/* Error stack ID for operation (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#aae6e6d1c03fde815a15600ea188cccd7">get_err_stack</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_REQUEST_GET_EXEC_TIME */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> uint64_t *<a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#a40987a5db0a269581e5a866bd0d25fb0">exec_ts</a>; <span class="comment">/* Timestamp for start of task execution (OUT) */</span></div>
<div class="line"> uint64_t *<a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#ad73a499e8abec23c9de6ef4fd7acc255">exec_time</a>; <span class="comment">/* Duration of task execution (in ns) (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#ace03111c5d5bc18a72e59abaac8d0214">get_exec_time</a>;</div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__request__specific__args__t.html#ac411c26b8aa5c4db1d72a85ff586c2ad">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a91890110142de649aa5674e72ba2c8c1"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1">H5VL_request_specific_t</a></div><div class="ttdeci">H5VL_request_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:778</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a91890110142de649aa5674e72ba2c8c1a68408be0a2baea1c71776339a4268f79"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1a68408be0a2baea1c71776339a4268f79">H5VL_REQUEST_GET_ERR_STACK</a></div><div class="ttdeci">@ H5VL_REQUEST_GET_ERR_STACK</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:779</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a91890110142de649aa5674e72ba2c8c1ab21c6d87c43f2b7ed354cfb8dce138cb"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a91890110142de649aa5674e72ba2c8c1ab21c6d87c43f2b7ed354cfb8dce138cb">H5VL_REQUEST_GET_EXEC_TIME</a></div><div class="ttdeci">@ H5VL_REQUEST_GET_EXEC_TIME</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:780</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_a40987a5db0a269581e5a866bd0d25fb0"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#a40987a5db0a269581e5a866bd0d25fb0">H5VL_request_specific_args_t::exec_ts</a></div><div class="ttdeci">uint64_t * exec_ts</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:796</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_aae6e6d1c03fde815a15600ea188cccd7"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#aae6e6d1c03fde815a15600ea188cccd7">H5VL_request_specific_args_t::get_err_stack</a></div><div class="ttdeci">struct H5VL_request_specific_args_t::@95::@96 get_err_stack</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_ac411c26b8aa5c4db1d72a85ff586c2ad"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#ac411c26b8aa5c4db1d72a85ff586c2ad">H5VL_request_specific_args_t::args</a></div><div class="ttdeci">union H5VL_request_specific_args_t::@95 args</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_ac717c89bff4c1eac778f760deec58c31"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#ac717c89bff4c1eac778f760deec58c31">H5VL_request_specific_args_t::err_stack_id</a></div><div class="ttdeci">hid_t err_stack_id</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:791</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_ace03111c5d5bc18a72e59abaac8d0214"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#ace03111c5d5bc18a72e59abaac8d0214">H5VL_request_specific_args_t::get_exec_time</a></div><div class="ttdeci">struct H5VL_request_specific_args_t::@95::@97 get_exec_time</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_ad73a499e8abec23c9de6ef4fd7acc255"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#ad73a499e8abec23c9de6ef4fd7acc255">H5VL_request_specific_args_t::exec_time</a></div><div class="ttdeci">uint64_t * exec_time</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:797</div></div>
<div class="ttc" id="astruct_h5_v_l__request__specific__args__t_html_ae6ab742777db24bb7e609d486cd74e5c"><div class="ttname"><a href="struct_h5_v_l__request__specific__args__t.html#ae6ab742777db24bb7e609d486cd74e5c">H5VL_request_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_request_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:785</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefReqopt"></a>
request: optional</h3>
<p>Perform a connector-specific operation for a request. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *req, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request on which to perform the operation.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct.</p>
<h3><a class="anchor" id="subsubsecVOLRefReqfree"></a>
request: free</h3>
<p>Frees an asynchronous request. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*free)(<span class="keywordtype">void</span> *req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">req (IN): The async request to be freed.</div>
</div><!-- fragment --> </td></tr>
</table>
<h2><a class="anchor" id="subsecVOLRefBlob"></a>
Blob Callbacks</h2>
<p><em>Structure for blob callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__blob__class__t.html">H5VL_blob_class_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__blob__class__t.html#a05cc95b9cd27b93ed81195ca1136c496">put</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *blob_id, <span class="keywordtype">void</span> *ctx);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__blob__class__t.html#aa83e3900c06c07677d9454e6eab7f435">get</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <span class="keywordtype">void</span> *blob_id, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *ctx);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__blob__class__t.html#a3ca3f8d0e6eecfed22112db39b942907">specific</a>)(<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *blob_id, <a class="code hl_struct" href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a> *args);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__blob__class__t.html#aa1711c74af0b89880652f6f3a1c561d5">optional</a>)(<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *blob_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__blob__class__t.html">H5VL_blob_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__blob__class__t_html"><div class="ttname"><a href="struct_h5_v_l__blob__class__t.html">H5VL_blob_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:992</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__class__t_html_a05cc95b9cd27b93ed81195ca1136c496"><div class="ttname"><a href="struct_h5_v_l__blob__class__t.html#a05cc95b9cd27b93ed81195ca1136c496">H5VL_blob_class_t::put</a></div><div class="ttdeci">herr_t(* put)(void *obj, const void *buf, size_t size, void *blob_id, void *ctx)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:993</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__class__t_html_a3ca3f8d0e6eecfed22112db39b942907"><div class="ttname"><a href="struct_h5_v_l__blob__class__t.html#a3ca3f8d0e6eecfed22112db39b942907">H5VL_blob_class_t::specific</a></div><div class="ttdeci">herr_t(* specific)(void *obj, void *blob_id, H5VL_blob_specific_args_t *args)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:995</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__class__t_html_aa1711c74af0b89880652f6f3a1c561d5"><div class="ttname"><a href="struct_h5_v_l__blob__class__t.html#aa1711c74af0b89880652f6f3a1c561d5">H5VL_blob_class_t::optional</a></div><div class="ttdeci">herr_t(* optional)(void *obj, void *blob_id, H5VL_optional_args_t *args)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:996</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__class__t_html_aa83e3900c06c07677d9454e6eab7f435"><div class="ttname"><a href="struct_h5_v_l__blob__class__t.html#aa83e3900c06c07677d9454e6eab7f435">H5VL_blob_class_t::get</a></div><div class="ttdeci">herr_t(* get)(void *obj, const void *blob_id, void *buf, size_t size, void *ctx)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:994</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__specific__args__t_html"><div class="ttname"><a href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:814</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefBlobput"></a>
blob: put</h3>
<p>Put a blob through the VOL. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*put)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *blob_id, <span class="keywordtype">void</span> *ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to the blob container.</div>
<div class="line">buf (IN): Pointer to the blob.</div>
<div class="line">size (IN): Size of the blob.</div>
<div class="line">blob_id (OUT): Pointer to the blob<span class="stringliteral">'s connector-specific ID.</span></div>
<div class="line"><span class="stringliteral">ctx (IN): Connector-specific blob context.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefBlobget"></a>
blob: get</h3>
<p>Get a blob through the VOL. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*get)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <span class="keywordtype">void</span> *blob_id, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *ctx);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to the blob container.</div>
<div class="line">blob_id (IN): Pointer to the blob<span class="stringliteral">'s connector-specific ID.</span></div>
<div class="line"><span class="stringliteral">buf (IN/OUT): Pointer to the blob.</span></div>
<div class="line"><span class="stringliteral">size (IN): Size of the blob.</span></div>
<div class="line"><span class="stringliteral">ctx (IN): Connector-specific blob context.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefBlobspec"></a>
blob: specific</h3>
<p>Perform a defined operation on a blob via the VOL. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*specific)(<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *blob_id, <a class="code hl_struct" href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a> *args);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to the blob container.</div>
<div class="line">blob_id (IN): Pointer to the blob<span class="stringliteral">'s connector-specific ID.</span></div>
<div class="line"><span class="stringliteral">args (IN/OUT): A pointer to the arguments struct.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<div class="fragment"><div class="line"><span class="comment">/* Values for 'blob' 'specific' operation */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6">H5VL_blob_specific_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6ad89fddfe0d59c281d327d964cf436bb3">H5VL_BLOB_DELETE</a>, <span class="comment">/* Delete a blob (by ID) */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6a07b91e3b9a440edfe61fae135016f488">H5VL_BLOB_ISNULL</a>, <span class="comment">/* Check if a blob ID is "null" */</span></div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6ad427093222848690bc262f2bfba8951a">H5VL_BLOB_SETNULL</a> <span class="comment">/* Set a blob ID to the connector's "null" blob ID value */</span></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6">H5VL_blob_specific_t</a>;</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Parameters for blob 'specific' operations */</span></div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a> {</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6">H5VL_blob_specific_t</a> <a class="code hl_variable" href="struct_h5_v_l__blob__specific__args__t.html#a78d2a3265b57217d686509b4e483d015">op_type</a>; <span class="comment">/* Operation to perform */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* Parameters for each operation */</span></div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <span class="comment">/* H5VL_BLOB_DELETE */</span></div>
<div class="line"> <span class="comment">/* No args */</span></div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_BLOB_ISNULL */</span></div>
<div class="line"> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *<a class="code hl_variable" href="struct_h5_v_l__blob__specific__args__t.html#a4615c1501aa1c1acf5c5e96da6db253d">isnull</a>; <span class="comment">/* Whether blob ID is "null" (OUT) */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__blob__specific__args__t.html#aef3b1871f8ce0caf3e69b69ad599c735">is_null</a>;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">/* H5VL_BLOB_SETNULL */</span></div>
<div class="line"> <span class="comment">/* No args */</span></div>
<div class="line"> } <a class="code hl_variable" href="struct_h5_v_l__blob__specific__args__t.html#a66193725084f33cde170e6a02916516c">args</a>;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a>;</div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a62920eba2774bece9b657b94d5786bd6"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6">H5VL_blob_specific_t</a></div><div class="ttdeci">H5VL_blob_specific_t</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:807</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a62920eba2774bece9b657b94d5786bd6a07b91e3b9a440edfe61fae135016f488"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6a07b91e3b9a440edfe61fae135016f488">H5VL_BLOB_ISNULL</a></div><div class="ttdeci">@ H5VL_BLOB_ISNULL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:809</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a62920eba2774bece9b657b94d5786bd6ad427093222848690bc262f2bfba8951a"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6ad427093222848690bc262f2bfba8951a">H5VL_BLOB_SETNULL</a></div><div class="ttdeci">@ H5VL_BLOB_SETNULL</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:810</div></div>
<div class="ttc" id="a_h5_v_lconnector_8h_html_a62920eba2774bece9b657b94d5786bd6ad89fddfe0d59c281d327d964cf436bb3"><div class="ttname"><a href="_h5_v_lconnector_8h.html#a62920eba2774bece9b657b94d5786bd6ad89fddfe0d59c281d327d964cf436bb3">H5VL_BLOB_DELETE</a></div><div class="ttdeci">@ H5VL_BLOB_DELETE</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:808</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__specific__args__t_html_a4615c1501aa1c1acf5c5e96da6db253d"><div class="ttname"><a href="struct_h5_v_l__blob__specific__args__t.html#a4615c1501aa1c1acf5c5e96da6db253d">H5VL_blob_specific_args_t::isnull</a></div><div class="ttdeci">hbool_t * isnull</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:824</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__specific__args__t_html_a66193725084f33cde170e6a02916516c"><div class="ttname"><a href="struct_h5_v_l__blob__specific__args__t.html#a66193725084f33cde170e6a02916516c">H5VL_blob_specific_args_t::args</a></div><div class="ttdeci">union H5VL_blob_specific_args_t::@98 args</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__specific__args__t_html_a78d2a3265b57217d686509b4e483d015"><div class="ttname"><a href="struct_h5_v_l__blob__specific__args__t.html#a78d2a3265b57217d686509b4e483d015">H5VL_blob_specific_args_t::op_type</a></div><div class="ttdeci">H5VL_blob_specific_t op_type</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:815</div></div>
<div class="ttc" id="astruct_h5_v_l__blob__specific__args__t_html_aef3b1871f8ce0caf3e69b69ad599c735"><div class="ttname"><a href="struct_h5_v_l__blob__specific__args__t.html#aef3b1871f8ce0caf3e69b69ad599c735">H5VL_blob_specific_args_t::is_null</a></div><div class="ttdeci">struct H5VL_blob_specific_args_t::@98::@99 is_null</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefBlobopt"></a>
blob: optional</h3>
<p>Perform a connector-specific operation on a blob via the VOL </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <span class="keywordtype">void</span> *blob_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): Pointer to the blob container.</div>
<div class="line">blob_id (IN): Pointer to the blob<span class="stringliteral">'s connector-specific ID.</span></div>
<div class="line"><span class="stringliteral">args (IN/OUT): A pointer to the arguments struct.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<p>Each connector that requires connector-specific operations should compare the value of the <em>op_type</em> field of the <a class="el" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> struct with the values returned from calling <a class="el" href="_h5_v_lconnector_8h.html#a85d2e5bf7c9e947f5a1645bbd0f887d9">H5VLregister_opt_operation</a> to determine how to handle the optional call and interpret the arguments passed in the struct</p>
<h2><a class="anchor" id="subsecVOLRefToken"></a>
Token Callbacks</h2>
<p><em>Structure for token callback routines, <a class="el" href="_h5_v_lconnector_8h.html">H5VLconnector.h</a></em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_v_l__token__class__t.html">H5VL_token_class_t</a> {</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__token__class__t.html#a3fd03f11f80b3f6d6beb50585e08e3d5">cmp</a>)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token1, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token2, <span class="keywordtype">int</span> *cmp_value);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__token__class__t.html#a16ead8224c9312b1b249ae9e2531d470">to_str</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token, <span class="keywordtype">char</span> **token_str);</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_variable" href="struct_h5_v_l__token__class__t.html#a1924e2e9985235f335236fed6a355ebc">from_str</a>)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keyword">const</span> <span class="keywordtype">char</span> *token_str, <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token);</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_v_l__token__class__t.html">H5VL_token_class_t</a>;</div>
<div class="ttc" id="astruct_h5_v_l__token__class__t_html"><div class="ttname"><a href="struct_h5_v_l__token__class__t.html">H5VL_token_class_t</a></div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1000</div></div>
<div class="ttc" id="astruct_h5_v_l__token__class__t_html_a16ead8224c9312b1b249ae9e2531d470"><div class="ttname"><a href="struct_h5_v_l__token__class__t.html#a16ead8224c9312b1b249ae9e2531d470">H5VL_token_class_t::to_str</a></div><div class="ttdeci">herr_t(* to_str)(void *obj, H5I_type_t obj_type, const H5O_token_t *token, char **token_str)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1002</div></div>
<div class="ttc" id="astruct_h5_v_l__token__class__t_html_a1924e2e9985235f335236fed6a355ebc"><div class="ttname"><a href="struct_h5_v_l__token__class__t.html#a1924e2e9985235f335236fed6a355ebc">H5VL_token_class_t::from_str</a></div><div class="ttdeci">herr_t(* from_str)(void *obj, H5I_type_t obj_type, const char *token_str, H5O_token_t *token)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1003</div></div>
<div class="ttc" id="astruct_h5_v_l__token__class__t_html_a3fd03f11f80b3f6d6beb50585e08e3d5"><div class="ttname"><a href="struct_h5_v_l__token__class__t.html#a3fd03f11f80b3f6d6beb50585e08e3d5">H5VL_token_class_t::cmp</a></div><div class="ttdeci">herr_t(* cmp)(void *obj, const H5O_token_t *token1, const H5O_token_t *token2, int *cmp_value)</div><div class="ttdef"><b>Definition</b> H5VLconnector.h:1001</div></div>
</div><!-- fragment --><h3><a class="anchor" id="subsubsecVOLRefTokencmp"></a>
token: cmp</h3>
<p>Compares two tokens and outputs a value like strcmp. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*cmp)(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token1, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token2, <span class="keywordtype">int</span> *cmp_value);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The underlying VOL object.</div>
<div class="line">token1 (IN): The first token to compare.</div>
<div class="line">token2 (IN): The second token to compare.</div>
<div class="line">cmp_value (OUT): A value like strcmp.</div>
</div><!-- fragment --> </td></tr>
</table>
<h3><a class="anchor" id="subsubsecVOLRefTokento"></a>
token: to_str</h3>
<p>Converts a token to a string representation. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*to_str)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token, <span class="keywordtype">char</span> **token_str)</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The underlying VOL object.</div>
<div class="line">obj_type (IN): The type of the object.</div>
<div class="line">token (IN): The token to turn into a string representation.</div>
<div class="line">token_str (OUT): The string representation of the token.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "obj_type" argument is an enum: (from <a class="el" href="_h5_ipublic_8h.html">H5Ipublic.h</a>)</em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bac3bd281c14f862130b9dc14ceb8acbf0">H5I_UNINIT</a> = (-2), </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba3e61c9654de6398dc9676ad37cbe6133">H5I_BADID</a> = (-1), </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bacc572b5478629d17dd4fa708c3508f22">H5I_FILE</a> = 1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bade3bcb0953b041371997f802fa678da8">H5I_DATASPACE</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5bdc68e9f466027aeac5f8b11205e51f">H5I_ATTR</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba0d3b691d8e02ae4898c82535401bee05">H5I_VFL</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bae950f33b1244e71d24b16786964f04b9">H5I_VOL</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9baa5dee573139d32eb67865e1f1405">H5I_GENPROP_CLS</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bab6161706783d4bca26a889f1ac0cf91a">H5I_GENPROP_LST</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba52573dfc8d6289035fef0757036432d6">H5I_ERROR_CLASS</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba493c2a05e970214bd4d3aff95fe3f680">H5I_ERROR_MSG</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832babfabc2e9a32f38b595f387c5facc7c47">H5I_ERROR_STACK</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5f1a0f50d26adfc30676fc0879cb71ac">H5I_SPACE_SEL_ITER</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa6512cfec909399be60ac03af2a06724">H5I_EVENTSET</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba1008af5d904aebbc78889a8d36bb8836">H5I_NTYPES</a> </div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a>;</div>
</div><!-- fragment --><p> The only values which should be used for this call are: </p><ul>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a></li>
</ul>
<p>as these are the only objects for which tokens are valid.</p>
<h3><a class="anchor" id="subsubsecVOLRefTokenfrom"></a>
token: from_str</h3>
<p>Converts a string representation of a token to a token. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*from_str)(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <span class="keyword">const</span> <span class="keywordtype">char</span> *token_str, <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): The underlying VOL object.</div>
<div class="line">obj_type (IN): The type of the object.</div>
<div class="line">token_str (IN): The string representation of the token.</div>
<div class="line">token (OUT): The token reated from the string representation.</div>
</div><!-- fragment --> </td></tr>
</table>
<p><em>The "obj_type" argument is an enum: (from <a class="el" href="_h5_ipublic_8h.html">H5Ipublic.h</a>)</em> </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bac3bd281c14f862130b9dc14ceb8acbf0">H5I_UNINIT</a> = (-2), </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba3e61c9654de6398dc9676ad37cbe6133">H5I_BADID</a> = (-1), </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bacc572b5478629d17dd4fa708c3508f22">H5I_FILE</a> = 1, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bade3bcb0953b041371997f802fa678da8">H5I_DATASPACE</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5bdc68e9f466027aeac5f8b11205e51f">H5I_ATTR</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba0d3b691d8e02ae4898c82535401bee05">H5I_VFL</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bae950f33b1244e71d24b16786964f04b9">H5I_VOL</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9baa5dee573139d32eb67865e1f1405">H5I_GENPROP_CLS</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bab6161706783d4bca26a889f1ac0cf91a">H5I_GENPROP_LST</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba52573dfc8d6289035fef0757036432d6">H5I_ERROR_CLASS</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba493c2a05e970214bd4d3aff95fe3f680">H5I_ERROR_MSG</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832babfabc2e9a32f38b595f387c5facc7c47">H5I_ERROR_STACK</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5f1a0f50d26adfc30676fc0879cb71ac">H5I_SPACE_SEL_ITER</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa6512cfec909399be60ac03af2a06724">H5I_EVENTSET</a>, </div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba1008af5d904aebbc78889a8d36bb8836">H5I_NTYPES</a> </div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a>;</div>
</div><!-- fragment --><p> The only values which should be used for this call are: </p><ul>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a></li>
</ul>
<p>as these are the only objects for which tokens are valid.</p>
<h2><a class="anchor" id="subsecVOLRefOpt"></a>
Optional Generic Callback</h2>
<p>A <em>generic</em> optional callback is provided for services that are specific to a connector. The <em>optional</em> callback has the following definition. It returns an <em>herr_t</em> indicating success or failure. </p><table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*optional)(<span class="keywordtype">void</span> *obj, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): A container or object where he operation needs to happen.</div>
<div class="line">args (IN/OUT): A pointer to the arguments struct.</div>
<div class="line">dxpl_id (IN): The data transfer property list.</div>
<div class="line">req IN/OUT): A pointer to the asynchronous request of the operation created by the connector.</div>
</div><!-- fragment --> </td></tr>
</table>
<h1><a class="anchor" id="secVOLNew"></a>
New VOL API Routines</h1>
<p>API routines have been added to the HDF5 library to manage VOL connectors. This section details each new API call and explains its intended usage. Additionally, a set of API calls that map directly to the VOL callbacks themselves have been added to aid in the development of passthrough connectors which can be stacked and/or split. A list of these API calls is given in an appendix.</p>
<h2><a class="anchor" id="subsecVOLNewPub"></a>
H5VLpublic.h</h2>
<p>The API calls in this header are for VOL management and general use (i.e., not limited to VOL connector authors).</p>
<h3><a class="anchor" id="subsubsecVOLNewPubregname"></a>
H5VLregister_connector_by_name</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#gaf48d1225927e1e701656346b832ee6b1">H5VLregister_connector_by_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *connector_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id);</div>
<div class="ttc" id="agroup___h5_v_l_html_gaf48d1225927e1e701656346b832ee6b1"><div class="ttname"><a href="group___h5_v_l.html#gaf48d1225927e1e701656346b832ee6b1">H5VLregister_connector_by_name</a></div><div class="ttdeci">hid_t H5VLregister_connector_by_name(const char *connector_name, hid_t vipl_id)</div><div class="ttdoc">Registers a new VOL connector by name.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_name (IN): The connector name to search for and register.</div>
<div class="line">vipl_id (IN): An ID for a VOL initialization property list (vipl).</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Registers a VOL connector with the HDF5 library given the name of the connector and returns an identifier for it (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on errors). If the connector is already registered, the library will create a new identifier for it and returns it to the user; otherwise the library will search the plugin path for a connector of that name, loading and registering it, returning an ID for it, if found. See the <a class="el" href="_h5_v_l__u_g.html">The HDF5 Virtual Object Layer (VOL)</a> for more information on loading plugins and the search paths.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubregval"></a>
H5VLregister_connector_by_value</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga11e69930e47f654805a265f417412ea8">H5VLregister_connector_by_value</a>(<a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_f_html_ga81b40d59b53c498f8aa9d92d0afdde2c"><div class="ttname"><a href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a></div><div class="ttdeci">int H5VL_class_value_t</div><div class="ttdoc">VOL connector identifiers.</div><div class="ttdef"><b>Definition</b> H5VLpublic.h:144</div></div>
<div class="ttc" id="agroup___h5_v_l_html_ga11e69930e47f654805a265f417412ea8"><div class="ttname"><a href="group___h5_v_l.html#ga11e69930e47f654805a265f417412ea8">H5VLregister_connector_by_value</a></div><div class="ttdeci">hid_t H5VLregister_connector_by_value(H5VL_class_value_t connector_value, hid_t vipl_id)</div><div class="ttdoc">Registers a new VOL connector by value.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_value (IN): The connector value to search for and register.</div>
<div class="line">vipl_id (IN): An ID for a VOL initialization property list (vipl).</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Registers a VOL connector with the HDF5 library given a value for the connector and returns an identifier for it (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on errors). If the connector is already registered, the library will create a new identifier for it and returns it to the user; otherwise the library will search the plugin path for a connector of that name, loading and registering it, returning an ID for it, if found. See the VOL User Guide for more information on loading plugins and the search paths.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubis_name"></a>
H5VLis_connector_registered_by_name</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga9be3c92e4430b9cf42a376534a47fcca">H5VLis_connector_registered_by_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="ttc" id="a_h5public_8h_html_aa8f6c28736dbd0f18388c67911d38aca"><div class="ttname"><a href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a></div><div class="ttdeci">int htri_t</div><div class="ttdef"><b>Definition</b> H5public.h:265</div></div>
<div class="ttc" id="agroup___h5_v_l_html_ga9be3c92e4430b9cf42a376534a47fcca"><div class="ttname"><a href="group___h5_v_l.html#ga9be3c92e4430b9cf42a376534a47fcca">H5VLis_connector_registered_by_name</a></div><div class="ttdeci">htri_t H5VLis_connector_registered_by_name(const char *name)</div><div class="ttdoc">Tests whether a VOL class has been registered under a certain name.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">name (IN): The connector name to check for.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Checks if a VOL connector is registered with the library given the connector name and returns TRUE/FALSE on success, otherwise it returns a negative value.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubis_value"></a>
H5VLis_connector_registered_by_value</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga83ba8986ed68f67c41b492dfd273804b">H5VLis_connector_registered_by_value</a>(<a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value);</div>
<div class="ttc" id="agroup___h5_v_l_html_ga83ba8986ed68f67c41b492dfd273804b"><div class="ttname"><a href="group___h5_v_l.html#ga83ba8986ed68f67c41b492dfd273804b">H5VLis_connector_registered_by_value</a></div><div class="ttdeci">htri_t H5VLis_connector_registered_by_value(H5VL_class_value_t connector_value)</div><div class="ttdoc">Tests whether a VOL class has been registered for a given value.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_value (IN): The connector value to check for.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Checks if a VOL connector is registered with the library given the connector value and returns TRUE/FALSE on success, otherwise it returns a negative value.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubget_id"></a>
H5VLget_connector_id</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga5b69c29931e55208517c598ac3039f77">H5VLget_connector_id</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id);</div>
<div class="ttc" id="agroup___h5_v_l_html_ga5b69c29931e55208517c598ac3039f77"><div class="ttname"><a href="group___h5_v_l.html#ga5b69c29931e55208517c598ac3039f77">H5VLget_connector_id</a></div><div class="ttdeci">hid_t H5VLget_connector_id(hid_t obj_id)</div><div class="ttdoc">Retrieves the VOL connector identifier for a given object identifier.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj_id (IN): An ID for an HDF5 VOL object.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Given a VOL object such as a dataset or an attribute, this function returns an identifier for its associated connector. If the ID is not a VOL object (such as a dataspace or uncommitted datatype), <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> is returned. The identifier must be released with a call to <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose</a>.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubget_by_name"></a>
H5VLget_connector_id_by_name</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#gabcbf9b9b07a6b60e17ff9681684f944d">H5VLget_connector_id_by_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="ttc" id="agroup___h5_v_l_html_gabcbf9b9b07a6b60e17ff9681684f944d"><div class="ttname"><a href="group___h5_v_l.html#gabcbf9b9b07a6b60e17ff9681684f944d">H5VLget_connector_id_by_name</a></div><div class="ttdeci">hid_t H5VLget_connector_id_by_name(const char *name)</div><div class="ttdoc">Retrieves the identifier for a registered VOL connector name.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">name (IN): The connector name to check for.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Given a connector name that is registered with the library, this function returns an identifier for the connector. If the connector is not registered with the library, <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> is returned.The identifier must be released with a call to <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose</a>.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubget_by_value"></a>
H5VLget_connector_id_by_value</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga8f6d366bc6b8323bbffe1e5a5ba18bee">H5VLget_connector_id_by_value</a>(<a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> connector_value);</div>
<div class="ttc" id="agroup___h5_v_l_html_ga8f6d366bc6b8323bbffe1e5a5ba18bee"><div class="ttname"><a href="group___h5_v_l.html#ga8f6d366bc6b8323bbffe1e5a5ba18bee">H5VLget_connector_id_by_value</a></div><div class="ttdeci">hid_t H5VLget_connector_id_by_value(H5VL_class_value_t connector_value)</div><div class="ttdoc">Retrieves the identifier for a registered VOL connector value.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_value (IN): The connector value to check for.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Given a connector value that is registered with the library, this function returns an identifier for the connector. If the connector is not registered with the library, <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> is returned.The identifier must be released with a call to <a class="el" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094" title="Closes a VOL connector identifier.">H5VLclose</a>.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubget_name"></a>
H5VLget_connector_name</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> <a class="code hl_function" href="group___h5_v_l.html#gaf326406d7733c0ab8d12118c13c78dfa">H5VLget_connector_name</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <span class="keywordtype">id</span>, <span class="keywordtype">char</span> *name <span class="comment">/*out*/</span>, <span class="keywordtype">size_t</span> size);</div>
<div class="ttc" id="a_h5public_8h_html_af629ed855824cf5955b54529adf78ad6"><div class="ttname"><a href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a></div><div class="ttdeci">int ssize_t</div><div class="ttdef"><b>Definition</b> H5public.h:279</div></div>
<div class="ttc" id="agroup___h5_v_l_html_gaf326406d7733c0ab8d12118c13c78dfa"><div class="ttname"><a href="group___h5_v_l.html#gaf326406d7733c0ab8d12118c13c78dfa">H5VLget_connector_name</a></div><div class="ttdeci">ssize_t H5VLget_connector_name(hid_t id, char *name, size_t size)</div><div class="ttdoc">Retrieves a connector name for a VOL.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">id (IN): The object identifier to check.</div>
<div class="line">name (OUT): Buffer pointer to put the connector name. If NULL, the library just returns thesize required to store the connector name.</div>
<div class="line">size (IN): the size of the passed in buffer.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Retrieves the name of a VOL connector given an object identifier that was created/opened ith it. On success, the name length is returned.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubclose"></a>
H5VLclose</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094">H5VLclose</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="ttc" id="agroup___h5_v_l_html_gaa3324ac7aedf9362b498226903288094"><div class="ttname"><a href="group___h5_v_l.html#gaa3324ac7aedf9362b498226903288094">H5VLclose</a></div><div class="ttdeci">herr_t H5VLclose(hid_t connector_id)</div><div class="ttdoc">Closes a VOL connector identifier.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_id (IN): A valid identifier of the connector to close.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Shuts down access to the connector that the identifier points to and release resources associated with it.</p>
<h3><a class="anchor" id="subsubsecVOLNewPubunreg"></a>
H5VLunregister_connector</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e">H5VLunregister_connector</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="ttc" id="agroup___h5_v_l_html_gaffbdc22f724c2c818f3be3845145d73e"><div class="ttname"><a href="group___h5_v_l.html#gaffbdc22f724c2c818f3be3845145d73e">H5VLunregister_connector</a></div><div class="ttdeci">herr_t H5VLunregister_connector(hid_t connector_id)</div><div class="ttdoc">Removes a VOL connector identifier from the library.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">connector_id (IN): A valid identifier of the connector to unregister.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Unregisters a connector from the library and return a positive value on success otherwise return a negative value. The native VOL connector cannot be unregistered (this will return a negative <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> value).</p>
<h3><a class="anchor" id="subsubsecVOLNewPubquery"></a>
H5VLquery_optional</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga17ef00e528d99eda5879d749c2a12043">H5VLquery_optional</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, <span class="keywordtype">int</span> opt_type, uint64_t *flags);</div>
<div class="ttc" id="agroup___h5_v_l_html_ga17ef00e528d99eda5879d749c2a12043"><div class="ttname"><a href="group___h5_v_l.html#ga17ef00e528d99eda5879d749c2a12043">H5VLquery_optional</a></div><div class="ttdeci">herr_t H5VLquery_optional(hid_t obj_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags)</div><div class="ttdoc">Determine if a VOL connector supports a particular optional callback operation.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj_id (IN): A valid identifier of a VOL-managed object.</div>
<div class="line">subcls (IN): The subclass of the optional operation.</div>
<div class="line">opt_type (IN): The optional operation. The native VOL connector uses hard-coded values. Other</div>
<div class="line"> VOL connectors get this value when the optional operations are registered.</div>
<div class="line">flags (OUT): Bitwise flags indicating support and behavior.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Determines if a connector or connector stack (determined from the passed-in object) supports an optional operation. The returned flags (listed below) not only indicate whether the operation is supported or not, but also give a sense of the option's behavior (useful for pass-through connectors).</p>
<p>Bitwise query flag values: </p><div class="fragment"><div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_SUPPORTED 0x0001 </span><span class="comment">/* VOL connector supports this operation */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_READ_DATA 0x0002 </span><span class="comment">/* Operation reads data for object */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_WRITE_DATA 0x0004 </span><span class="comment">/* Operation writes data for object */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_QUERY_METADATA 0x0008 </span><span class="comment">/* Operation reads metadata for object */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_MODIFY_METADATA 0x0010 </span><span class="comment">/* Operation modifies metadata for object */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_COLLECTIVE 0x0020 </span><span class="comment">/* Operation is collective (operations without this flag are assumed to be independent) */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_NO_ASYNC 0x0040 </span><span class="comment">/* Operation may NOT be executed asynchronously */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_OPT_QUERY_MULTI_OBJ 0x0080 </span><span class="comment">/* Operation involves multiple objects */</span><span class="preprocessor"></span></div>
</div><!-- fragment --><h2><a class="anchor" id="subsecVOLNewConn"></a>
H5VLconnector.h</h2>
<p>This functionality is intended for VOL connector authors and includes helper functions that are useful for writing connectors.</p>
<p>API calls to manage optional operations are also found in this header file. These are discussed in the section on optional operations, above.</p>
<h3><a class="anchor" id="subsubsecVOLNewConnreg"></a>
H5VLregister_connector</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l_d_e_v.html#ga439c150299522a0e0f401a86d083097b">H5VLregister_connector</a>(<span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> *cls, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_v_html_ga439c150299522a0e0f401a86d083097b"><div class="ttname"><a href="group___h5_v_l_d_e_v.html#ga439c150299522a0e0f401a86d083097b">H5VLregister_connector</a></div><div class="ttdeci">hid_t H5VLregister_connector(const H5VL_class_t *cls, hid_t vipl_id)</div><div class="ttdoc">Registers a new VOL connector.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">cls (IN): A pointer to the connector structure to register.</div>
<div class="line">vipl_id (IN): An ID for a VOL initialization property list (vipl).</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Registers a user-defined VOL connector with the HDF5 library and returns an identifier for that connector (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a> on errors). This function is used when the application has direct access to the connector it wants to use and is able to obtain a pointer for the connector structure to pass to the HDF5 library.</p>
<h3><a class="anchor" id="subsubsecVOLNewConnobj"></a>
H5VLobject</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><span class="keywordtype">void</span> *<a class="code hl_function" href="group___h5_v_l_d_e_v.html#ga21f351a8a3a128659f57217a3b452cd5">H5VLobject</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_v_html_ga21f351a8a3a128659f57217a3b452cd5"><div class="ttname"><a href="group___h5_v_l_d_e_v.html#ga21f351a8a3a128659f57217a3b452cd5">H5VLobject</a></div><div class="ttdeci">void * H5VLobject(hid_t obj_id)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj_id (IN): identifier of the object to dereference.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Retrieves a pointer to the VOL object from an HDF5 file or object identifier.</p>
<h3><a class="anchor" id="subsubsecVOLNewConnget"></a>
H5VLget_file_type</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l_d_e_v.html#ga161553978d3d001a5b04708acccb429f">H5VLget_file_type</a>(<span class="keywordtype">void</span> *file_obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dtype_id);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_v_html_ga161553978d3d001a5b04708acccb429f"><div class="ttname"><a href="group___h5_v_l_d_e_v.html#ga161553978d3d001a5b04708acccb429f">H5VLget_file_type</a></div><div class="ttdeci">hid_t H5VLget_file_type(void *file_obj, hid_t connector_id, hid_t dtype_id)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">file_obj (IN): pointer to a file or file object<span class="stringliteral">'s connector-specific data.</span></div>
<div class="line"><span class="stringliteral">connector_id (IN): A valid identifier of the connector to use.</span></div>
<div class="line"><span class="stringliteral">dtype_id (IN): A valid identifier for the type.</span></div>
</div><!-- fragment --> </td></tr>
</table>
<p>Returns a copy of the <em>dtype_id</em> parameter but with the location set to be in the file. Returns a negative value (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewConnpeek_name"></a>
H5VLpeek_connector_id_by_name</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l_d_e_v.html#ga1c60c90aa304a8af505ac6bf6c45f325">H5VLpeek_connector_id_by_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_v_html_ga1c60c90aa304a8af505ac6bf6c45f325"><div class="ttname"><a href="group___h5_v_l_d_e_v.html#ga1c60c90aa304a8af505ac6bf6c45f325">H5VLpeek_connector_id_by_name</a></div><div class="ttdeci">hid_t H5VLpeek_connector_id_by_name(const char *name)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">name (IN): name of the connector to query.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Retrieves the ID for a registered VOL connector based on a connector name. This is done without duplicating the ID and transferring ownership to the caller (as it normally the case in the HDF5 library). The ID returned from this operation should not be closed. This is intended for use by VOL connectors to find their own ID. Returns a negative value (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewConnpeek_value"></a>
H5VLpeek_connector_id_by_value</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l_d_e_v.html#ga5ce951b73cea4cac933107b94ec1544a">H5VLpeek_connector_id_by_value</a>(<a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> value);</div>
<div class="ttc" id="agroup___h5_v_l_d_e_v_html_ga5ce951b73cea4cac933107b94ec1544a"><div class="ttname"><a href="group___h5_v_l_d_e_v.html#ga5ce951b73cea4cac933107b94ec1544a">H5VLpeek_connector_id_by_value</a></div><div class="ttdeci">hid_t H5VLpeek_connector_id_by_value(H5VL_class_value_t value)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">value (IN): value of the connector to query.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Retrieves the ID for a registered VOL connector based on a connector value. This is done without duplicating the ID and transferring ownership to the caller (as it normally the case in the HDF5 library). The ID returned from this operation should not be closed. This is intended for use by VOL connectors to find their own ID. Returns a negative value (<a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) on errors.</p>
<h2><a class="anchor" id="subsecVOLNewPass"></a>
H5VLconnector_passthru.h</h2>
<p>This functionality is intended for VOL connector authors who are writing pass-through connectors and includes helper functions that are useful for writing such connectors. Callback equivalent functions can be found in this header as well. A list of these functions is included as an appendix to this document.</p>
<h3><a class="anchor" id="subsubsecVOLNewPasscmp"></a>
H5VLcmp_connector_cls</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a814ba230b852c6b7e27811fe2b8d4fb2">H5VLcmp_connector_cls</a>(<span class="keywordtype">int</span> *cmp, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id1, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id2);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a814ba230b852c6b7e27811fe2b8d4fb2"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a814ba230b852c6b7e27811fe2b8d4fb2">H5VLcmp_connector_cls</a></div><div class="ttdeci">herr_t H5VLcmp_connector_cls(int *cmp, hid_t connector_id1, hid_t connector_id2)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">cmp (OUT): a value like strcmp.</div>
<div class="line">connector_id1 (IN): the ID of the first connector to compare.</div>
<div class="line">connector_id2 (IN): the ID of the second connector to compare</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Compares two connectors (given by the connector IDs) to see if they refer to the same connector underneath. Returns a positive value on success and a negative value on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewPasswrap"></a>
H5VLwrap_register</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <a class="code hl_function" href="group___h5_v_l.html#ga9873d50b395911b609621c22c2fa554b">H5VLwrap_register</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> type);</div>
<div class="ttc" id="agroup___h5_v_l_html_ga9873d50b395911b609621c22c2fa554b"><div class="ttname"><a href="group___h5_v_l.html#ga9873d50b395911b609621c22c2fa554b">H5VLwrap_register</a></div><div class="ttdeci">hid_t H5VLwrap_register(void *obj, H5I_type_t type)</div><div class="ttdoc">Wrap an internal object with a "wrap context" and register an hid_t for the resulting object.</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">obj (IN): an object to wrap.</div>
<div class="line">type (IN): the type of the object (see below).</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Wrap an internal object with a "wrap context" and register and return an hidt for the resulting object. This routine is mainly targeted toward wrapping objects for iteration routine callbacks (i.e. the callbacks from H5Aiterate*, H5Literate* / H5Lvisit*, and H5Ovisit* ). Using it in an application will return an error indicating the API context isn't available or can't be retrieved. he type must be a VOL-managed object class: </p><ul>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832bacc572b5478629d17dd4fa708c3508f22">H5I_FILE</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa839c547a95f216c36697065422162d6">H5I_GROUP</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf881cdc68cc4082e66091f0b4bfb9e64">H5I_DATATYPE</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baa9f2e1d8a2db4f302d81603217b83987">H5I_DATASET</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832baf61d30fecc42d847825922bc97de1b0d">H5I_MAP</a> </li>
<li><a class="el" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832ba5bdc68e9f466027aeac5f8b11205e51f">H5I_ATTR</a></li>
</ul>
<h3><a class="anchor" id="subsubsecVOLNewPassretrieve"></a>
H5VLretrieve_lib_state</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a4bb2aa208a7d36a1da7f51639f73c22f">H5VLretrieve_lib_state</a>(<span class="keywordtype">void</span> **state);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a4bb2aa208a7d36a1da7f51639f73c22f"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a4bb2aa208a7d36a1da7f51639f73c22f">H5VLretrieve_lib_state</a></div><div class="ttdeci">herr_t H5VLretrieve_lib_state(void **state)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">state (OUT): the library state.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Retrieves a copy of the internal state of the HDF5 library, so that it can be restored later. Returns a positive value on success and a negative value on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewPassstar"></a>
H5VLstart_lib_state</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ad346377da51f3c2b44e1484d8df8f878">H5VLstart_lib_state</a>(<span class="keywordtype">void</span>);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ad346377da51f3c2b44e1484d8df8f878"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ad346377da51f3c2b44e1484d8df8f878">H5VLstart_lib_state</a></div><div class="ttdeci">herr_t H5VLstart_lib_state(void)</div></div>
</div><!-- fragment --> </td></tr>
</table>
<p>Opens a new internal state for the HDF5 library. Returns a positive value on success and a negative value on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewPassrestore"></a>
H5VLrestore_lib_state</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a160ba58761792ce81e6951e517940fdc">H5VLrestore_lib_state</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *state);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a160ba58761792ce81e6951e517940fdc"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a160ba58761792ce81e6951e517940fdc">H5VLrestore_lib_state</a></div><div class="ttdeci">herr_t H5VLrestore_lib_state(const void *state)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">state (IN): the library state.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Restores the internal state of the HDF5 library. Returns a positive value on success and a negative value on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewPassfinish"></a>
H5VLfinish_lib_state</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a2de1fccb5bd8413a7c95a56e1c22de99">H5VLfinish_lib_state</a>(<span class="keywordtype">void</span>);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a2de1fccb5bd8413a7c95a56e1c22de99"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a2de1fccb5bd8413a7c95a56e1c22de99">H5VLfinish_lib_state</a></div><div class="ttdeci">herr_t H5VLfinish_lib_state(void)</div></div>
</div><!-- fragment --> </td></tr>
</table>
<p>Closes the state of the library, undoing the effects of <a class="el" href="_h5_v_lconnector__passthru_8h.html#ad346377da51f3c2b44e1484d8df8f878">H5VLstart_lib_state</a>. Returns a positive value on success and a negative value on errors.</p>
<h3><a class="anchor" id="subsubsecVOLNewPassfree"></a>
H5VLfree_lib_state</h3>
<table class="doxtable">
<tr>
<th>Signature: </th></tr>
<tr>
<td><div class="fragment"><div class="line"><a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a37856e5f0914916c4ac36cbc0e6bed84">H5VLfree_lib_state</a>(<span class="keywordtype">void</span> *state);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a37856e5f0914916c4ac36cbc0e6bed84"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a37856e5f0914916c4ac36cbc0e6bed84">H5VLfree_lib_state</a></div><div class="ttdeci">herr_t H5VLfree_lib_state(void *state)</div></div>
</div><!-- fragment --> </td></tr>
<tr>
<th>Arguments: </th></tr>
<tr>
<td><div class="fragment"><div class="line">state (IN): the library state.</div>
</div><!-- fragment --> </td></tr>
</table>
<p>Free a retrieved library state. Returns a positive value on success and a negative value on errors.</p>
<h1><a class="anchor" id="secVOLAppA"></a>
Appendix A Mapping of VOL Callbacks to HDF5 API Calls</h1>
<table class="doxtable">
<tr>
<td>VOL Callback </td><td>HDF5 API Call </td></tr>
<tr>
<th colspan="2">FILE </th></tr>
<tr>
<td>create </td><td><ul>
<li><a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate</a> </li>
</ul>
</td></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_f.html#gaa3f4f877b9bb591f3880423ed2bf44bc" title="Opens an existing HDF5 file.">H5Fopen</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_f.html#ga359585c49f82f5199178777b39e780f4" title="Returns a file access property list identifier.">H5Fget_access_plist</a> </li>
<li><a class="el" href="group___h5_f.html#ga2f823a9e929b00b06a6be80619a61778" title="Returns a file creation property list identifier.">H5Fget_create_plist</a> </li>
<li><a class="el" href="group___h5_f.html#ga402205688af065ab5db0fe20417d5484" title="Retrieves a file's file number that uniquely identifies an open file.">H5Fget_fileno</a> </li>
<li><a class="el" href="group___h5_f.html#ga466179d7783d256329c2e3110055a16c" title="Determines the read/write or read-only status of a file.">H5Fget_intent</a> </li>
<li><a class="el" href="group___h5_f.html#ga0ed43dbe476a160b73f55127c7db797c" title="Retrieves name of file to which object belongs.">H5Fget_name</a> </li>
<li><a class="el" href="group___h5_f.html#gadcdae0aca7c88064db0d32de7f1e31f2" title="Returns the number of open object identifiers for an open file.">H5Fget_obj_count</a> </li>
<li><a class="el" href="group___h5_f.html#ga35e72579bd07433162b80ddc0bd0c5b1" title="Returns a list of open object identifiers.">H5Fget_obj_ids</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_f.html#ga2e8b5e19b343123e8ab21442f9169a62" title="Deletes an HDF5 file.">H5Fdelete</a> </li>
<li><a class="el" href="group___h5_f.html#gae686870f0a276c4d06bbc667b2c24124" title="Flushes all buffers associated with a file to storage.">H5Fflush</a> </li>
<li><a class="el" href="group___h5_f.html#ga584471c3b98453b9b04a4bf9af847442" title="Checks if a file can be opened with a given file access property list.">H5Fis_accessible</a> </li>
<li><a class="el" href="group___h5_f.html#ga6055c2ea3438bd4aaf221eba66843225" title="Determines whether a file is in the HDF5 format.">H5Fis_hdf5</a> (deprecated, hard-coded to use native connector) </li>
<li><a class="el" href="group___h5_f.html#ga3f213eb05c5419d63ba168c30036e47b" title="Returns a new identifier for a previously-opened HDF5 file.">H5Freopen</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124" title="Terminates access to an HDF5 file.">H5Fclose</a> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">GROUP </th></tr>
<tr>
<td>create </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga7397440085510728a2e2d22199e81980" title="Creates a new group and links it into the file.">H5Gcreate1</a> (deprecated) </li>
<li><a class="el" href="group___h5_g.html#ga86d93295965f750ef25dea2505a711d9" title="Creates a new group and links it into the file.">H5Gcreate2</a> </li>
<li><a class="el" href="group___h5_g.html#gab52641f0736281faaaae4e3039bbb344" title="Creates a new empty group without linking it into the file structure.">H5Gcreate_anon</a> </li>
</ul>
</td></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga163ca3eb7893d34973ee900b2da886be" title="Opens an existing group for modification and returns a group identifier for that group.">H5Gopen1</a> (deprecated) </li>
<li><a class="el" href="group___h5_g.html#gadab91e2dd7a7e253dcc0e4fe04b81403" title="Opens an existing group in a file.">H5Gopen2</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga0b959a53cbffa48f5d68ce33b43b7ed8" title="Gets a group creation property list identifier.">H5Gget_create_plist</a> </li>
<li><a class="el" href="group___h5_g.html#gad4be126ab7bbf2001435e8e70089f3d3" title="Retrieves information about a group.">H5Gget_info</a> </li>
<li><a class="el" href="group___h5_g.html#ga985f27ad1a164d99fa1f58c6de60ab00" title="Retrieves information about a group, according to the group's position within an index.">H5Gget_info_by_idx</a> </li>
<li><a class="el" href="group___h5_g.html#gadedd0c73c98f2ada69305f2992c3300e" title="Retrieves information about a group by its name.">H5Gget_info_by_name</a> </li>
<li><a class="el" href="group___h5_g.html#ga3e30142e15ccf9a08bfc91ca9925c14d" title="Returns number of objects in the group specified by its identifier.">H5Gget_num_objs</a> (deprecated) </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_f.html#ga7c4865fd36ee25d839725252150bb53b" title="Mounts an HDF5 file.">H5Fmount</a> </li>
<li><a class="el" href="group___h5_f.html#gae8f807d3f04a33f132ffb6c5295e897f" title="Unounts an HDF5 file.">H5Funmount</a> </li>
<li><a class="el" href="group___h5_g.html#ga1d55dbf931f8003bb329c4340b8fe4d6" title="Flushes all buffers associated with a group to disk.">H5Gflush</a> </li>
<li><a class="el" href="group___h5_g.html#ga0a8bdd0eb1b001222c27d3d39a909840" title="Refreshes all buffers associated with a group.">H5Grefresh</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga8dbe20b390d2504f0bd3589ed8f4e221" title="Closes the specified group.">H5Gclose</a> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">DATASET </th></tr>
<tr>
<td>create </td><td><ul>
<li><a class="el" href="group___h5_d.html#ga6b86f2683ae6a78d48d33c45257744a2" title="Creates a dataset at the specified location.">H5Dcreate1</a> (deprecated) </li>
<li><a class="el" href="group___h5_d.html#gabf62045119f4e9c512d87d77f2f992df" title="Creates a new dataset and links it into the file.">H5Dcreate2</a> </li>
</ul>
</td></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_d.html#gabaf03a683e1da2c8dad6ba1010d55b81" title="Opens an existing dataset.">H5Dopen1</a> (deprecated) </li>
<li><a class="el" href="group___h5_d.html#ga04198c4cf0b849ed3a8921f6c7169ee2" title="Opens an existing dataset.">H5Dopen2</a> </li>
</ul>
</td></tr>
<tr>
<td>read </td><td><ul>
<li><a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread</a> </li>
</ul>
</td></tr>
<tr>
<td>write </td><td><ul>
<li><a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_d.html#ga252c0ddac7a7817bd757190e7398353b" title="Returns the dataset access property list associated with a dataset.">H5Dget_access_plist</a> </li>
<li><a class="el" href="group___h5_d.html#ga8848f14f4aba8e6160c3d8bb7f1be163" title="Returns an identifier for a copy of the dataset creation property list for a dataset.">H5Dget_create_plist</a> </li>
<li><a class="el" href="group___h5_d.html#gad42a46be153d895d8c28a11ebf5a0d0a" title="Returns an identifier for a copy of the dataspace for a dataset.">H5Dget_space</a> </li>
<li><a class="el" href="group___h5_d.html#ga7639ef5c12cb906c71670ce73b856a4c" title="Determines whether space has been allocated for a dataset.">H5Dget_space_status</a> </li>
<li><a class="el" href="group___h5_d.html#gafb249479a493e80891f0c7f5d8a91b00" title="Returns the amount of storage allocated for a dataset.">H5Dget_storage_size</a> </li>
<li><a class="el" href="group___h5_d.html#ga7cd04b8332e8a0939b9973fbc500cadb" title="Returns an identifier for a copy of the datatype for a dataset.">H5Dget_type</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_d.html#gac4c0ff57977b1f39c1055296e39cbe91" title="Extends a dataset.">H5Dextend</a> (deprecated) </li>
<li><a class="el" href="group___h5_d.html#ga4a2175a62baa1e35ad2467bb1fdff1f7" title="Flushes all buffers associated with a dataset to disk.">H5Dflush</a> </li>
<li><a class="el" href="group___h5_d.html#ga3c1ea7e5db3f62d9cf03dd62d1fb08da" title="Refreshes all buffers associated with a dataset.">H5Drefresh</a> </li>
<li><a class="el" href="group___h5_d.html#gad31e1e0129f4520c531ce524de2a056f" title="Changes the sizes of a dataset's dimensions.">H5Dset_extent</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose</a> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">OBJECT </th></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_o.html#ga9f635f58c7ddf17f87c253bfbca08bc1" title="Opens an object in an HDF5 file by location identifier and path name.">H5Oopen</a> </li>
<li><a class="el" href="group___h5_o.html#ga137f3823adab4daaaf8fe87b40453fa2" title="Opens an object using its address within an HDF5 file.">H5Oopen_by_addr</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#gaeb66e5cbb3ca79890fc284a0b06762be" title="Opens the nth object in a group.">H5Oopen_by_idx</a> </li>
<li><a class="el" href="group___h5_o.html#ga2ea3627cf171d0565307702a5e203262" title="Opens an object in an HDF5 file using its VOL independent token.">H5Oopen_by_token</a> </li>
</ul>
</td></tr>
<tr>
<td>copy </td><td><ul>
<li><a class="el" href="group___h5_o.html#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_o.html#gaf3751684a6706e3ba49b863406011f80" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info1</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#ga06f896e14fe4fa940fbc2bc235e0cf74" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info2</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#gaf0fbf7d780a1eefce920facadb198013" title="Retrieves the metadata for an object specified by an identifier.">H5Oget_info3</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_o.html#ga60c20da5e244c28a653d4fa23d316b44" title="Decrements an object reference count.">H5Odecr_refcount</a> </li>
<li><a class="el" href="group___h5_o.html#gab0fef18d97844c4f83d412c5a22def7b" title="Determines whether a link resolves to an actual object.">H5Oexists_by_name</a> </li>
<li><a class="el" href="group___h5_o.html#gad99f35048cba4534b6393214684f090f" title="Flushes all buffers associated with an HDF5 object to disk.">H5Oflush</a> </li>
<li><a class="el" href="group___h5_o.html#ga2086bad6c3cd2a711c306a48c093ff55" title="Increments an object reference count.">H5Oincr_refcount</a> </li>
<li><a class="el" href="group___h5_o.html#gaf0318b68be9ab23a92b8a6bee0af9e2f" title="Refreshes all buffers associated with an HDF5 object.">H5Orefresh</a> </li>
<li><a class="el" href="group___h5_o.html#gaffacf3bd66f4fe074099eae1c80914f2" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name1</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#ga9c155caf5499405fe403e1eb27b5beb6" title="Recursively visits all objects starting from a specified object.">H5Ovisit_by_name2</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#ga34815400b01df59c4dac19436124885a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit_by_name3</a> </li>
<li><a class="el" href="group___h5_o.html#ga6efdb2a0a9fe9fe46695cc0f7bd993e7" title="Recursively visits all objects accessible from a specified object.">H5Ovisit1</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#gaa4ab542f581f4fc9a4eaa95debb29c9e" title="Recursively visits all objects accessible from a specified object.">H5Ovisit2</a> (deprecated) </li>
<li><a class="el" href="group___h5_o.html#ga6d03115ae0e5e5b516bbf35bb492266a" title="Recursively visits all objects accessible from a specified object.">H5Ovisit3</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose</a> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">LINK </th></tr>
<tr>
<td>create </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga1b9b2effdc1727613f81c4dcb2a4d644" title="Creates a link of the specified type from new_name to cur_name.">H5Glink</a> (deprecated) </li>
<li><a class="el" href="group___h5_g.html#gafabd07a7f64a7cbef27c56a3bee2df47" title="Creates a link of the specified type from cur_name to new_name.">H5Glink2</a> (deprecated) </li>
<li><a class="el" href="group___h5_l.html#ga69d50f7acdfd2f1dc7c4372397e63bd2" title="Creates a hard link to an object.">H5Lcreate_hard</a> </li>
<li><a class="el" href="group___h5_l.html#ga894444623b58ce1ac3bd35538245ac78" title="Creates a soft link.">H5Lcreate_soft</a> </li>
<li><a class="el" href="group___h5_l.html#gadaf9732947c45cd4d2442e7f58873fc2" title="Creates a link of a user-defined type.">H5Lcreate_ud</a> </li>
<li><a class="el" href="group___h5_o.html#ga2c97dd58e64b67d16325fceb7e02113f" title="Creates a hard link to an object in an HDF5 file.">H5Olink</a> </li>
</ul>
</td></tr>
<tr>
<td>copy </td><td><ul>
<li><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> </li>
</ul>
</td></tr>
<tr>
<td>move </td><td><ul>
<li><a class="el" href="group___h5_g.html#gaa6474351d346ad45309ae0b22ebdde9a" title="Renames an object within an HDF5 file.">H5Gmove</a> (deprecated) </li>
<li><a class="el" href="group___h5_g.html#gad97bf21798b06b63df0bdd404cac562c" title="Renames an object within an HDF5 file.">H5Gmove2</a> (deprecated) </li>
<li><a class="el" href="group___h5_l.html#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_g.html#ga3a994ec16caa60edd7bb6c71c6fdc5aa" title="Returns the name of the object that the symbolic link points to.">H5Gget_linkval</a> (deprecated) </li>
<li><a class="el" href="group___h5_l.html#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1</a> (deprecated) </li>
<li><a class="el" href="group___h5_l.html#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2</a> </li>
<li><a class="el" href="group___h5_l.html#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx</a> </li>
<li><a class="el" href="group___h5_l.html#ga453ea40c3bb85ec8120dd17deed2bd90" title="Retrieves name of the n-th link in a group, according to the order within a specified field or index.">H5Lget_name_by_idx</a> </li>
<li><a class="el" href="group___h5_l.html#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val</a> </li>
<li><a class="el" href="group___h5_l.html#gaf7be56de947e09a8d084e9d13a90bf3c" title="Retrieves value of the n-th link in a group, according to the order within an index.">H5Lget_val_by_idx</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_g.html#gacb843cbd5bbb816cfa9c855463d1e51c" title="Removes the link to an object from a group.">H5Gunlink</a> (deprecated) </li>
<li><a class="el" href="group___h5_l.html#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete</a> </li>
<li><a class="el" href="group___h5_l.html#gaaf5f820856afdd34f9070a797a246805" title="Removes the n-th link in a group.">H5Ldelete_by_idx</a> </li>
<li><a class="el" href="group___h5_l.html#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists</a> </li>
<li><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> (deprecated) </li>
<li><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> </li>
<li><a class="el" href="group___t_r_a_v.html#ga87e036da0c8d1146a073f3ee08e0fedc" title="Iterates through links in a group by its name.">H5Literate_by_name1</a> (deprecated) </li>
<li><a class="el" href="group___t_r_a_v.html#ga745a65eb516ce40a3be43490aaeb5c5e" title="Iterates through links in a group.">H5Literate_by_name2</a> </li>
<li><a class="el" href="group___t_r_a_v.html#ga5424ef7043c82147490d027a0e8a59ef" title="Recursively visits all links starting from a specified group.">H5Lvisit1</a> (deprecated) </li>
<li><a class="el" href="group___t_r_a_v.html#gae1c6f963892a5f4e8922a66fbe338f66" title="Recursively visits all links starting from a specified group.">H5Lvisit2</a> </li>
<li><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> (deprecated) </li>
<li><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> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">DATATYPE </th></tr>
<tr>
<td>commit </td><td><ul>
<li><a class="el" href="group___h5_t.html#ga1c00afb6dc5534778370a92c33fa2625" title="Commits a transient datatype to a file, creating a newly named datatype.">H5Tcommit1</a> (deprecated) </li>
<li><a class="el" href="group___h5_t.html#ga10352b6fa9ac58a7fbd5299496f1df31" title="Commits a transient datatype, linking it into the file and creating a new committed datatype.">H5Tcommit2</a> </li>
<li><a class="el" href="group___h5_t.html#ga9a224eb59f0ba807789e3f8ba3a840cd">H5Tcommit</a>+anon </li>
</ul>
</td></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_t.html#ga9f76fa0dc34bc7b310e100e5bfed66fb" title="Opens a named datatype.">H5Topen1</a> (deprecated) </li>
<li><a class="el" href="group___h5_t.html#ga7e65e77634f1fb4ba38cbcdab9a59bc2" title="Opens a committed (named) datatype.">H5Topen2</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_t.html#ga6802c22c6e90216aa839a4a83909a54c" title="Returns a copy of a datatype's creation property list.">H5Tget_create_plist</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_t.html#gafd60389b49e1e5e6f37caffbe6cbf6e5" title="Flushes all buffers associated with a committed datatype to disk.">H5Tflush</a> </li>
<li><a class="el" href="group___h5_t.html#ga5bc56f6b85e114829dc12d6b18d66f4d" title="Refreshes all buffers associated with a committed datatype.">H5Trefresh</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_t.html#gafcba4db244f6a4d71e99c6e72b8678f0" title="Releases a datatype.">H5Tclose</a> </li>
</ul>
</td></tr>
<tr>
<th colspan="2">ATTRIBUTE </th></tr>
<tr>
<td>create </td><td><ul>
<li><a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1</a> (deprecated) </li>
<li><a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2</a> </li>
<li><a class="el" href="group___h5_a.html#ga004160c28e281455ec48aa7fe557ef8a" title="Creates an attribute attached to a specified object.">H5Acreate_by_name</a> </li>
</ul>
</td></tr>
<tr>
<td>open </td><td><ul>
<li><a class="el" href="group___h5_a.html#ga59863b205b6d93b2145f0fbca49656f7" title="Opens an attribute for an object specified by object identifier and attribute name.">H5Aopen</a> </li>
<li><a class="el" href="group___h5_a.html#gab1451cdff4f77dcf9feaee83c8179b2d" title="Opens the nth attribute attached to an object.">H5Aopen_by_idx</a> </li>
<li><a class="el" href="group___h5_a.html#gadb49a0b5b9798d2e944d877adba8ae10" title="Opens an attribute for an object by object name and attribute name.">H5Aopen_by_name</a> </li>
<li><a class="el" href="group___h5_a.html#gadaa85276f2731ad78462a6fd27118470" title="Opens the attribute specified by its index.">H5Aopen_idx</a> (deprecated) </li>
<li><a class="el" href="group___h5_a.html#ga5c05fade96b6b7e2299f56a5b1edb1c1" title="Opens an attribute specified by name.">H5Aopen_name</a> (deprecated) </li>
</ul>
</td></tr>
<tr>
<td>read </td><td><ul>
<li><a class="el" href="group___h5_a.html#gaacb27a997f7c98e8a833d0fd63b58f1c" title="Reads the value of an attribute.">H5Aread</a> </li>
</ul>
</td></tr>
<tr>
<td>write </td><td><ul>
<li><a class="el" href="group___h5_a.html#gab70871e205d57450c83efd9912be2b5c" title="Writes data to an attribute.">H5Awrite</a> </li>
</ul>
</td></tr>
<tr>
<td>get </td><td><ul>
<li><a class="el" href="group___h5_a.html#ga0f6b545850bd21f128904eff51df226d" title="Gets an attribute creation property list identifier.">H5Aget_create_plist</a> </li>
<li><a class="el" href="group___h5_a.html#gae3f1b7b87240b461f7827a8783acc08a" title="Retrieves attribute information by attribute identifier.">H5Aget_info</a> </li>
<li><a class="el" href="group___h5_a.html#gad110910cb227c15fdca938a642714fe9" title="Retrieves attribute information by attribute index position.">H5Aget_info_by_idx</a> </li>
<li><a class="el" href="group___h5_a.html#ga258f03e12b4f49ad33ba72d17a9e2faf" title="Retrieves attribute information by attribute name.">H5Aget_info_by_name</a> </li>
<li><a class="el" href="group___h5_a.html#ga05e195aabab8c623b1c52009aeb99674" title="Gets an attribute name.">H5Aget_name</a> </li>
<li><a class="el" href="group___h5_a.html#ga4c552b2db32371f8ea20d87475313fb6" title="Gets an attribute name by attribute index position.">H5Aget_name_by_idx</a> </li>
<li><a class="el" href="group___h5_a.html#ga9e21e544119d03f9342530b45a71d74d" title="Gets a copy of the dataspace for an attribute.">H5Aget_space</a> </li>
<li><a class="el" href="group___h5_a.html#gabd11c8e11db0adde706e41a24a832f06" title="Returns the amount of storage used to store an attribute.">H5Aget_storage_size</a> </li>
<li><a class="el" href="group___h5_a.html#ga0b070b714b2e535df2e1cb3005026a44" title="Gets an attribute's datatype.">H5Aget_type</a> </li>
</ul>
</td></tr>
<tr>
<td>specific </td><td><ul>
<li><a class="el" href="group___h5_a.html#gada9fa3d6db52329f1fd55662de6ff6ba" title="Deletes an attribute from a specified location.">H5Adelete</a> </li>
<li><a class="el" href="group___h5_a.html#ga06711a4e77ff8ab49e427010fd38ac9e" title="Deletes an attribute from an object according to index order.">H5Adelete_by_idx</a> </li>
<li><a class="el" href="group___h5_a.html#gacbf689308f851428dd641b64f5f94feb" title="Removes an attribute from a specified location.">H5Adelete_by_name</a> </li>
<li><a class="el" href="group___h5_a.html#ga293b5be270d90cd5e47f782ca9aec80b" title="Determines whether an attribute with a given name exists on an object.">H5Aexists</a> </li>
<li><a class="el" href="group___h5_a.html#gaa1d2305651a4524f6aa0f8b56eec1a37" title="Determines whether an attribute with a given name exists on an object.">H5Aexists_by_name</a> </li>
<li><a class="el" href="group___h5_a.html#gabdb2cf7368eec0ad998cbe6a3f61aa41" title="Calls a user's function for each attribute on an object.">H5Aiterate1</a> (deprecated) </li>
<li><a class="el" href="group___h5_a.html#ga9315a22b60468b6e996559b1b8a77251" title="Calls a user-defined function for each attribute on an object.">H5Aiterate2</a> </li>
<li><a class="el" href="group___h5_a.html#ga75db973d69b61f673f5cdf21ac624cef" title="Calls user-defined function for each attribute on an object.">H5Aiterate_by_name</a> </li>
<li><a class="el" href="group___h5_a.html#ga490dcd6db246c1fda7295badfce28203" title="Renames an attribute.">H5Arename</a> </li>
<li><a class="el" href="group___h5_a.html#ga21f8483c935d72187b98f5e7c2056140">H5Arename_by_name</a> </li>
</ul>
</td></tr>
<tr>
<td>close </td><td><ul>
<li><a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose</a> </li>
</ul>
</td></tr>
</table>
<h1><a class="anchor" id="secVOLAppB"></a>
Appendix B Callback Wrapper API Calls for Passthrough Connector Authors</h1>
<div class="fragment"><div class="line"><span class="comment">/* Pass-through callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a542800ebb029002c3f82f4efe2d50ee3">H5VLget_object</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ad4d06542aef57546ccd1e40c4955e03e">H5VLget_wrap_ctx</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> **wrap_ctx);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aac5db40d46b03bf31d9cee91fdb5ca14">H5VLwrap_object</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> *wrap_ctx);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a613986d72333d30e5487ae334c8df0a1">H5VLunwrap_object</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#af769237a892ee3c20d7cd75d22a64fc6">H5VLfree_wrap_ctx</a>(<span class="keywordtype">void</span> *wrap_ctx, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for generic callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a8e43a9640d599a68b2ce281796920d88">H5VLinitialize</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vipl_id);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a45e9fa8c9a6c037aed0b0521bb884148">H5VLterminate</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a4ad793093a03375e7af24f27bc60c2e5">H5VLget_cap_flags</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, uint64_t *cap_flags);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#adc2fe50b5e8945e1ba778c05118381f2">H5VLget_value</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="group___h5_v_l_d_e_f.html#ga81b40d59b53c498f8aa9d92d0afdde2c">H5VL_class_value_t</a> *conn_value);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for info fields and callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a910252aef3ceccad24ccc1cd03a38450">H5VLcopy_connector_info</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> **dst_vol_info, <span class="keywordtype">void</span> *src_vol_info);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a19b87561296be6fb895fd123df3dc972">H5VLcmp_connector_info</a>(<span class="keywordtype">int</span> *cmp, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *info1, <span class="keyword">const</span> <span class="keywordtype">void</span> *info2);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a0d7c204a3db83d5563b0be557a3a4571">H5VLfree_connector_info</a>(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> *vol_info);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aac2b19b03066f3f9e07aae264de6bd14">H5VLconnector_info_to_str</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">char</span> **str);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a458256651d397c69a113dd180f50411f">H5VLconnector_str_to_info</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> **info);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for attribute callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ae52e1eebbdd8dc7ceb179ab694552a98">H5VLattr_create</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *attr_name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> acpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ae795c2b22a3c8c610770332082d5d567">H5VLattr_open</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ad5a4f0da0e12b4f37df203c982687bdb">H5VLattr_read</a>(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dtype_id, <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ac40f6f460fe5bc4de1db2f5ee7bdc647">H5VLattr_write</a>(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dtype_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a0455ecaf77b7e60008bdc5aedb748e66">H5VLattr_get</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__attr__get__args__t.html">H5VL_attr_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ac632a877cce1103f4e599959d4cc5460">H5VLattr_specific</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__attr__specific__args__t.html">H5VL_attr_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a29af736e7016e0d218f14d5e706794f5">H5VLattr_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a6f5ab5c95feb563669c61e71a1af79c9">H5VLattr_close</a>(<span class="keywordtype">void</span> *attr, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for dataset callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ab2b71f560cd6112c4b07de94335b30e8">H5VLdataset_create</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a43cee299f5913ddee33cd3a855da9048">H5VLdataset_open</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a9e8670dd258b866391da0633a823a01d">H5VLdataset_read</a>(<span class="keywordtype">size_t</span> count, <span class="keywordtype">void</span> *dset[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id[],</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <span class="keywordtype">void</span> *buf[],</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a5028517e60ff4ae4a34a6c9ff1185668">H5VLdataset_write</a>(<span class="keywordtype">size_t</span> count, <span class="keywordtype">void</span> *dset[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_type_id[],</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> mem_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> file_space_id[], <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">void</span> *buf[], <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a7cd52e5b61d504e7d6e3a769534efdc7">H5VLdataset_get</a>(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__dataset__get__args__t.html">H5VL_dataset_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aff9b695f422d86e9aff84a165acd2658">H5VLdataset_specific</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__dataset__specific__args__t.html">H5VL_dataset_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a9311dc565e5286c9f6e7d6594cf55781">H5VLdataset_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a678c02d9005a68920ca71c8078748fb5">H5VLdataset_close</a>(<span class="keywordtype">void</span> *dset, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for named datatype callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ac3f34096fc3f8a0e939eb479bdbd1f38">H5VLdatatype_commit</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a83e32eb893ad112df89d304bb32c3cea">H5VLdatatype_open</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> tapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#adafa64999e4dda2540843fe333a6a884">H5VLdatatype_get</a>(<span class="keywordtype">void</span> *dt, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__datatype__get__args__t.html">H5VL_datatype_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a6d9af2589e98fb0bc536a6dd1bc36ab1">H5VLdatatype_specific</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__datatype__specific__args__t.html">H5VL_datatype_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ab0de23d096ca426c2c7c81c22ca6ccf7">H5VLdatatype_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a49f02bbb1985181993a530f109b33707">H5VLdatatype_close</a>(<span class="keywordtype">void</span> *dt, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for file callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#abedac242a6b05c74630aee6717c6eb86">H5VLfile_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a5c60fb975ab92946e798c29d4490bc33">H5VLfile_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> flags, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a3c548e9cb2bd51331ee897aa86f21a46">H5VLfile_get</a>(<span class="keywordtype">void</span> *file, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__file__get__args__t.html">H5VL_file_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a3eeb23a2c3687d694a6dd0106bf34820">H5VLfile_specific</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__file__specific__args__t.html">H5VL_file_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ae9801ec2575976a0b5ed461ecb0b3689">H5VLfile_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a2c0def6910a6f7c52de27e0bb8d7a35c">H5VLfile_close</a>(<span class="keywordtype">void</span> *file, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for group callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a6e872a3063e66fae44331ad427c11f28">H5VLgroup_create</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#acd34999e825ada4964f0d4d367cad42f">H5VLgroup_open</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> gapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a8f16a678c422196f5b269fcf64eb0f57">H5VLgroup_get</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__group__get__args__t.html">H5VL_group_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aaa255508c8fd64a8f24ab66497ac3800">H5VLgroup_specific</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__group__specific__args__t.html">H5VL_group_specific_args_t</a> *args,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a2735899439c85a23e1a452ae980b9782">H5VLgroup_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#afa20af338f0722587bec9af00e7a041c">H5VLgroup_close</a>(<span class="keywordtype">void</span> *grp, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for link callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a0f65e11e4b66231e352093c97bbc8f3c">H5VLlink_create</a>(<a class="code hl_struct" href="struct_h5_v_l__link__create__args__t.html">H5VL_link_create_args_t</a> *args, <span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a3d24ef9796e673c78a7220edff4919ae">H5VLlink_copy</a>(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a09c1f3374d3b0aeabec554a8d63a082a">H5VLlink_move</a>(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keywordtype">void</span> *dst_obj,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ac87aec9385917d6f0d572de479f0bdb6">H5VLlink_get</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__link__get__args__t.html">H5VL_link_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a4d8d57fd847725b7f25817d2613858d7">H5VLlink_specific</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__link__specific__args__t.html">H5VL_link_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aa493c236d15cd60a610fbb4821e8d095">H5VLlink_optional</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for object callbacks */</span></div>
<div class="line">H5_DLL <span class="keywordtype">void</span> *<a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a3334754bfe6ae2b1d0eaaa9ee2aca7ed">H5VLobject_open</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> *opened_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ad3e5984fa0bebddfe9d38e8ba0257ceb">H5VLobject_copy</a>(<span class="keywordtype">void</span> *src_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params1, <span class="keyword">const</span> <span class="keywordtype">char</span> *src_name,</div>
<div class="line"> <span class="keywordtype">void</span> *dst_obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params2, <span class="keyword">const</span> <span class="keywordtype">char</span> *dst_name,</div>
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> ocpypl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a1d9c6243482bc42471e3be9393fb61d1">H5VLobject_get</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__object__get__args__t.html">H5VL_object_get_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a91f97ca5ec160ed4f2bff2fc1949cddd">H5VLobject_specific</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__object__specific__args__t.html">H5VL_object_specific_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a07bdc0a6e611e80240d610e25a4dc165">H5VLobject_optional</a>(<span class="keywordtype">void</span> *obj, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__loc__params__t.html">H5VL_loc_params_t</a> *loc_params, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <span class="keywordtype">void</span> **req);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for connector/container introspection callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a30c55c91df126248b0bf83e06a4c4cb8">H5VLintrospect_get_conn_cls</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a72dd04b7264916fe5cdfc5970fe8ae21">H5VL_get_conn_lvl_t</a> lvl,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_v_l__class__t.html">H5VL_class_t</a> **conn_cls);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a202087e28ac183af87331010965b9616">H5VLintrospect_get_cap_flags</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *info, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, uint64_t *cap_flags);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a3e1f197a5a90c4f3c5a8fb6ff6031cd6">H5VLintrospect_opt_query</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_enumeration" href="group___h5_v_l_d_e_f.html#ga14175ca7d867657e3e5c2f79a154a599">H5VL_subclass_t</a> subcls, <span class="keywordtype">int</span> opt_type,</div>
<div class="line"> uint64_t *flags);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for asynchronous request callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a7c04eeb53490737229ec93252b86e2f2">H5VLrequest_wait</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, uint64_t timeout,</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a9b490e7864366df596270c003af74468">H5VLrequest_notify</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_typedef" href="_h5_v_lconnector_8h.html#a418e1ef08bd10c57dc12f04b1e22f784">H5VL_request_notify_t</a> cb, <span class="keywordtype">void</span> *ctx);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#ae125d77504bfc8ba5edf68a5d1796856">H5VLrequest_cancel</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_enumeration" href="_h5_v_lconnector_8h.html#a9861877746c10d523dc8d5148f18ac3b">H5VL_request_status_t</a> *status);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a56983158d53c6f71ee5c7613f96265ef">H5VLrequest_specific</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__request__specific__args__t.html">H5VL_request_specific_args_t</a> *args);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a0d4fc41090ed919e7f134dcdd8bc2356">H5VLrequest_optional</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a4bdb448184824a25bb3f7ccecd99444b">H5VLrequest_free</a>(<span class="keywordtype">void</span> *req, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for blob callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a069eba2bccdc85798a789ce2bd0faeb6">H5VLblob_put</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *blob_id,</div>
<div class="line"> <span class="keywordtype">void</span> *ctx);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aecf782e83423e79fa4660c0d1b1978a8">H5VLblob_get</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <span class="keywordtype">void</span> *blob_id, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> size,</div>
<div class="line"> <span class="keywordtype">void</span> *ctx);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a4824cecde7ca9cdcee9df2f0db3c288a">H5VLblob_specific</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> *blob_id,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_v_l__blob__specific__args__t.html">H5VL_blob_specific_args_t</a> *args);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a24bda37b03b8caf0406d3822c23465df">H5VLblob_optional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keywordtype">void</span> *blob_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for token callbacks */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a91cd262c9fced15807636937f8ae91b6">H5VLtoken_cmp</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token1,</div>
<div class="line"> <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token2, <span class="keywordtype">int</span> *cmp_value);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a497f2cf9aefaba6f335be5a32dc3e109">H5VLtoken_to_str</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token,</div>
<div class="line"> <span class="keywordtype">char</span> **token_str);</div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#a1bdbf39a88dd00bb47a32eb1264df39b">H5VLtoken_from_str</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_enumeration" href="_h5_ipublic_8h.html#a13afe14178faf81b89fa2167e7ab832b">H5I_type_t</a> obj_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *token_str,</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> *token);</div>
<div class="line"> </div>
<div class="line"><span class="comment">/* Public wrappers for generic 'optional' callback */</span></div>
<div class="line">H5_DLL <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> <a class="code hl_function" href="_h5_v_lconnector__passthru_8h.html#aeeacac4f0290962703435fd2f4b794be">H5VLoptional</a>(<span class="keywordtype">void</span> *obj, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> connector_id, <a class="code hl_struct" href="struct_h5_v_l__optional__args__t.html">H5VL_optional_args_t</a> *args, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id,</div>
<div class="line"> <span class="keywordtype">void</span> **req);</div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a0455ecaf77b7e60008bdc5aedb748e66"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a0455ecaf77b7e60008bdc5aedb748e66">H5VLattr_get</a></div><div class="ttdeci">herr_t H5VLattr_get(void *obj, hid_t connector_id, H5VL_attr_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a069eba2bccdc85798a789ce2bd0faeb6"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a069eba2bccdc85798a789ce2bd0faeb6">H5VLblob_put</a></div><div class="ttdeci">herr_t H5VLblob_put(void *obj, hid_t connector_id, const void *buf, size_t size, void *blob_id, void *ctx)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a07bdc0a6e611e80240d610e25a4dc165"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a07bdc0a6e611e80240d610e25a4dc165">H5VLobject_optional</a></div><div class="ttdeci">herr_t H5VLobject_optional(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a09c1f3374d3b0aeabec554a8d63a082a"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a09c1f3374d3b0aeabec554a8d63a082a">H5VLlink_move</a></div><div class="ttdeci">herr_t H5VLlink_move(void *src_obj, const H5VL_loc_params_t *loc_params1, void *dst_obj, const H5VL_loc_params_t *loc_params2, hid_t connector_id, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a0d4fc41090ed919e7f134dcdd8bc2356"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a0d4fc41090ed919e7f134dcdd8bc2356">H5VLrequest_optional</a></div><div class="ttdeci">herr_t H5VLrequest_optional(void *req, hid_t connector_id, H5VL_optional_args_t *args)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a0d7c204a3db83d5563b0be557a3a4571"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a0d7c204a3db83d5563b0be557a3a4571">H5VLfree_connector_info</a></div><div class="ttdeci">herr_t H5VLfree_connector_info(hid_t connector_id, void *vol_info)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a0f65e11e4b66231e352093c97bbc8f3c"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a0f65e11e4b66231e352093c97bbc8f3c">H5VLlink_create</a></div><div class="ttdeci">herr_t H5VLlink_create(H5VL_link_create_args_t *args, void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a19b87561296be6fb895fd123df3dc972"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a19b87561296be6fb895fd123df3dc972">H5VLcmp_connector_info</a></div><div class="ttdeci">herr_t H5VLcmp_connector_info(int *cmp, hid_t connector_id, const void *info1, const void *info2)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a1bdbf39a88dd00bb47a32eb1264df39b"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a1bdbf39a88dd00bb47a32eb1264df39b">H5VLtoken_from_str</a></div><div class="ttdeci">herr_t H5VLtoken_from_str(void *obj, H5I_type_t obj_type, hid_t connector_id, const char *token_str, H5O_token_t *token)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a1d9c6243482bc42471e3be9393fb61d1"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a1d9c6243482bc42471e3be9393fb61d1">H5VLobject_get</a></div><div class="ttdeci">herr_t H5VLobject_get(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_object_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a202087e28ac183af87331010965b9616"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a202087e28ac183af87331010965b9616">H5VLintrospect_get_cap_flags</a></div><div class="ttdeci">herr_t H5VLintrospect_get_cap_flags(const void *info, hid_t connector_id, uint64_t *cap_flags)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a24bda37b03b8caf0406d3822c23465df"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a24bda37b03b8caf0406d3822c23465df">H5VLblob_optional</a></div><div class="ttdeci">herr_t H5VLblob_optional(void *obj, hid_t connector_id, void *blob_id, H5VL_optional_args_t *args)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a2735899439c85a23e1a452ae980b9782"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a2735899439c85a23e1a452ae980b9782">H5VLgroup_optional</a></div><div class="ttdeci">herr_t H5VLgroup_optional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a29af736e7016e0d218f14d5e706794f5"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a29af736e7016e0d218f14d5e706794f5">H5VLattr_optional</a></div><div class="ttdeci">herr_t H5VLattr_optional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a2c0def6910a6f7c52de27e0bb8d7a35c"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a2c0def6910a6f7c52de27e0bb8d7a35c">H5VLfile_close</a></div><div class="ttdeci">herr_t H5VLfile_close(void *file, hid_t connector_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a30c55c91df126248b0bf83e06a4c4cb8"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a30c55c91df126248b0bf83e06a4c4cb8">H5VLintrospect_get_conn_cls</a></div><div class="ttdeci">herr_t H5VLintrospect_get_conn_cls(void *obj, hid_t connector_id, H5VL_get_conn_lvl_t lvl, const H5VL_class_t **conn_cls)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a3334754bfe6ae2b1d0eaaa9ee2aca7ed"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a3334754bfe6ae2b1d0eaaa9ee2aca7ed">H5VLobject_open</a></div><div class="ttdeci">void * H5VLobject_open(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5I_type_t *opened_type, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a3c548e9cb2bd51331ee897aa86f21a46"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a3c548e9cb2bd51331ee897aa86f21a46">H5VLfile_get</a></div><div class="ttdeci">herr_t H5VLfile_get(void *file, hid_t connector_id, H5VL_file_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a3d24ef9796e673c78a7220edff4919ae"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a3d24ef9796e673c78a7220edff4919ae">H5VLlink_copy</a></div><div class="ttdeci">herr_t H5VLlink_copy(void *src_obj, const H5VL_loc_params_t *loc_params1, void *dst_obj, const H5VL_loc_params_t *loc_params2, hid_t connector_id, hid_t lcpl_id, hid_t lapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a3e1f197a5a90c4f3c5a8fb6ff6031cd6"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a3e1f197a5a90c4f3c5a8fb6ff6031cd6">H5VLintrospect_opt_query</a></div><div class="ttdeci">herr_t H5VLintrospect_opt_query(void *obj, hid_t connector_id, H5VL_subclass_t subcls, int opt_type, uint64_t *flags)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a3eeb23a2c3687d694a6dd0106bf34820"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a3eeb23a2c3687d694a6dd0106bf34820">H5VLfile_specific</a></div><div class="ttdeci">herr_t H5VLfile_specific(void *obj, hid_t connector_id, H5VL_file_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a43cee299f5913ddee33cd3a855da9048"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a43cee299f5913ddee33cd3a855da9048">H5VLdataset_open</a></div><div class="ttdeci">void * H5VLdataset_open(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t dapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a458256651d397c69a113dd180f50411f"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a458256651d397c69a113dd180f50411f">H5VLconnector_str_to_info</a></div><div class="ttdeci">herr_t H5VLconnector_str_to_info(const char *str, hid_t connector_id, void **info)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a45e9fa8c9a6c037aed0b0521bb884148"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a45e9fa8c9a6c037aed0b0521bb884148">H5VLterminate</a></div><div class="ttdeci">herr_t H5VLterminate(hid_t connector_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a4824cecde7ca9cdcee9df2f0db3c288a"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a4824cecde7ca9cdcee9df2f0db3c288a">H5VLblob_specific</a></div><div class="ttdeci">herr_t H5VLblob_specific(void *obj, hid_t connector_id, void *blob_id, H5VL_blob_specific_args_t *args)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a497f2cf9aefaba6f335be5a32dc3e109"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a497f2cf9aefaba6f335be5a32dc3e109">H5VLtoken_to_str</a></div><div class="ttdeci">herr_t H5VLtoken_to_str(void *obj, H5I_type_t obj_type, hid_t connector_id, const H5O_token_t *token, char **token_str)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a49f02bbb1985181993a530f109b33707"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a49f02bbb1985181993a530f109b33707">H5VLdatatype_close</a></div><div class="ttdeci">herr_t H5VLdatatype_close(void *dt, hid_t connector_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a4ad793093a03375e7af24f27bc60c2e5"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a4ad793093a03375e7af24f27bc60c2e5">H5VLget_cap_flags</a></div><div class="ttdeci">herr_t H5VLget_cap_flags(hid_t connector_id, uint64_t *cap_flags)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a4bdb448184824a25bb3f7ccecd99444b"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a4bdb448184824a25bb3f7ccecd99444b">H5VLrequest_free</a></div><div class="ttdeci">herr_t H5VLrequest_free(void *req, hid_t connector_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a4d8d57fd847725b7f25817d2613858d7"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a4d8d57fd847725b7f25817d2613858d7">H5VLlink_specific</a></div><div class="ttdeci">herr_t H5VLlink_specific(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_link_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a5028517e60ff4ae4a34a6c9ff1185668"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a5028517e60ff4ae4a34a6c9ff1185668">H5VLdataset_write</a></div><div class="ttdeci">herr_t H5VLdataset_write(size_t count, void *dset[], hid_t connector_id, hid_t mem_type_id[], hid_t mem_space_id[], hid_t file_space_id[], hid_t plist_id, const void *buf[], void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a542800ebb029002c3f82f4efe2d50ee3"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a542800ebb029002c3f82f4efe2d50ee3">H5VLget_object</a></div><div class="ttdeci">void * H5VLget_object(void *obj, hid_t connector_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a56983158d53c6f71ee5c7613f96265ef"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a56983158d53c6f71ee5c7613f96265ef">H5VLrequest_specific</a></div><div class="ttdeci">herr_t H5VLrequest_specific(void *req, hid_t connector_id, H5VL_request_specific_args_t *args)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a5c60fb975ab92946e798c29d4490bc33"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a5c60fb975ab92946e798c29d4490bc33">H5VLfile_open</a></div><div class="ttdeci">void * H5VLfile_open(const char *name, unsigned flags, hid_t fapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a613986d72333d30e5487ae334c8df0a1"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a613986d72333d30e5487ae334c8df0a1">H5VLunwrap_object</a></div><div class="ttdeci">void * H5VLunwrap_object(void *obj, hid_t connector_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a678c02d9005a68920ca71c8078748fb5"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a678c02d9005a68920ca71c8078748fb5">H5VLdataset_close</a></div><div class="ttdeci">herr_t H5VLdataset_close(void *dset, hid_t connector_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a6d9af2589e98fb0bc536a6dd1bc36ab1"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a6d9af2589e98fb0bc536a6dd1bc36ab1">H5VLdatatype_specific</a></div><div class="ttdeci">herr_t H5VLdatatype_specific(void *obj, hid_t connector_id, H5VL_datatype_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a6e872a3063e66fae44331ad427c11f28"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a6e872a3063e66fae44331ad427c11f28">H5VLgroup_create</a></div><div class="ttdeci">void * H5VLgroup_create(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a6f5ab5c95feb563669c61e71a1af79c9"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a6f5ab5c95feb563669c61e71a1af79c9">H5VLattr_close</a></div><div class="ttdeci">herr_t H5VLattr_close(void *attr, hid_t connector_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a7c04eeb53490737229ec93252b86e2f2"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a7c04eeb53490737229ec93252b86e2f2">H5VLrequest_wait</a></div><div class="ttdeci">herr_t H5VLrequest_wait(void *req, hid_t connector_id, uint64_t timeout, H5VL_request_status_t *status)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a7cd52e5b61d504e7d6e3a769534efdc7"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a7cd52e5b61d504e7d6e3a769534efdc7">H5VLdataset_get</a></div><div class="ttdeci">herr_t H5VLdataset_get(void *dset, hid_t connector_id, H5VL_dataset_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a83e32eb893ad112df89d304bb32c3cea"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a83e32eb893ad112df89d304bb32c3cea">H5VLdatatype_open</a></div><div class="ttdeci">void * H5VLdatatype_open(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t tapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a8e43a9640d599a68b2ce281796920d88"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a8e43a9640d599a68b2ce281796920d88">H5VLinitialize</a></div><div class="ttdeci">herr_t H5VLinitialize(hid_t connector_id, hid_t vipl_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a8f16a678c422196f5b269fcf64eb0f57"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a8f16a678c422196f5b269fcf64eb0f57">H5VLgroup_get</a></div><div class="ttdeci">herr_t H5VLgroup_get(void *obj, hid_t connector_id, H5VL_group_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a910252aef3ceccad24ccc1cd03a38450"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a910252aef3ceccad24ccc1cd03a38450">H5VLcopy_connector_info</a></div><div class="ttdeci">herr_t H5VLcopy_connector_info(hid_t connector_id, void **dst_vol_info, void *src_vol_info)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a91cd262c9fced15807636937f8ae91b6"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a91cd262c9fced15807636937f8ae91b6">H5VLtoken_cmp</a></div><div class="ttdeci">herr_t H5VLtoken_cmp(void *obj, hid_t connector_id, const H5O_token_t *token1, const H5O_token_t *token2, int *cmp_value)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a91f97ca5ec160ed4f2bff2fc1949cddd"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a91f97ca5ec160ed4f2bff2fc1949cddd">H5VLobject_specific</a></div><div class="ttdeci">herr_t H5VLobject_specific(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_object_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a9311dc565e5286c9f6e7d6594cf55781"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a9311dc565e5286c9f6e7d6594cf55781">H5VLdataset_optional</a></div><div class="ttdeci">herr_t H5VLdataset_optional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a9b490e7864366df596270c003af74468"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a9b490e7864366df596270c003af74468">H5VLrequest_notify</a></div><div class="ttdeci">herr_t H5VLrequest_notify(void *req, hid_t connector_id, H5VL_request_notify_t cb, void *ctx)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_a9e8670dd258b866391da0633a823a01d"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#a9e8670dd258b866391da0633a823a01d">H5VLdataset_read</a></div><div class="ttdeci">herr_t H5VLdataset_read(size_t count, void *dset[], hid_t connector_id, hid_t mem_type_id[], hid_t mem_space_id[], hid_t file_space_id[], hid_t plist_id, void *buf[], void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aa493c236d15cd60a610fbb4821e8d095"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aa493c236d15cd60a610fbb4821e8d095">H5VLlink_optional</a></div><div class="ttdeci">herr_t H5VLlink_optional(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aaa255508c8fd64a8f24ab66497ac3800"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aaa255508c8fd64a8f24ab66497ac3800">H5VLgroup_specific</a></div><div class="ttdeci">herr_t H5VLgroup_specific(void *obj, hid_t connector_id, H5VL_group_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aac2b19b03066f3f9e07aae264de6bd14"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aac2b19b03066f3f9e07aae264de6bd14">H5VLconnector_info_to_str</a></div><div class="ttdeci">herr_t H5VLconnector_info_to_str(const void *info, hid_t connector_id, char **str)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aac5db40d46b03bf31d9cee91fdb5ca14"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aac5db40d46b03bf31d9cee91fdb5ca14">H5VLwrap_object</a></div><div class="ttdeci">void * H5VLwrap_object(void *obj, H5I_type_t obj_type, hid_t connector_id, void *wrap_ctx)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ab0de23d096ca426c2c7c81c22ca6ccf7"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ab0de23d096ca426c2c7c81c22ca6ccf7">H5VLdatatype_optional</a></div><div class="ttdeci">herr_t H5VLdatatype_optional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ab2b71f560cd6112c4b07de94335b30e8"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ab2b71f560cd6112c4b07de94335b30e8">H5VLdataset_create</a></div><div class="ttdeci">void * H5VLdataset_create(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t lcpl_id, hid_t type_id, hid_t space_id, hid_t dcpl_id, hid_t dapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_abedac242a6b05c74630aee6717c6eb86"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#abedac242a6b05c74630aee6717c6eb86">H5VLfile_create</a></div><div class="ttdeci">void * H5VLfile_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ac3f34096fc3f8a0e939eb479bdbd1f38"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ac3f34096fc3f8a0e939eb479bdbd1f38">H5VLdatatype_commit</a></div><div class="ttdeci">void * H5VLdatatype_commit(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ac40f6f460fe5bc4de1db2f5ee7bdc647"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ac40f6f460fe5bc4de1db2f5ee7bdc647">H5VLattr_write</a></div><div class="ttdeci">herr_t H5VLattr_write(void *attr, hid_t connector_id, hid_t dtype_id, const void *buf, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ac632a877cce1103f4e599959d4cc5460"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ac632a877cce1103f4e599959d4cc5460">H5VLattr_specific</a></div><div class="ttdeci">herr_t H5VLattr_specific(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_attr_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ac87aec9385917d6f0d572de479f0bdb6"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ac87aec9385917d6f0d572de479f0bdb6">H5VLlink_get</a></div><div class="ttdeci">herr_t H5VLlink_get(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, H5VL_link_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_acd34999e825ada4964f0d4d367cad42f"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#acd34999e825ada4964f0d4d367cad42f">H5VLgroup_open</a></div><div class="ttdeci">void * H5VLgroup_open(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t gapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ad3e5984fa0bebddfe9d38e8ba0257ceb"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ad3e5984fa0bebddfe9d38e8ba0257ceb">H5VLobject_copy</a></div><div class="ttdeci">herr_t H5VLobject_copy(void *src_obj, const H5VL_loc_params_t *loc_params1, const char *src_name, void *dst_obj, const H5VL_loc_params_t *loc_params2, const char *dst_name, hid_t connector_id, hid_t ocpypl_id, hid_t lcpl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ad4d06542aef57546ccd1e40c4955e03e"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ad4d06542aef57546ccd1e40c4955e03e">H5VLget_wrap_ctx</a></div><div class="ttdeci">herr_t H5VLget_wrap_ctx(void *obj, hid_t connector_id, void **wrap_ctx)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ad5a4f0da0e12b4f37df203c982687bdb"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ad5a4f0da0e12b4f37df203c982687bdb">H5VLattr_read</a></div><div class="ttdeci">herr_t H5VLattr_read(void *attr, hid_t connector_id, hid_t dtype_id, void *buf, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_adafa64999e4dda2540843fe333a6a884"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#adafa64999e4dda2540843fe333a6a884">H5VLdatatype_get</a></div><div class="ttdeci">herr_t H5VLdatatype_get(void *dt, hid_t connector_id, H5VL_datatype_get_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_adc2fe50b5e8945e1ba778c05118381f2"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#adc2fe50b5e8945e1ba778c05118381f2">H5VLget_value</a></div><div class="ttdeci">herr_t H5VLget_value(hid_t connector_id, H5VL_class_value_t *conn_value)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ae125d77504bfc8ba5edf68a5d1796856"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ae125d77504bfc8ba5edf68a5d1796856">H5VLrequest_cancel</a></div><div class="ttdeci">herr_t H5VLrequest_cancel(void *req, hid_t connector_id, H5VL_request_status_t *status)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ae52e1eebbdd8dc7ceb179ab694552a98"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ae52e1eebbdd8dc7ceb179ab694552a98">H5VLattr_create</a></div><div class="ttdeci">void * H5VLattr_create(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ae795c2b22a3c8c610770332082d5d567"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ae795c2b22a3c8c610770332082d5d567">H5VLattr_open</a></div><div class="ttdeci">void * H5VLattr_open(void *obj, const H5VL_loc_params_t *loc_params, hid_t connector_id, const char *name, hid_t aapl_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_ae9801ec2575976a0b5ed461ecb0b3689"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#ae9801ec2575976a0b5ed461ecb0b3689">H5VLfile_optional</a></div><div class="ttdeci">herr_t H5VLfile_optional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aecf782e83423e79fa4660c0d1b1978a8"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aecf782e83423e79fa4660c0d1b1978a8">H5VLblob_get</a></div><div class="ttdeci">herr_t H5VLblob_get(void *obj, hid_t connector_id, const void *blob_id, void *buf, size_t size, void *ctx)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aeeacac4f0290962703435fd2f4b794be"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aeeacac4f0290962703435fd2f4b794be">H5VLoptional</a></div><div class="ttdeci">herr_t H5VLoptional(void *obj, hid_t connector_id, H5VL_optional_args_t *args, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_af769237a892ee3c20d7cd75d22a64fc6"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#af769237a892ee3c20d7cd75d22a64fc6">H5VLfree_wrap_ctx</a></div><div class="ttdeci">herr_t H5VLfree_wrap_ctx(void *wrap_ctx, hid_t connector_id)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_afa20af338f0722587bec9af00e7a041c"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#afa20af338f0722587bec9af00e7a041c">H5VLgroup_close</a></div><div class="ttdeci">herr_t H5VLgroup_close(void *grp, hid_t connector_id, hid_t dxpl_id, void **req)</div></div>
<div class="ttc" id="a_h5_v_lconnector__passthru_8h_html_aff9b695f422d86e9aff84a165acd2658"><div class="ttname"><a href="_h5_v_lconnector__passthru_8h.html#aff9b695f422d86e9aff84a165acd2658">H5VLdataset_specific</a></div><div class="ttdeci">herr_t H5VLdataset_specific(void *obj, hid_t connector_id, H5VL_dataset_specific_args_t *args, hid_t dxpl_id, void **req)</div></div>
</div><!-- fragment --><h1><a class="anchor" id="secVOLAppC"></a>
Appendix C Native VOL Connector Optional Values By Subclass</h1>
<div class="fragment"><div class="line"><span class="comment">/* H5VL_SUBCLS_ATTR */</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_ATTR_ITERATE_OLD 0 </span><span class="comment">/* H5Aiterate (deprecated routine) */</span><span class="preprocessor"></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* H5VL_SUBCLS_DATASET */</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_FORMAT_CONVERT 0 </span><span class="comment">/* H5Dformat_convert (internal) */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_CHUNK_INDEX_TYPE 1 </span><span class="comment">/* H5Dget_chunk_index_type */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_CHUNK_STORAGE_SIZE 2 </span><span class="comment">/* H5Dget_chunk_storage_size */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_NUM_CHUNKS 3 </span><span class="comment">/* H5Dget_num_chunks */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_CHUNK_INFO_BY_IDX 4 </span><span class="comment">/* H5Dget_chunk_info */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_CHUNK_INFO_BY_COORD 5 </span><span class="comment">/* H5Dget_chunk_info_by_coord */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_CHUNK_READ 6 </span><span class="comment">/* H5Dchunk_read */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_CHUNK_WRITE 7 </span><span class="comment">/* H5Dchunk_write */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_VLEN_BUF_SIZE 8 </span><span class="comment">/* H5Dvlen_get_buf_size */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_GET_OFFSET 9 </span><span class="comment">/* H5Dget_offset */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_DATASET_CHUNK_ITER 10 </span><span class="comment">/* H5Dchunk_iter */</span><span class="preprocessor"></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* H5VL_SUBCLS_FILE */</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_CLEAR_ELINK_CACHE 0 </span><span class="comment">/* H5Fclear_elink_file_cache */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_FILE_IMAGE 1 </span><span class="comment">/* H5Fget_file_image */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_FREE_SECTIONS 2 </span><span class="comment">/* H5Fget_free_sections */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_FREE_SPACE 3 </span><span class="comment">/* H5Fget_freespace */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_INFO 4 </span><span class="comment">/* H5Fget_info1/2 */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MDC_CONF 5 </span><span class="comment">/* H5Fget_mdc_config */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MDC_HR 6 </span><span class="comment">/* H5Fget_mdc_hit_rate */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MDC_SIZE 7 </span><span class="comment">/* H5Fget_mdc_size */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_SIZE 8 </span><span class="comment">/* H5Fget_filesize */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_VFD_HANDLE 9 </span><span class="comment">/* H5Fget_vfd_handle */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_RESET_MDC_HIT_RATE 10 </span><span class="comment">/* H5Freset_mdc_hit_rate_stats */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_SET_MDC_CONFIG 11 </span><span class="comment">/* H5Fset_mdc_config */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_METADATA_READ_RETRY_INFO 12 </span><span class="comment">/* H5Fget_metadata_read_retry_info */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_START_SWMR_WRITE 13 </span><span class="comment">/* H5Fstart_swmr_write */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_START_MDC_LOGGING 14 </span><span class="comment">/* H5Fstart_mdc_logging */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_STOP_MDC_LOGGING 15 </span><span class="comment">/* H5Fstop_mdc_logging */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MDC_LOGGING_STATUS 16 </span><span class="comment">/* H5Fget_mdc_logging_status */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_FORMAT_CONVERT 17 </span><span class="comment">/* H5Fformat_convert */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_RESET_PAGE_BUFFERING_STATS 18 </span><span class="comment">/* H5Freset_page_buffering_stats */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_PAGE_BUFFERING_STATS 19 </span><span class="comment">/* H5Fget_page_buffering_stats */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MDC_IMAGE_INFO 20 </span><span class="comment">/* H5Fget_mdc_image_info */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_EOA 21 </span><span class="comment">/* H5Fget_eoa */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_INCR_FILESIZE 22 </span><span class="comment">/* H5Fincrement_filesize */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_SET_LIBVER_BOUNDS 23 </span><span class="comment">/* H5Fset_latest_format/libver_bounds */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MIN_DSET_OHDR_FLAG 24 </span><span class="comment">/* H5Fget_dset_no_attrs_hint */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_SET_MIN_DSET_OHDR_FLAG 25 </span><span class="comment">/* H5Fset_dset_no_attrs_hint */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#ifdef H5_HAVE_PARALLEL</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_GET_MPI_ATOMICITY 26 </span><span class="comment">/* H5Fget_mpi_atomicity */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_SET_MPI_ATOMICITY 27 </span><span class="comment">/* H5Fset_mpi_atomicity */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_FILE_POST_OPEN 28 </span><span class="comment">/* Adjust file after open, with wrapping context */</span><span class="preprocessor"></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* H5VL_SUBCLS_GROUP */</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_GROUP_ITERATE_OLD 0 </span><span class="comment">/* HG5Giterate (deprecated routine) */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_GROUP_GET_OBJINFO 1 </span><span class="comment">/* HG5Gget_objinfo (deprecated routine) */</span><span class="preprocessor"></span></div>
<div class="line"> </div>
<div class="line"><span class="comment">/* H5VL_SUBCLS_OBJECT */</span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_GET_COMMENT 0 </span><span class="comment">/* H5G|H5Oget_comment, H5Oget_comment_by_name */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_SET_COMMENT 1 </span><span class="comment">/* H5G|H5Oset_comment, H5Oset_comment_by_name */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_DISABLE_MDC_FLUSHES 2 </span><span class="comment">/* H5Odisable_mdc_flushes */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_ENABLE_MDC_FLUSHES 3 </span><span class="comment">/* H5Oenable_mdc_flushes */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_ARE_MDC_FLUSHES_DISABLED 4 </span><span class="comment">/* H5Oare_mdc_flushes_disabled */</span><span class="preprocessor"></span></div>
<div class="line"><span class="preprocessor">#define H5VL_NATIVE_OBJECT_GET_NATIVE_INFO 5 </span><span class="comment">/* H5Oget_native_info(_by_idx, _by_name) */</span><span class="preprocessor"></span></div>
</div><!-- fragment --><hr />
<p> Navigate back: <a class="el" href="index.html">Main</a> / <a class="el" href="_v_o_l__connector.html">HDF5 Virtual Object Layer (VOL) Connector Author Guide</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</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>
|