doc/html/H5.api.html


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
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623

<html><head><title>
HDF5 Draft API Specification
</title></head><body>

<center>
<h1>HDF5: API Specification</h1>
</center>

<ol type=I>
<li><a href="#Library">Library</a> - H5&lt;name&gt; - API for global library HDF information/modification
<ol type=A>
    <li><a href="#Library-DontAtExit">H5dont_atexit</a>
    <li><a href="#Library-Close">H5close</a>
    <li><a href="#Library-Version">H5version</a>
</ol>

<li><a href="#File">File</a> - H5F&lt;name&gt; - API for accessing HDF files
<ol type=A>
    <li><a href="#File-Open">H5Fopen</a>
    <li><a href="#File-Create">H5Fcreate</a>
    <li><a href="#File-IsHDF5">H5Fis_hdf5</a>
    <li><a href="#File-GetCreatePlist">H5Fget_create_plist</a>
    <li><a href="#File-Close">H5Fclose</a>
</ol>

<li><a href="#Plist">Property list</a> - H5P&lt;name&gt; - API for manipulating object property lists
<ol type=A>
    <li><a href="#Plist-Create">H5Pcreate</a>
    <li><a href="#Plist-GetClass">H5Pget_class</a>
    <li><a href="#Plist-Copy">H5Pcopy</a>
    <li><a href="#Plist-Close">H5Pclose</a>
    <li><a href="#Plist-GetVersion">H5Pget_version</a>
    <li><a href="#Plist-SetUserblock">H5Pset_userblock</a>
    <li><a href="#Plist-GetUserblock">H5Pget_userblock</a>
    <li><a href="#Plist-SetSizes">H5Pset_sizes</a>
    <li><a href="#Plist-GetSizes">H5Pget_sizes</a>
    <li><a href="#Plist-SetMPI">H5Pset_mpi</a>
    <li><a href="#Plist-GetMPI">H5Pget_mpi</a>
    <li><a href="#Plist-SetXfer">H5Pset_xfer</a>
    <li><a href="#Plist-GetXfer">H5Pget_xfer</a>
    <li><a href="#Plist-SetSymK">H5Pset_sym_k</a>
    <li><a href="#Plist-GetSymK">H5Pget_sym_k</a>
    <li><a href="#Plist-SetIstoreK">H5Pset_istore_k</a>
    <li><a href="#Plist-GetIstoreK">H5Pget_istore_k</a>
    <li><a href="#Plist-SetLayout">H5Pset_layout</a>
    <li><a href="#Plist-GetLayout">H5Pget_layout</a>
    <li><a href="#Plist-SetChunk">H5Pset_chunk</a>
    <li><a href="#Plist-GetChunk">H5Pget_chunk</a>
</ol>

<!--
<li><a href="#Error">Error</a> - H5E&lt;name&gt; - API for error reporting
<ol type=A>
    <li><a href="#Error-SetPush">H5Eset_push</a>
</ol>
-->

<!--
<li><a href="#Relationships">Relationships</a> - H5R&lt;name&gt; - API for logically linking objects together (ie. attributes)
<ol type=A>
    <li><a href="#Relationships-GetNumRelations">H5Rget_num_relations</a>
    <li><a href="#Relationships-GetMemberOfOIDs">H5Rget_memberof_oids</a>
    <li><a href="#Relationships-GetAttachedOIDs">H5Rget_attached_oids</a>
    <li><a href="#Relationships-Attach">H5Rattach_oid</a>
</ol>
-->

<li><a href="#Dataset">Dataset</a> - H5D&lt;name&gt; - API for manipulating scientific datasets. See <a href="Datasets.html">datasets</a>.
<ol type=A>
    <li><a href="#Dataset-Create">H5Dcreate</a>
    <li><a href="#Dataset-Open">H5Dopen</a>
    <li><a href="#Dataset-GetSpace">H5Dget_space</a>
    <li><a href="#Dataset-GetType">H5Dget_type</a>
    <li><a href="#Dataset-GetCreateParms">H5Dget_create_parms</a>
    <li><a href="#Dataset-Read">H5Dread</a>
    <li><a href="#Dataset-Write">H5Dwrite</a>
    <li><a href="#Dataset-Extend">H5Dextend</a>
    <li><a href="#Dataset-Close">H5Dclose</a>
</ol>

<li><a href="#Datatype">Datatype</a> - H5T&lt;name&gt; - API for defining dataset element information. See <a href="Datatypes.html">data types</a>.
<ol type=A>
    <li><a href="#Datatype-Create">H5Tcreate</a>
    <li><a href="#Datatype-Copy">H5Tcopy</a>
    <li><a href="#Datatype-Equal">H5Tequal</a>
    <li><a href="#Datatype-Lock">H5Tlock</a>
    <li><a href="#Datatype-GetClass">H5Tget_class</a>
    <li><a href="#Datatype-GetSize">H5Tget_size</a>
    <li><a href="#Datatype-SetSize">H5Tset_size</a>
    <li><a href="#Datatype-GetOrder">H5Tget_order</a>
    <li><a href="#Datatype-SetOrder">H5Tset_order</a>
    <li><a href="#Datatype-GetPrecision">H5Tget_precision</a>
    <li><a href="#Datatype-SetPrecision">H5Tset_precision</a>
    <li><a href="#Datatype-GetOffset">H5Tget_offset</a>
    <li><a href="#Datatype-SetOffset">H5Tset_offset</a>
    <li><a href="#Datatype-GetPad">H5Tget_pad</a>
    <li><a href="#Datatype-SetPad">H5Tset_pad</a>
    <li><a href="#Datatype-GetSign">H5Tget_sign</a>
    <li><a href="#Datatype-SetSign">H5Tset_sign</a>
    <li><a href="#Datatype-GetFields">H5Tget_fields</a>
    <li><a href="#Datatype-SetFields">H5Tset_fields</a>
    <li><a href="#Datatype-GetEbias">H5Tget_ebias</a>
    <li><a href="#Datatype-SetEbias">H5Tset_ebias</a>
    <li><a href="#Datatype-GetNorm">H5Tget_norm</a>
    <li><a href="#Datatype-SetNorm">H5Tset_norm</a>
    <li><a href="#Datatype-GetInpad">H5Tget_inpad</a>
    <li><a href="#Datatype-SetInpad">H5Tset_inpad</a>
    <li><a href="#Datatype-GetCset">H5Tget_cset</a>
    <li><a href="#Datatype-SetCset">H5Tset_cset</a>
    <li><a href="#Datatype-GetStrpad">H5Tget_strpad</a>
    <li><a href="#Datatype-SetStrpad">H5Tset_strpad</a>
    <li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a>
    <li><a href="#Datatype-GetMemberName">H5Tget_member_name</a>
    <li><a href="#Datatype-GetMemberOffset">H5Tget_member_offset</a>
    <li><a href="#Datatype-GetMemberDims">H5Tget_member_dims</a>
    <li><a href="#Datatype-GetMemberType">H5Tget_member_type</a>
    <li><a href="#Datatype-Insert">H5Tinsert</a>
    <li><a href="#Datatype-Pack">H5Tpack</a>
    <li><a href="#Datatype-RegisterHard">H5Tregister_hard</a>
    <li><a href="#Datatype-RegisterSoft">H5Tregister_soft</a>
    <li><a href="#Datatype-Unregister">H5Tunregister</a>
    <li><a href="#Datatype-Close">H5Tclose</a>
</ol>

<li><a href="#Dataspace">Dataspace</a> - H5S&lt;name&gt; - API for defining dataset dataspace
<ol type=A>
    <li><a href="#Dataspace-CreateSimple">H5Screate_simple</a>
    <li><a href="#Dataspace-Copy">H5Scopy</a>
    <li><a href="#Dataspace-GetNpoints">H5Sget_npoints</a>
    <li><a href="#Dataspace-GetNdims">H5Sget_ndims</a>
    <li><a href="#Dataspace-GetDims">H5Sget_dims</a>
    <li><a href="#Dataspace-IsSimple">H5Sis_simple</a>
    <li><a href="#Dataspace-SetSpace">H5Sset_space</a>
    <li><a href="#Dataspace-SetHyperslab">H5Sset_hyperslab</a>
    <li><a href="#Dataspace-GetHyperslab">H5Sget_hyperslab</a>
    <li><a href="#Dataspace-Close">H5Sclose</a>
</ol>

<li><a href="#Group">Group</a> - H5G&lt;name&gt; - API for creating physical groups of objects on disk.
<ol type=A>
    <li><a href="#Group-Create">H5Gcreate</a>
    <li><a href="#Group-Open">H5Gopen</a>
    <li><a href="#Group-Set">H5Gset</a>
    <li><a href="#Group-Push">H5Gpush</a>
    <li><a href="#Group-Pop">H5Gpop</a>
    <li><a href="#Group-Close">H5Gclose</a>
<!--
    <li><a href="#Group-GetNumContents">get_num_contents</a>
    <li><a href="#Group-GetContentInfo">get_content_info</a>
    <li><a href="#Group-GetContentInfoMult">get_content_info_mult</a>
    <li><a href="#Group-GetOIDByName">get_oid_by_name</a>
    <li><a href="#Group-GetOIDByIndex">get_oid_by_index</a>
    <li><a href="#Group-GetNameByOID">get_name_by_oid</a>
    <li><a href="#Group-GetNameByIndex">get_name_by_index</a>
    <li><a href="#Group-InsertItem">insert_item</a>
    <li><a href="#Group-InsertItemMult">insert_item_mult</a>
    <li><a href="#Group-RemoveItem">remove_item</a>
    <li><a href="#Group-RemoveItemMult">remove_item_mult</a>
-->
</ol>

<li><a href="#Glossary">Glossary</a> - A glossary of data-types used in the APIs
<ol type=A>
    <li><a href="#Glossary-Basic">Basic Types</a>
    <li><a href="#Glossary-Complex">Complex Types</a>
    <li><a href="#Glossary-DiskIO">Disk I/O Types</a>
</ol>

</ol>

<hr>
<h2><a name="Library">Library API Functions</a></h2>
<P>These functions are designed to provide access to HDF5 application/library
behavior.  They are used to get information about or change global library
parameters.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Library-DontAtExit">H5dont_atexit</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5dont_atexit</code>(<em>void</em>)
<dt><strong>Description:</strong>
        <dd>This routine indicates to the library that an 'atexit()' cleanup routine
            should not be installed.  The major (only?) purpose for this is in
            situations where the library is dynamically linked into an application and
            is un-linked from the application before 'exit()' gets callled.  In those
            situations, a routine installed with 'atexit()' would jump to a routine
            which was no longer in memory, causing errors.
                In order to be effective, this routine <em>must</em> be called before any other
            HDF function calls, and must be called each time the library is loaded/
            linked into the application. (the first time and after it's been un-loaded)
<dt><strong>Parameters:</strong> <em>none</em>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Library-Close">H5close</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5close</code>(<em>void</em>)
<dt><strong>Description:</strong>
        <dd>This routines flushes all data to disk, closes all file handles and
            cleans up all memory used by the library.  Generally it is installed
            to be called when the application calls <em>exit</em>, but may be
            called earlier in event of an emergency shutdown or out of desire
            to free all resources used by the HDF5 library.
<dt><strong>Parameters:</strong> none
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Library-Version">H5version</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5version</code>(<em>uintn *</em><code>majversion</code>,
            <em>uintn *</em><code>minversion</code>,
            <em>uintn *</em><code>relversion</code>,
            <em>uintn *</em><code>patversion</code>
            )
<dt><strong>Description:</strong>
        <dd>This routine retrieves the major, minor, release and patch versions
            of the library which is linked to the application.  
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>uintn *</em><code>majversion</code>
            <dd>The major version of the library.
        <dt><em>uintn *</em><code>minversion</code>
            <dd>The minor version of the library.
        <dt><em>uintn *</em><code>relversion</code>
            <dd>The release number of the library.
        <dt><em>uintn *</em><code>patversion</code>
            <dd>The patch number of the library.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="File">File API Functions</a></h2>
<P>These functions are designed to provide file-level access to HDF5 files.
Further manipulation of objects inside a file is performed through one of APIs
documented below.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Open">H5Fopen</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fopen</code>(<em>const char *</em><code>name</code>,
            <em>uintn</em> <code>flags</code>,
            <em>hid_t</em> <code>access_plist</code>
        )
<dt><strong>Description:</strong>
        <dd>This is the primary function for opening existing HDF5 files.
            The <code>flags</code> parameter determines the file
            access mode.  There is no read flag, all open files are
            implicitily opened for read access.  All flags may be
            combined with the '|' (boolean OR operator) to change the
            behavior of the file open call.  The
            <code>access_plist</code> parameter is a property list
            containing additional information required for specific
            methods of access, parallel I/O for example.  The
            paramters for access property lists are described in the
            H5P API documentation.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>Name of the file to access.
        <dt><em>uintn</em> <code>flags</code>
            <dd>File access flags:
                <ul><dl>
                    <dt>H5F_ACC_RDWR
                        <dd>Allow read and write access to file.
                </dl></ul>
        <dt><em>hid_t</em><code>access_plist</code>
            <dd>Property list indicating the file access properties.
                If parallel file access is desired, this is a collective
                call according to the communicator stored in the
                access_plist.  Use 0 for default access properties.
    </dl>
<dt><strong>Returns:</strong>
    <dd>An ID (of type <em>hid_t</em>) for the file upon success,
        otherwise negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Create">H5Fcreate</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fcreate</code>(<em>const char *</em><code>name</code>,
            <em>uintn</em> <code>flags</code>,
            <em>hid_t</em> <code>create_plist</code>,
            <em>hid_t</em> <code>access_plist</code>
        )
<dt><strong>Description:</strong>
        <dd>This is the primary function for opening and creating HDF5 files.
            The <code>flags</code> parameter determines whether an
            existing file will be overwritten or not.  All newly
            created files are opened for both reading and writing.
            All flags may be combined with the '|' (boolean OR
            operator) to change the behavior of the file open call.
            The <code>create_plist</code> and
            <code>access_plist</code> parameters are property lists
            containing additional information required for specific
            methods of access or particular aspects of the file to set
            when creating a file.  The parameters for creation and
            access property lists are described in the H5P API
            documentation.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>Name of the file to access.
        <dt><em>uintn</em> <code>flags</code>
            <dd>File access flags:
                <ul><dl>
                    <dt>H5F_ACC_TRUNC
                        <dd>Truncate file, if it already exists.  The file will
                            be truncated, erasing all data previously stored in
                            the file.
                </dl></ul>
        <dt><em>hid_t</em><code>create_plist</code>
            <dd>File creation property list ID, used when modifying
                default file meta-data.
        <dt><em>hid_t</em><code>access_plist</code>
            <dd>Property list indicating the file access properties.
                If parallel file access is desired, this is a collective
                call according to the communicator stored in the
                access_plist.  Use 0 for default access properties.
    </dl>
<dt><strong>Returns:</strong>
    <dd>An ID (of type <em>hid_t</em>) for the file upon success,
        otherwise negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code>
        )
<dt><strong>Description:</strong>
        <dd>This function determines whether a file is in the HDF5 format.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em><code>name</code>
            <dd>File name to check format.
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE/FALSE/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-GetCreatePlist">H5Fget_create_plist</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Fget_create_plist</code>(<em>hid_t</em> <code>file_id</code>
        )
<dt><strong>Description:</strong>
        <dd>This function returns a property list ID with a copy of
            the parameters used to create this file.  Useful for
            duplicating the parameters when creating another file.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>File ID for which to get creation property list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="File-Close">H5Fclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Fclose</code>(<em>hid_t</em> <code>file_id</code>
        )
<dt><strong>Description:</strong>
        <dd>This function terminates access to an HDF5 file.  If this is the
            last file ID open for a file and if access IDs are still in use,
            this function will fail.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>File ID to terminate access to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="Plist">Property List API Functions</a></h2>
<P>These functions manipulate property lists to allow objects which require
many different parameters to be easily manipulated.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-Create">H5Pcreate</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Pcreate</code>(<em>H5P_class_t</em> <code>type</code>
        )
<dt><strong>Description:</strong>
        <dd>This function returns a property list ID for a copy of the default
            property list of a given type.
            <br>
    <dl>
        <dt>Property List Types and Uses:
            <ul><dl>
                <dt>H5P_FILE_CREATE
                    <dd>Used to set the metadata information about a file during
                        file creation.
                <dt>H5P_FILE_ACCESS
                    <dd>Used to set I/O access information about a file.
                <dt>H5P_DATASET_CREATE
                    <dd>Used to set information about a dataset when it is
                        created.
                <dt>H5P_DATASET_XFER
                    <dd>Used to set access information about a memory to dataset
                        transfer.
            </dl></ul>
    </dl>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>H5P_class_t</em> <code>type</code>
            <dd>The type of property list to create.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Valid ID on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-Close">H5Pclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pclose</code>(<em>hid_t</em> <code>plist_id</code>
        )
<dt><strong>Description:</strong>
        <dd>This function terminates access to a property list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to terminate access to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetClass">H5Pget_class</a>
<dt><strong>Signature:</strong>
    <dd><em>H5P_class_t </em><code>H5Pget_class</code>(<em>hid_t</em> <code>plist_id</code>
        )
<dt><strong>Description:</strong>
        <dd>This function queries the class of a property list ID.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Property list class code on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-Copy">H5Pcopy</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Pcopy</code>(<em>hid_t</em> <code>plist_id</code>
        )
<dt><strong>Description:</strong>
        <dd>This function makes a copy of a property list ID.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to duplicate.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Property list ID on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetVersion">H5Pget_version</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_version</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>int *</em> <code>boot</code>,
            <em>int *</em> <code>freelist</code>,
            <em>int *</em> <code>stab</code>,
            <em>int *</em> <code>shhdr</code>
        )
<dt><strong>Description:</strong>
        <dd>This function queries the version information of various objects
            for a file creation property list.  Any pointer parameters
            which are passed as NULL are not queried.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>int *</em> <code>boot</code>
            <dd>Pointer to location to return boot block version number.
        <dt><em>int *</em> <code>freelist</code>
            <dd>Pointer to location to return global freelist version number.
        <dt><em>int *</em> <code>stab</code>
            <dd>Pointer to location to return symbol table version number.
        <dt><em>int *</em> <code>shhdr</code>
            <dd>Pointer to location to return shared object header version number.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetUserblock">H5Pset_userblock</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_userblock</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>hsize_t</em> <code>size</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the size of the user-block located at the 
            beginning of an HDF5 file.  This function is only valid for
            file creation property lists.  The default user-block size is 0.
            Only values which are powers of 2 larger equal to 512 or larger
            may be used as a valid user-block size.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list to modify.
        <dt><em>hsize_t</em> <code>size</code>
            <dd>Size of the user-block in bytes.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetUserblock">H5Pget_userblock</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_userblock</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>hsize_t *</em> <code>size</code>
        )
<dt><strong>Description:</strong>
        <dd>This function retrieves the size of the user-block located at the 
            beginning of an HDF5 file.  This function is only valid for
            file creation property lists.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>hsize_t *</em> <code>size</code>
            <dd>Pointer to location to return user-block size.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetSizes">H5Pset_sizes</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_sizes</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t</em> <code>sizeof_addr</code>,
            <em>size_t</em> <code>sizeof_size</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the byte size of the offsets and lengths used to
            address objects in an HDF5 file.  This function is only
            valid for file creation property lists.  Passing in a
            value of 0 for one of the sizeof parameters retains the
            current value.  The default value for both values is 4
            bytes.  Valid values currenly are 2, 4, 8 and 16.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list to modify.
        <dt><em>size_t</em> <code>sizeof_addr</code>
            <dd>Size of an object offset in bytes.
        <dt><em>size_t</em> <code>sizeof_size</code>
            <dd>Size of an object length in bytes.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetSizes">H5Pget_sizes</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_sizes</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t *</em> <code>sizeof_addr</code>,
            <em>size_t *</em> <code>sizeof_size</code>
        )
<dt><strong>Description:</strong>
        <dd>This function retrieves the size of the offsets and lengths used
            in an HDF5 file.  This function is only valid for file creation
            property lists.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>size_t *</em> <code>size</code>
            <dd>Pointer to location to return offset size in bytes.
        <dt><em>size_t *</em> <code>size</code>
            <dd>Pointer to location to return length size in bytes.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetMPI">H5Pset_mpi</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_mpi</code>(<em>hid_t</em> <code>tid</code>,
            <em>MPI_Comm</em> <code>comm</code>,
            <em>MPI_Info</em> <code>info</code>
        )
<dt><strong>Description:</strong>
        <dd>Store the access mode for parallel I/O call and the user supplied
	    communicator and info in the access property list which can then
	    be used to open file.  This function is available only in the
            parallel HDF5 library.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tid</code>
            <dd>ID of property list to modify
        <dt><em>MPI_Comm</em> <code>comm</code>
            <dd>
      	    MPI communicator to be used for file open as defined in
                  MPI_FILE_OPEN of MPI-2.  This function  does not make a
                  duplicated communicator. Any modification to comm after
                  this function call returns may have undetermined effect
                  to the access property list.  Users should call this function
                  again to setup the property list.
        <dt><em>MPI_Info</em> <code>info</code>
            <dd>
      	    MPI info object to be used for file open as defined in
                  MPI_FILE_OPEN of MPI-2.  This function  does not make a
                  duplicated info. Any modification to info after
                  this function call returns may have undetermined effect
                  to the access property list.  Users should call this function
                  again to setup the property list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetMPI">H5Pget_mpi</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_mpi</code>(<em>hid_t</em> <code>tid</code>,
            <em>MPI_Comm</em> <code>*comm</code>,
            <em>MPI_Info</em> <code>*info</code>
        )
<dt><strong>Description:</strong>
        <dd>Retrieves the communicator and info object
	    that have been set by H5Pset_mpi.
	    This function is available only in the parallel HDF5 library.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tid</code>
            <dd>ID of a file access property list that has been set
	        successfully by H5Pset_mpi.
        <dt><em>MPI_Comm *</em> <code>comm</code>
            <dd>Pointer to location to return the communicator.
        <dt><em>MPI_Info *</em> <code>info</code>
            <dd>Pointer to location to return the info object.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetXfer">H5Pset_xfer</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_xfer</code>(<em>hid_t</em> <code>tid</code>,
            <em>H5D_transfer_t</em> <code>data_xfer_mode</code>
        )
<dt><strong>Description:</strong>
        <dd>Set the transfer mode of the dataset transfer property list.
            The list can then be used to control the I/O transfer mode
            during dataset accesses.  This function is available only
            in the parallel HDF5 library and is not a collective function.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tid</code>
            <dd>ID of a dataset transfer property list
        <dt><em>H5D_transfer_t</em> <code>data_xfer_mode</code>
            <dd>Data transfer modes:
                <ul><dl>
                    <dt>H5D_XFER_INDEPENDENT
                        <dd>Use independent I/O access.
                    <dt>H5D_XFER_COLLECTIVE
                        <dd>Use MPI collective I/O access.
                </dl></ul>
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetXfer">H5Pget_xfer</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_xfer</code>(<em>hid_t</em> <code>tid</code>,
            <em>H5D_transfer_t *</em> <code>data_xfer_mode</code>
        )
<dt><strong>Description:</strong>
        <dd>Retrieves the transfer mode from the dataset
	    transfer property list.
	    This function is available only in the parallel HDF5 library.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tid</code>
            <dd>ID of a dataset transfer property list.
        <dt><em>H5D_transfer_t *</em> <code>data_xfer_mode</code>
            <dd>Pointer to location to return the data_xfer_mode.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetSymK">H5Pset_sym_k</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_sym_k</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t</em> <code>ik</code>,
            <em>size_t</em> <code>lk</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the size of parameters used to control the
            symbol table nodes.  This function is only valid for file
            creation property lists.  Passing in a value of 0 for one
            of the parameters retains the current value.
            <code>ik</code> is one half the rank of a tree that stores
            a symbol table for a group.  Internal nodes of the symbol
            table are on average 75% full.  That is, the average rank
            of the tree is 1.5 times the value of
            <code>ik</code>. <code>lk</code> is one half of the number
            of symbols that can be stored in a symbol table node.  A
            symbol table node is the leaf of a symbol table tree which
            is used to store a group.  When symbols are inserted
            randomly into a group, the group's symbol table nodes are
            75% full on average.  That is, they contain 1.5 times the
            number of symbols specified by <code>lk</code>.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>size_t</em> <code>ik</code>
            <dd>Symbol table tree rank.
        <dt><em>size_t</em> <code>lk</code>
            <dd>Symbol table node size.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetSymK">H5Pget_sym_k</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_sym_k</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t *</em> <code>ik</code>,
            <em>size_t *</em> <code>lk</code>
        )
<dt><strong>Description:</strong>
        <dd>This function retrieves the size of the symbol table's B-tree
            1/2 rank and the symbol table's leaf node 1/2 size.  See
            information for <a href="#Plist-SetSymK">H5Pset_sym_k</a>
	    for more information.  This function is only valid for file
            creation property lists.  If a parameter valued is set to
            NULL, that parameter is not retrieved.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>size_t *</em> <code>ik</code>
            <dd>Pointer to location to return the symbol table's B-tree 1/2 rank.
        <dt><em>size_t *</em> <code>size</code>
            <dd>Pointer to location to return the symbol table's leaf node 1/2 size.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetIstoreK">H5Pset_istore_k</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_istore_k</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t</em> <code>ik</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the size of the parameter used to control the
            B-trees for indexing chunked datasets.  This function is
            only valid for file creation property lists.  Passing in a
            value of 0 for one of the parameters retains the current
            value.  <code>ik</code> is one half the rank of a tree
            that stores chunked raw data.  On average, such a tree
            will be 75% full, or have an average rank of 1.5 times the
            value of <code>ik</code>.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>size_t</em> <code>ik</code>
            <dd>1/2 rank of chunked storage B-tree.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetIstoreK">H5Pget_istore_k</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_istore_k</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>size_t *</em> <code>ik</code>
        )
<dt><strong>Description:</strong>
        <dd>Queries the 1/2 rank of an indexed storage B-tree.  See
            <a href="#Plist-SetIstoreK">H5Pset_istore_k</a> for details.
            The argument <code>ik</code> may be the null pointer.  This
            function is only valid for file creation property lists.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>size_t *</em> <code>ik</code>
            <dd>Pointer to location to return the chunked storage B-tree 1/2 rank.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetLayout">H5Pset_layout</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_layout</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>H5D_layout_t</em> <code>layout</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the type of storage used store the raw data for
            a dataset.  This function is only valid for dataset
            creation property lists. Valid parameter for
            <code>layout</code> are:
            <ul> <dl>
                <dt>H5D_COMPACT
                    <dd>Store raw data and object header contiguously in file.
                        This should only be used for very small amounts of raw
                        data (suggested less than 1KB).
                <dt>H5D_CONTIGUOUS
                    <dd>Store raw data seperately from object header in one
                        large chunk in the file.
                <dt>H5D_CHUNKED
                    <dd>Store raw data seperately from object header in one
                        large chunk in the file and store chunks of the raw
                        data in seperate locations in the file.
            </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>H5D_layout_t</em> <code>layout</code>
            <dd>Type of storage layout for raw data.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetLayout">H5Pget_layout</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_layout</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>H5D_layout_t *</em> <code>layout</code>
        )
<dt><strong>Description:</strong>
        <dd>Queries the layout of the raw data for a dataset.
            This function is only valid for dataset creation property lists.
            Valid types for <code>layout</code> are:
            <ul> <dl>
                <dt>H5D_COMPACT
                    <dd>Raw data and object header stored contiguously in file.
                <dt>H5D_CONTIGUOUS
                    <dd>Raw data stored seperately from object header in one
                        large chunk in the file.
                <dt>H5D_CHUNKED
                    <dd>Raw data stored seperately from object header in 
                        chunks in seperate locations in the file.
            </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>H5D_layout_t *</em> <code>layout</code>
            <dd>Pointer to location to return the storage layout.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-SetChunk">H5Pset_chunk</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pset_chunk</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>int</em> <code>ndims</code>,
            <em>const hsize_t *</em> <code>dim</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets the size of the chunks used to store a chunked
            layout dataset.  This function is only valid for dataset
            creation property lists.  The <code>ndims</code> parameter
            currently must be the same size as the rank of the
            dataset.  The values of the <code>dim</code> array define
            the size of the chunks to store the dataset's raw data.
            As a side-effect, the layout of the dataset is changed to
            H5D_CHUNKED, if it isn't already.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>int</em> <code>ndims</code>
            <dd>The number of dimensions of each chunk.
        <dt><em>const hsize_t *</em> <code>dim</code>
            <dd>An array containing the size of each chunk.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Plist-GetChunk">H5Pget_chunk</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Pget_chunk</code>(<em>hid_t</em> <code>plist_id</code>,
            <em>int</em> <code>max_ndims</code>
            <em>hsize_t *</em> <code>dims</code>
        )
<dt><strong>Description:</strong>
        <dd>Queries the size of chunks for the raw data of a chunked layout
            dataset.  This function is only valid for dataset creation
            property lists.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>Property list ID to query.
        <dt><em>int</em> <code>max_ndims</code>
            <dd>Size of the <code>dims</code> array.
        <dt><em>hsize_t *</em> <code>dims</code>
            <dd>Array to store the chunk dimensions.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<!--
<hr>
<h2><a name="Error">Error API Functions</a></h2>
<P>These functions allow flexible error reporting for the HDF5 library.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Error-SetPush">H5Eset_push</a>
<dt><strong>Signature:</strong>
    <dd><em>H5E_push_func_t </em><code>H5Eset_push</code>(<em>H5E_push_func_t</em> <code>func</code>
        )
<dt><strong>Description:</strong>
        <dd>This function sets a function to call when an error is detected in
            the library.  The prototype of the H5E_push_func_t is: <br>
void H5E_push_func_t(int32 errid, hdf_maj_err_code_t maj, hdf_min_err_code_t min, const char *function_name, const char *file_name, intn line);
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>H5E_push_func_t</em><code>func</code>
            <dd>Pointer to the error reporting function.
    </dl>
<dt><strong>Returns:</strong>
    <dd>The pointer to the previous error repoting function on succes, NULL on failure
</dl>
-->

<!--
<hr>
<h2><a name="Relationships">Relationships API Functions</a></h2>
<P>These functions provide methods of creating links between logically
related objects in a file.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Relationships-GetNumRelations">H5Rget_num_relations</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Rget_num_relations</code>(<em>hid_t </em><code>obj_id</code>,
            <em>int32 *</em><code>num_attached</code>,
            <em>int32 *</em><code>num_memberof</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the number of relationships attached to the
        object and the number of other objects that the object is a member of
        itself.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>obj_id</code>
            <dd>ID of the object to query the number of attached relations
        <dt><em>int32 *</em> <code>num_attached</code>
            <dd>Number of objects attached to the object
        <dt><em>int32 *</em> <code>num_memberof</code>
            <dd>Number of objects that the object is a member of
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Relationships-GetMemberOfOIDs">H5Rget_memberof_oids</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Rget_memberof_oids</code>(<em>hid_t </em><code>obj_id</code>,
            <em>hoid_t </em><code>memberof_list[]</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the OIDs of the objects that the object is a
        member of.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>obj_id</code>
            <dd>ID of the object to get the members of list
        <dt><em>hoid_t *</em> <code>memberof_list</code>
            <dd>A list of the OIDs for objects which the object is attached to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Relationships-GetAttachedOIDs">H5Rget_attached_oids</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Rget_attached_oids</code>(<em>hid_t </em><code>obj_id</code>,
            <em>hoid_t </em><code>attached_list[]</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the OIDs of the objects that are attached to 
        the object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>obj_id</code>
            <dd>ID of the object to get the attached OIDs from
        <dt><em>hoid_t *</em> <code>attached_list</code>
            <dd>A list of the OIDs for objects which are attached to the
                object
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Relationships-Attach">H5Rattach_oid</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Rattach_oid</code>(<em>hid_t </em><code>obj_id</code>,
            <em>hoid_t </em><code>attach</code>
    )
<dt><strong>Description:</strong>
    <dd>This function attaches an OID to the object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>obj_id</code>
            <dd>ID of the object to attach an OID to
        <dt><em>hoid_t </em> <code>attach</code>
            <dd>The OID to attach to the object
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>
-->

<hr>
<h2><a name="Dataset">Dataset Object API Functions</a></h2>
<P>These functions create and manipulate dataset objects.  Each dataset must
be constructed from a datatype and a dataspace.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Create">H5Dcreate</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dcreate</code>(<em>hid_t </em><code>file_id</code>,
        <em>const char *</em><code>name</code>,
        <em>hid_t</em><code>type_id</code>,
        <em>hid_t</em><code>space_id</code>,
        <em>hid_t</em><code>plist_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function creates a new dataset in the file specified with the
        <code>file_id</code>.  The <code>type_id</code> and
        <code>space_id</code> are the IDs of the datatype and
        dataspace used to construct the framework of the dataset.  The
        datatype and dataspace parameters describe the dataset as it
        will exist in the file, which is not necessarily the same as
        it exists in memory.  The <code>plist_id</code> contains
        either the default property lists (H5P_DEFAULT) or a plist_id
        with particular constant properties used to create the
        dataset.  The <code>name</code> is used to identify the
        dataset in a group and must be unique within that group.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>ID of the file to create the dataset within.
        <dt><em>const char *</em> <code>name</code>
            <dd>The name of the dataset to create.
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of the datatype to use when creating the dataset.
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace to use when creating the dataset.
        <dt><em>hid_t</em> <code>plist_id</code>
            <dd>ID of the dataset creation property list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Dataset ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Open">H5Dopen</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dopen</code>(<em>hid_t </em><code>file_id</code>,
        <em>const char *</em><code>name</code>
    )
<dt><strong>Description:</strong>
    <dd>This function opens an existing dataset for access in the file
        specified with the <code>file_id</code>.  The <code>name</code> is
        used to identify the dataset in the file.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>ID of the file to access the dataset within.
        <dt><em>const char *</em> <code>name</code>
            <dd>The name of the dataset to access.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Dataset ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-GetSpace">H5Dget_space</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dget_space</code>(<em>hid_t </em><code>dataset_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns a copy of the dataspace for a dataset.  The
        dataspace should be released with the H5Sclose() function.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Dataspace ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-GetType">H5Dget_type</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dget_type</code>(<em>hid_t </em><code>dataset_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns a copy of the datatype for a dataset.  The
        dataspace should be released with the H5Tclose() function.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Datatype ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-GetCreateParms">H5Dget_create_plist</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dget_create_plist</code>(<em>hid_t </em><code>dataset_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns a copy of the dataset creation property
        list for a dataset.  The property list should be released with the
        H5Pclose() function.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Dataset creation property list ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Read">H5Dread</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Dread</code>(<em>hid_t </em><code>dataset_id</code>,
        <em>hid_t</em> <code>mem_type_id</code>,
        <em>hid_t</em> <code>mem_space_id</code>,
        <em>hid_t</em> <code>file_space_id</code>,
        <em>hid_t</em> <code>transfer_plist_id</code>,
        <em>void *</em> <code>buf</code>
    )
<dt><strong>Description:</strong>
    <dd>This function reads raw data from the specified dataset into <code>buf</code>,
        converting from the file datatype of the dataset into the
        memory datatype specified in <code>mem_type_id</code>.  The
        portion of the dataset to read from disk is specified with the
        <code>file_spaceid</code> which can contain a dataspace with a
        hyperslab selected or the constant H5S_ALL, which indicates
        the entire dataset is to be read.  The portion of the dataset
        read into the memory buffer is specified with the
        <code>mem_space_id</code> which can also be a hyperslab of the
        same size or the H5S_ALL parameter to store the entire
        dataset.  The <code>transfer_plist_id</code> is a dataset
        transfer property list ID which is used to provide addition
        parameters for the I/O operation or can be H5P_DEFAULT for the
        default library behavior.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset read from.
        <dt><em>hid_t</em> <code>mem_type_id</code>
            <dd>ID of the memory datatype.
        <dt><em>hid_t</em> <code>mem_space_id</code>
            <dd>ID of the memory dataspace.
        <dt><em>hid_t</em> <code>file_space_id</code>
            <dd>ID of the dataset's dataspace in the file.
        <dt><em>hid_t</em> <code>transfer_plist_id</code>
            <dd>ID of a transfer property list for this I/O operation.
        <dt><em>void *</em> <code>buf</code>
            <dd>Buffer to store information read from the file.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Write">H5Dwrite</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Dwrite</code>(<em>hid_t </em><code>dataset_id</code>,
        <em>hid_t</em> <code>mem_type_id</code>,
        <em>hid_t</em> <code>mem_space_id</code>,
        <em>hid_t</em> <code>file_space_id</code>,
        <em>hid_t</em> <code>transfer_plist_id</code>,
        <em>const void *</em> <code>buf</code>
    )
<dt><strong>Description:</strong>
    <dd>This function writes raw data from memory into the specified dataset
        converting from the memory datatype of the dataset specified
        in <code>mem_type_id</code> into the file datatype.  The
        portion of the dataset to written to disk is specified with
        the <code>file_spaceid</code> which can contain a dataspace
        with a hyperslab selected or the constant H5S_ALL, which
        indicates the entire dataset is to be written.  The portion of
        the dataset written from the memory buffer is specified with
        the <code>mem_space_id</code> which can also be a hyperslab of
        the same size or the H5S_ALL parameter to store the entire
        dataset.  The <code>transfer_plist_id</code> is a dataset
        transfer property list ID which is used to provide addition
        parameters for the I/O operation or can be H5P_DEFAULT for the
        default library behavior.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset read from.
        <dt><em>hid_t</em> <code>mem_type_id</code>
            <dd>ID of the memory datatype.
        <dt><em>hid_t</em> <code>mem_space_id</code>
            <dd>ID of the memory dataspace.
        <dt><em>hid_t</em> <code>file_space_id</code>
            <dd>ID of the dataset's dataspace in the file.
        <dt><em>hid_t</em> <code>transfer_plist_id</code>
            <dd>ID of a transfer property list for this I/O operation.
        <dt><em>const void *</em> <code>buf</code>
            <dd>Buffer to store information to be written to the file.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Extend">H5Dextend</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Dextend</code>(<em>hid_t </em><code>dataset_id</code>,
        <em>const hsize_t *</em> <code>size</code>
    )
<dt><strong>Description:</strong>
    <dd>This function increases the size of the dataspace of a dataset with
        unlimited dimensions.  It cannot be used to extend the size of a
        dataspace's fixed dimensions.  The <code>size</code> array must have
        the same number of entries as the rank of the dataset's dataspace.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset read from.
        <dt><em>const hsize_t *</em> <code>size</code>
            <dd>Array containing the new magnitude of each dimension.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataset-Close">H5Dclose</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Dclose</code>(<em>hid_t </em><code>dataset_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function ends access to a dataset and releases resources used by
        it.  Further use of the dataset ID is illegal in calls to the dataset
        API.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>dataset_id</code>
            <dd>ID of the dataset to finish access to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="Datatype">Datatype Object API Functions</a></h2>
<P>These functions create and manipulate the datatype which describes elements
of a dataset.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Create">H5Tcreate</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Tcreate</code>(<em>H5T_class_t </em><code>class</code>,
        <em>size_t</em><code>size</code>
    )
<dt><strong>Description:</strong>
    <dd>This function creates a new dataype of the specified class with the
        specified number of bytes.  Currently, only the <code>H5T_COMPOUND</code>
        datatype class is supported with this function, use <code>H5Tcopy</code>
        to create integer or floating-point datatypes.  The datatype ID
        returned from this function should be released with H5Tclose or resource
        leaks will result.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>H5T_class_t</em> <code>class</code>
            <dd>Class of datatype to create.
        <dt><em>size_t</em> <code>size</code>
            <dd>The number of bytes in the datatype to create.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Datatype ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Copy">H5Tcopy</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Tcopy</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function copies an existing datatype.  The datatype ID returned
        should be released with H5Tclose or resource leaks will occur.  Native
        datatypes supported by the library are:
        <ul> <dl>
            <dt>H5T_NATIVE_CHAR
                <dd> Native character type, declare dataset array as 'char'
            <dt>H5T_NATIVE_UCHAR
                <dd> Native unsigned character type, declare dataset array as 'unsigned char'
            <dt>H5T_NATIVE_SHORT
                <dd> Native short type, declare dataset array as 'short'
            <dt>H5T_NATIVE_USHORT
                <dd> Native unsigned short type, declare dataset array as 'unsigned short'
            <dt>H5T_NATIVE_INT
                <dd> Native int type, declare dataset array as 'int'
            <dt>H5T_NATIVE_UINT
                <dd> Native unsigned int type, declare dataset array as 'unsigned int'
            <dt>H5T_NATIVE_LONG
                <dd> Native long type, declare dataset array as 'unsigned long'
            <dt>H5T_NATIVE_ULONG
                <dd> Native unsigned long type, declare dataset array as 'unsigned long'
            <dt>H5T_NATIVE_LLONG
                <dd> Native long long type, declare dataset array as 'unsigned long long'
            <dt>H5T_NATIVE_ULLONG
                <dd> Native unsigned long long type, declare dataset array as 'unsigned long long'
            <dt>H5T_NATIVE_INT8
                <dd> Native signed 8-bit type, declare dataset array as 'int8'
            <dt>H5T_NATIVE_UINT8
                <dd> Native unsigned 8-bit type, declare dataset array as 'uint8'
            <dt>H5T_NATIVE_INT16
                <dd> Native signed 16-bit type, declare dataset array as 'int16'
            <dt>H5T_NATIVE_UINT16
                <dd> Native unsigned 16-bit type, declare dataset array as 'uint16'
            <dt>H5T_NATIVE_INT32
                <dd> Native signed 32-bit type, declare dataset array as 'int32'
            <dt>H5T_NATIVE_UINT32
                <dd> Native unsigned 32-bit type, declare dataset array as 'uint32'
            <dt>H5T_NATIVE_INT64
                <dd> Native signed 64-bit type, declare dataset array as 'uint64'
            <dt>H5T_NATIVE_UINT64
                <dd> Native unsigned 64-bit type, declare dataset array as 'uint64'
            <dt>H5T_NATIVE_FLOAT
                <dd> Native single-precision float type, declare dataset array as 'float'
            <dt>H5T_NATIVE_DOUBLE
                <dd> Native double-precision float type, declare dataset array as 'double'
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to copy.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Datatype ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Equal">H5Tequal</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Tequal</code>(<em>hid_t </em><code>type_id1</code>,
        <em>hid_t</em><code>type_id2</code>
    )
<dt><strong>Description:</strong>
    <dd>This function determines if two datatype IDs refer to the same 
        datatype.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id1</code>
            <dd>ID of datatype to compare.
        <dt><em>hid_t</em> <code>type_id2</code>
            <dd>ID of datatype to compare.
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE/FALSE/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Lock">H5Tlock</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tlock</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function locks a type, making it read-only and non-destrucible.
        This is normally done by the library for predefined data types so the
        application doesn't inadvertently change or delete a predefined type.
        Once a data type is locked it can never be unlocked.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to lock.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetClass">H5Tget_class</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_class_t </em><code>H5Tget_class</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the base class of a datatype.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative type class on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetSize">H5Tget_size</a>
<dt><strong>Signature:</strong>
    <dd><em>size_t </em><code>H5Tget_size</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the size of a datatype in bytes.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Positve size in bytes on success, 0 on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetSize">H5Tset_size</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_size</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t</em><code>size</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the total size in bytes for an atomic data type (this
         operation is not permitted on compound data types).  If the size is
         decreased so that the significant bits of the data type extend beyond
         the edge of the new size, then the `offset' property is decreased
         toward zero.  If the `offset' becomes zero and the significant
         bits of the data type still hang over the edge of the new size, then
         the number of significant bits is decreased.
         Adjusting the size of an H5T_STRING automatically sets the precision
         to 8*size.  All data types have a positive size.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to change size.
        <dt><em>size_t</em> <code>size</code>
            <dd>Size in bytes to modify datatype.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetOrder">H5Tget_order</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_order_t </em><code>H5Tget_order</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the byte order of an atomic datatype.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Byte order constant on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetOrder">H5Tset_order</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_order</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_order_t</em><code>order</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the byte ordering of an atomic datatype.
        Byte orderings currently supported are:
        <ul> <dl>
            <dt>H5T_ORDER_LE
                <dd> Little-endian byte ordering (default)
            <dt>H5T_ORDER_BE
                <dd> Big-endian byte ordering
            <dt>H5T_ORDER_Vax
                <dd> VAX-endianness byte ordering (not currently supported)
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>H5T_order_t</em> <code>order</code>
            <dd>Byte ordering constant.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetPrecision">H5Tget_precision</a>
<dt><strong>Signature:</strong>
    <dd><em>size_t </em><code>H5Tget_precision</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the precision of an atomic data type.  The
        precision is the number of significant bits which, unless padding is
        present, is 8 times larger than the value returned by H5Tget_size().
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of significant bits on success, 0 on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetPrecision">H5Tset_precision</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_precision</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t</em><code>precision</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the precision of an atomic data type.  The precision
        is the number of significant bits which, unless padding is present, is 8
        times larger than the value returned by H5Tget_size().
        <P>If the precision is increased then the offset is decreased and then
            the size is increased to insure that significant bits do not "hang
            over" the edge of the data type.
        <P>Changing the precision of an H5T_STRING automatically changes the
            size as well.  The precision must be a multiple of 8.
        <P>When decreasing the precision of a floating point type, set the
            locations and sizes of the sign, mantissa, and exponent fields
            first.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>size_t</em> <code>precision</code>
            <dd>Number of bits of precision for datatype.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetOffset">H5Tget_offset</a>
<dt><strong>Signature:</strong>
    <dd><em>size_t </em><code>H5Tget_offset</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the bit offset of the first significant bit.
        The signficant bits of an atomic datum can be offset from the beginning
        of the memory for that datum by an amount of padding. The `offset'
        property specifies the number of bits of padding that appear to the
        "right of" the value.  That is, if we have a 32-bit datum with 16-bits
        of precision having the value 0x1122 then it will be layed out in
        memory as (from small byte address toward larger byte addresses):
        <br>
        <br>

      <table border align=center cellpadding=4 width="80%">
        <tr align=center>
          <th width="20%">Byte Position</th>
          <th width="20%">Big-Endian Offset=0</th>
          <th width="20%">Big-Endian Offset=16</th>
          <th width="20%">Little-Endian Offset=0</th>
          <th width="20%">Little-Endian Offset=16</th>
        </tr>  
        <tr align=center>
          <td>0:</td>
          <td>[ pad]</td>
          <td>[0x11]</td>
          <td>[0x22]</td>
          <td>[ pad]</td>
        </tr>
        <tr align=center>
          <td>1:</td>
          <td>[ pad]</td>
          <td>[0x22]</td>
          <td>[0x11]</td>
          <td>[ pad]</td>
        </tr>
        <tr align=center>
          <td>2:</td>
          <td>[0x11]</td>
          <td>[ pad]</td>
          <td>[ pad]</td>
          <td>[0x22]</td>
        </tr>
        <tr align=center>
          <td>3:</td>
          <td>[0x22]</td>
          <td>[ pad]</td>
          <td>[ pad]</td>
          <td>[0x11]</td>
        </tr>
      </table>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Positive offset value on success, 0 on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetOffset">H5Tset_offset</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_offset</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t</em> <code>offset</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the bit offset of the first significant bit.  The
        signficant bits of an atomic datum can be offset from the beginning of
        the memory for that datum by an amount of padding. The `offset'
        property specifies the number of bits of padding that appear to the
        "right of" the value.  That is, if we have a 32-bit datum with 16-bits
        of precision having the value 0x1122 then it will be layed out in
        memory as (from small byte address toward larger byte addresses):
        <br>
        <br>

      <table border align=center cellpadding=4 width="80%">
        <tr align=center>
          <th width="20%">Byte Position</th>
          <th width="20%">Big-Endian Offset=0</th>
          <th width="20%">Big-Endian Offset=16</th>
          <th width="20%">Little-Endian Offset=0</th>
          <th width="20%">Little-Endian Offset=16</th>
        </tr>  
        <tr align=center>
          <td>0:</td>
          <td>[ pad]</td>
          <td>[0x11]</td>
          <td>[0x22]</td>
          <td>[ pad]</td>
        </tr>
        <tr align=center>
          <td>1:</td>
          <td>[ pad]</td>
          <td>[0x22]</td>
          <td>[0x11]</td>
          <td>[ pad]</td>
        </tr>
        <tr align=center>
          <td>2:</td>
          <td>[0x11]</td>
          <td>[ pad]</td>
          <td>[ pad]</td>
          <td>[0x22]</td>
        </tr>
        <tr align=center>
          <td>3:</td>
          <td>[0x22]</td>
          <td>[ pad]</td>
          <td>[ pad]</td>
          <td>[0x11]</td>
        </tr>
      </table>

<P>If the offset is incremented then the total size is
incremented also if necessary to prevent significant bits of
the value from hanging over the edge of the data type.

<P>The offset of an H5T_STRING cannot be set to anything but
zero.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>size_t</em> <code>offset</code>
            <dd>Offset of first significant bit.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetPad">H5Tget_pad</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tget_pad</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_pad_t *</em> <code>lsb</code>,
        <em>H5T_pad_t *</em> <code>msb</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the padding type of the least and most-significant
        bit padding.  Valid types are:
        <ul> <dl>
            <dt>H5T_PAD_ZERO
               <dd>Set background to zeros.
            <dt>H5T_PAD_ONE
               <dd>Set background to ones.
            <dt>H5T_PAD_BACKGROUND
               <dd>Leave background alone.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
        <dt><em>H5T_pad_t *</em> <code>lsb</code>
            <dd>Pointer to location to return least-significant bit padding type.
        <dt><em>H5T_pad_t *</em> <code>msb</code>
            <dd>Pointer to location to return most-significant bit padding type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetPad">H5Tset_pad</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_pad</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_pad_t</em> <code>lsb</code>,
        <em>H5T_pad_t</em> <code>msb</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the least and most-significant bits padding types.
        <ul> <dl>
            <dt>H5T_PAD_ZERO
               <dd>Set background to zeros.
            <dt>H5T_PAD_ONE
               <dd>Set background to ones.
            <dt>H5T_PAD_BACKGROUND
               <dd>Leave background alone.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>H5T_pad_t</em> <code>lsb</code>
            <dd>Padding type for least-significant bits.
        <dt><em>H5T_pad_t</em> <code>msb</code>
            <dd>Padding type for most-significant bits.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetSign">H5Tget_sign</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_sign_t </em><code>H5Tget_sign</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the sign type for an integer type.
        Valid types are:
        <ul> <dl>
            <dt>H5T_SGN_NONE
               <dd>Unsigned integer type.
            <dt>H5T_SGN_2
               <dd>Two's complement signed integer type.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative sign type on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetSign">H5Tset_sign</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_sign</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_sign_t</em> <code>sign</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the sign proprety for an integer type.
        <ul> <dl>
            <dt>H5T_SGN_NONE
               <dd>Unsigned integer type.
            <dt>H5T_SGN_2
               <dd>Two's complement signed integer type.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>H5T_sign_t</em> <code>sign</code>
            <dd>Sign type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetFields">H5Tget_fields</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tget_fields</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t *</em> <code>epos</code>,
        <em>size_t *</em> <code>esize</code>,
        <em>size_t *</em> <code>mpos</code>,
        <em>size_t *</em> <code>msize</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves information about the locations of the various
        bit fields of a floating point data type.  The field positions are bit
        positions in the significant region of the data type.  Bits are
        numbered with the least significant bit number zero.
        Any (or even all) of the arguments can be null pointers.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
        <dt><em>size_t *</em> <code>epos</code>
            <dd>Pointer to location to return exponent bit-position.
        <dt><em>size_t *</em> <code>esize</code>
            <dd>Pointer to location to return size of exponent in bits.
        <dt><em>size_t *</em> <code>mpos</code>
            <dd>Pointer to location to return mantissa bit-position.
        <dt><em>size_t *</em> <code>msize</code>
            <dd>Pointer to location to return size of mantissa in bits.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetFields">H5Tset_fields</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_fields</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t</em> <code>epos</code>,
        <em>size_t</em> <code>esize</code>,
        <em>size_t</em> <code>mpos</code>,
        <em>size_t</em> <code>msize</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the locations and sizes of the various floating
        point bit fields.  The field positions are bit positions in the
        significant region of the data type.  Bits are numbered with the least
        significant bit number zero.
    
        <P>Fields are not allowed to extend beyond the number of bits of
        precision, nor are they allowed to overlap with one another.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>size_t</em> <code>epos</code>
            <dd>Exponent bit position.
        <dt><em>size_t</em> <code>esize</code>
            <dd>Size of exponent in bits.
        <dt><em>size_t</em> <code>mpos</code>
            <dd>Mantissa bit position.
        <dt><em>size_t</em> <code>msize</code>
            <dd>Size of mantissa in bits.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetEbias">H5Tget_ebias</a>
<dt><strong>Signature:</strong>
    <dd><em>size_t </em><code>H5Tget_ebias</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the exponent bias of a floating-point type.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Positive value on success, 0 on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetEbias">H5Tset_ebias</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_ebias</code>(<em>hid_t </em><code>type_id</code>,
        <em>size_t</em> <code>ebias</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the exponent bias of a floating-point type.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>size_t</em> <code>ebias</code>
            <dd>Exponent bias value.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetNorm">H5Tget_norm</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_norm_t </em><code>H5Tget_norm</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the mantissa normalization of a floating-point
        datatype.  Valid normalization values are:
        <ul> <dl>
            <dt>H5T_NORM_IMPLIED
                <dd>MSB of mantissa isn't stored, always 1
            <dt>H5T_NORM_MSBSET
                <dd>MSB of mantissa is always 1
            <dt>H5T_NORM_NONE
                <dd>Mantissa is not normalized
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative normalization type on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetNorm">H5Tset_norm</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_norm</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_norm_t</em> <code>norm</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets the mantissa normalization of a floating-point
        datatype.  Valid normalization values are:
        <ul> <dl>
            <dt>H5T_NORM_IMPLIED
                <dd>MSB of mantissa isn't stored, always 1
            <dt>H5T_NORM_MSBSET
                <dd>MSB of mantissa is always 1
            <dt>H5T_NORM_NONE
                <dd>Mantissa is not normalized
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to set.
        <dt><em>H5T_norm_t</em> <code>norm</code>
            <dd>Mantissa normalization type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetInpad">H5Tget_inpad</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_pad_t </em><code>H5Tget_inpad</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the internal padding type for unused bits in
        floating-point datatypes.
        Valid padding values are:
        <ul> <dl>
            <dt>H5T_PAD_ZERO
               <dd>Set background to zeros.
            <dt>H5T_PAD_ONE
               <dd>Set background to ones.
            <dt>H5T_PAD_BACKGROUND
               <dd>Leave background alone.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative padding type on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetInpad">H5Tset_inpad</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_inpad</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_pad_t</em> <code>inpad</code>
    )
<dt><strong>Description:</strong>
    <dd>If any internal bits of a floating point type are unused
        (that is, those significant bits which are not part of the
        sign, exponent, or mantissa) then they will be filled
        according to the value of this property.
        Valid padding values are:
        <ul> <dl>
            <dt>H5T_PAD_ZERO
               <dd>Set background to zeros.
            <dt>H5T_PAD_ONE
               <dd>Set background to ones.
            <dt>H5T_PAD_BACKGROUND
               <dd>Leave background alone.
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to modify.
        <dt><em>H5T_pad_t</em> <code>pad</code>
            <dd>Padding type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetCset">H5Tget_cset</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_cset_t </em><code>H5Tget_cset</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the character set type of a string datatype.
        Valid character set values are:
        <ul> <dl>
            <dt>H5T_CSET_ASCII
               <dd>Character set is US ASCII
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative character set type on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetCset">H5Tset_cset</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_cset</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_cset_t</em> <code>cset</code>
    )
<dt><strong>Description:</strong>
    <dd>HDF5 is able to distinguish between character sets of different
        nationalities and to convert between them to the extent possible.
        Valid character set values are:
        <ul> <dl>
            <dt>H5T_CSET_ASCII
               <dd>Character set is US ASCII
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to modify.
        <dt><em>H5T_cset_t</em> <code>cset</code>
            <dd>Character set type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetStrpad">H5Tget_strpad</a>
<dt><strong>Signature:</strong>
    <dd><em>H5T_str_t </em><code>H5Tget_strpad</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the string padding method for a string datatype.
        Valid string padding values are:
        <ul> <dl>
            <dt>H5T_STR_NULL
               <dd>Pad with zeros (as C does)
            <dt>H5T_STR_SPACE
               <dd>Pad with spaces (as FORTRAN does)
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Non-negative string padding type on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetStrpad">H5Tset_strpad</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tset_strpad</code>(<em>hid_t </em><code>type_id</code>,
        <em>H5T_str_t</em> <code>strpad</code>
    )
<dt><strong>Description:</strong>
    <dd>The method used to store character strings differs with the programming
        language: C usually null terminates strings while Fortran
        left-justifies and space-pads strings.  This property defines the
        storage mechanism for the string.
        Valid string padding values are:
        <ul> <dl>
            <dt>H5T_STR_NULL
               <dd>Pad with zeros (as C does)
            <dt>H5T_STR_SPACE
               <dd>Pad with spaces (as FORTRAN does)
        </dl> </ul>
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to modify.
        <dt><em>H5T_str_t</em> <code>strpad</code>
            <dd>String padding type.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetNmembers">H5Tget_nmembers</a>
<dt><strong>Signature:</strong>
    <dd><em>intn </em><code>H5Tget_nmembers</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the number of fields a compound datatype has.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of members datatype has on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberName">H5Tget_member_name</a>
<dt><strong>Signature:</strong>
    <dd><em>char *</em> <code>H5Tget_member_name</code>(<em>hid_t </em><code>type_id</code>,
        <em>intn</em> <code>fieldno</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the name of a field of a compound data type.
        Fields are stored in no particular order with numbers 0 through N-1
        where N is the value returned by H5Tget_nmembers().  The name of the
        field is allocated with malloc() and the caller is responsible for
        freeing the memory used by the name.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
        <dt><em>intn</em> <code>fieldno</code>
            <dd>Field number (indexed from 0) of the field name to retrieve.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Valid pointer on success, NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberDims">H5Tget_member_dims</a>
<dt><strong>Signature:</strong>
    <dd><em>int</em> <code>H5Tget_member_dims</code>(<em>hid_t </em><code>type_id</code>,
        <em>intn</em> <code>fieldno</code>,
        <em>size_t *</em> <code>dims</code>,
        <em>int *</em> <code>perm</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the dimensionality of the field.  The dimensions
        and permuation vector are returned through arguments <code>dims</code>
        and <code>perm</code>, both arrays of at least four elements.  Either
        (or even both) may be null pointers.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
        <dt><em>intn</em> <code>fieldno</code>
            <dd>Field number (indexed from 0) of the field dims to retrieve.
        <dt><em>size_t *</em> <code>dims</code>
            <dd>Pointer to buffer to store the dimensions of the field.
        <dt><em>int *</em> <code>perm</code>
            <dd>Pointer to buffer to store the permutation vector of the field.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of dimensions on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberType">H5Tget_member_type</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t</em> <code>H5Tget_member_type</code>(<em>hid_t </em><code>type_id</code>,
        <em>intn</em> <code>fieldno</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the data type of the specified member.  The caller
        should invoke H5Tclose() to release resources associated with the type.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to query.
        <dt><em>intn</em> <code>fieldno</code>
            <dd>Field number (indexed from 0) of the field type to retrieve.
    </dl>
<dt><strong>Returns:</strong>
    <dd>The ID of a copy of the datatype of the field, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Insert">H5Tinsert</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Tinsert</code>(<em>hid_t </em><code>type_id</code>,
        <em>const char *</em> <code>name</code>,
        <em>off_t</em> <code>offset</code>,
        <em>hid_t</em> <code>field_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function adds another member to the compound data type
        <code>type_id</code>.  The new member has a <code>name</code> which
        must be unique within the compound data type. The <code>offset</code>
        argument defines the start of the member in an instance of the compound
        data type, and <code>field_id</code> is the type of the new member.
    
        <P>Note:    All members of a compound data type must be atomic; a
           compound data type cannot have a member which is a compound data
           type.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of compound datatype to modify.
        <dt><em>const char *</em> <code>name</code>
            <dd>Name of the field to insert.
        <dt><em>off_t</em> <code>offset</code>
            <dd>Offset in memory structure of the field to insert.
        <dt><em>hid_t</em> <code>field_id</code>
            <dd>Datatype ID of the field to insert.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Pack">H5Tpack</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Tpack</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function recursively removes padding from within a compound
        datatype to make it more efficient (space-wise) to store that data.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to modify.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-RegisterHard">H5Tregister_hard</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Tregister_hard</code>(<em>const char
        *</em> <code>name</code>, <em>hid_t </em><code>src_id</code>,
        <em>hid_t</em> <code>dst_id</code>,
        <em>H5T_conv_t</em> <code>func</code>
    )
<dt><strong>Description:</strong>
    <dd>This function registers a hard conversion function for a data type
        conversion path.  The path is specified by the source and destination
        datatypes <code>src_id</code> and <code>dst_id</code>.  A conversion
        path can only have one hard function, so <code>func</code> replaces any
        previous hard function.
        <P>If <code>func</code> is the null pointer then any hard function
        registered for this path is removed from this path.  The soft functions
        are then used when determining which conversion function is appropriate
        for this path.  The <code>name</code> argument is used only
        for debugging and should be a short identifier for the function.
        <P>The type of the conversion function pointer is declared as:
            typedef herr_t (*H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata,
                          size_t nelmts, void *buf, void *bkg);
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em> <code>name</code>
            <dd>Name displayed in diagnostic output.
        <dt><em>hid_t</em> <code>src_id</code>
            <dd>ID of source datatype.
        <dt><em>hid_t</em> <code>dst_id</code>
            <dd>ID of destination datatype.
        <dt><em>H5T_conv_t</em> <code>func</code>
            <dd>Function to convert between source and destination datatypes.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-RegisterSoft">H5Tregister_soft</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Tregister_soft</code>(<em>const char
    *</em> <code>name</code>, <em>hid_t </em><code>src_id</code>,
        <em>hid_t</em> <code>dst_id</code>,
        <em>H5T_conv_t</em> <code>func</code>
    )
<dt><strong>Description:</strong>
    <dd>This function registers a soft conversion function by adding it to the
        end of the master soft list and replacing the soft function in all
        applicable existing conversion paths.  The <code>name</code>
        is used only for debugging and should be a short identifier
        for the function.
        <P>The type of the conversion function pointer is declared as:
            typedef herr_t (*H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata,
                          size_t nelmts, void *buf, void *bkg);
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>const char *</em> <code>name</code>
            <dd>Name displayed in diagnostic output.
        <dt><em>hid_t</em> <code>src_id</code>
            <dd>ID of source datatype.
        <dt><em>hid_t</em> <code>dst_id</code>
            <dd>ID of destination datatype.
        <dt><em>H5T_conv_t</em> <code>func</code>
            <dd>Function to convert between source and destination datatypes.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Unregister">H5Tunregister</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Tunregister</code>(<em>H5T_conv_t</em> <code>func</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes a conversion function from all conversion paths.
        <P>The type of the conversion function pointer is declared as:
            typedef herr_t (*H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata,
                          size_t nelmts, void *buf, void *bkg);
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>H5T_conv_t</em> <code>func</code>
            <dd>Function to remove from conversion paths.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Close">H5Tclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Tclose</code>(<em>hid_t </em><code>type_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function releases a datatype.  Further access through the datatype
        ID is illegal.  Failure to release a datatype with this call will
        result in resource leaks.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>type_id</code>
            <dd>ID of datatype to release.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>


<hr>
<h2><a name="Dataspace">Dataspace Object API Functions</a></h2>
<P>These functions create and manipulate the dataspace in which to store the
elements of a dataset.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-CreateSimple">H5Screate_simple</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t</em> <code>H5Screate_simple</code>(<em>int</em> <code>rank</code>,
        <em>const hsize_t *</em> <code>dims</code>,
        <em>const hsize_t *</em> <code>maxdims</code>
    )
<dt><strong>Description:</strong>
    <dd>This function creates a new simple data space object and opens it for
        access. The <code>rank</code> is the number of dimensions used in the
        dataspace.  The <code>dims</code> argument is the size of the simple
        dataset and the <code>maxdims</code> argument is the upper limit on the
        size of the dataset.  <code>maxdims</code> may be the null pointer in
        which case the upper limit is the same as <code>dims</code>.  If an
        element of <code>maxdims</code> is zero then the corresponding dimension
        is unlimited, otherwise no element of <code>maxdims</code> should be
        smaller than the corresponding element of <code>dims</code>.  The
        dataspace ID returned from this function should be released with
        H5Sclose or resource leaks will occur.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>int</em> <code>rank</code>
            <dd>Number of dimensions of dataspace.
        <dt><em>const hsize_t *</em> <code>dims</code>
            <dd>An array of the size of each dimension.
        <dt><em>const hsize_t *</em> <code>maxdims</code>
            <dd>An array of the maximum size of each dimension.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A dataspace ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-Copy">H5Scopy</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Scopy</code>(<em>hid_t </em><code>space_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function copies a dataspace.  The dataspace ID returned from this
        function should be released with H5Sclose or resource leaks will occur.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of dataspace to copy.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A dataspace ID on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-GetNpoints">H5Sget_npoints</a>
<dt><strong>Signature:</strong>
    <dd><em>hsize_t</em> <code>H5Sget_npoints</code>(<em>hid_t </em><code>space_id</code>)
<dt><strong>Description:</strong>
    <dd>This function determines the number of elements in a dataspace.  For
        example, a simple 3-dimensional dataspace with dimensions 2, 3 and 4
        would have 24 elements.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to query
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of elements in the dataspace, 0 on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-GetNdims">H5Sget_ndims</a>
<dt><strong>Signature:</strong>
    <dd><em>int</em> <code>H5Sget_ndims</code>(<em>hid_t</em> <code>space_id</code>)
<dt><strong>Description:</strong>
    <dd>This function determines the dimensionality (or rank) of a dataspace.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to query
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of dimensions in the dataspace, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-GetDims">H5Sget_dims</a>
<dt><strong>Signature:</strong>
    <dd><em>int</em> <code>H5Sget_dims</code>(<em>hid_t</em> <code>space_id</code>,
        <em>hsize_t *</em><code>dims</code>,
        <em>hsize_t *</em><code>maxdims</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns the size of each dimension in a dataspace through
       the <code>dims</code> parameter.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to query
        <dt><em>hsize_t *</em><code>dims</code>
            <dd>Pointer to array to store the size of each dimension.
        <dt><em>hsize_t *</em><code>maxdims</code>
            <dd>Pointer to array to store the maximum size of each dimension.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of dimensions in the dataspace, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-IsSimple">H5Sis_simple</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Sis_simple</code>(<em>hid_t </em><code>space_id</code>)
<dt><strong>Description:</strong>
    <dd>This function determines whether a dataspace object is a simple
        dataspace or not.  [Currently, all dataspace objects are simple
        dataspaces, complex dataspace support will be added in the future]
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to query
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE or FALSE on success, negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-SetSpace">H5Sset_space</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Sset_space</code>(<em>hid_t </em><code>space_id</code>,
        <em>uint32 </em><code>rank</code>,
        <em>uint32 *</em><code>dims</code>
    )
<dt><strong>Description:</strong>
    <dd>This function determines the number of dimensions and the size of each
        dimension for the space that a dataset is stored within.  This function
        only creates simple dataspace objects.  Setting the rank to a
        value of zero allows scalar objects to be created.  Dimensions are
        specified from slowest to fastest changing in the <code>dims</code>
        array (i.e. 'C' order).  Setting the size of a dimension to zero
        indicates that the dimension is of unlimited size and should be allowed
        to expand.  Currently, only the first dimension in the array (the
        slowest) may be unlimited in size.
        [Currently, all dataspace objects are simple
        dataspaces, complex dataspace support will be added in the future]
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object.
        <dt><em>uint32</em> <code>rank</code>
            <dd>The number of dimensions the object is composed of.
        <dt><em>uint32 *</em> <code>dims</code>
            <dd>An array of the size of each dimension. (NULL for scalar objects)
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-SetHyperslab">H5Sset_hyperslab</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t</em> <code>H5Sset_hyperslab</code>(<em>hid_t</em> <code>space_id</code>,
        <em>const hssize_t *</em><code>start</code>,
        <em>const hsize_t *</em><code>count</code>,
        <em>const hsize_t *</em><code>stride</code>
    )
<dt><strong>Description:</strong>
    <dd>This function selects a hyperslab from a simple dataspace.  The stride
        array may be used to sub-sample the hyperslab chosen, a value of 1 in each
        position of the stride array selects contiguous elements in the array,
        a value of 2 selects every other element, etc.  If the stride parameter is
        set to NULL, a contiguous hyperslab is chosen.  The values in the start and
        count arrays may be negative, to allow for selecting hyperslabs in chunked
        datasets which extend in arbitrary directions.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to set hyperslab in.
        <dt><em>const hssize_t *</em><code>start</code>
            <dd>Pointer to array of starting location for hyperslab.
        <dt><em>const hsize_t *</em><code>count</code>
            <dd>Pointer to array of magnitude of hyperslab.
        <dt><em>const hsize_t *</em><code>stride</code>
            <dd>Pointer to array of stride of hyperslab.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-GetHyperslab">H5Sget_hyperslab</a>
<dt><strong>Signature:</strong>
    <dd><em>int</em> <code>H5Sget_hyperslab</code>(<em>hid_t</em> <code>space_id</code>,
        <em>hssize_t *</em><code>start</code>,
        <em>hsize_t *</em><code>count</code>,
        <em>hsize_t *</em><code>stride</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves information about the hyperslab from a simple
        dataspace.  If no hyperslab has been defined then the hyperslab is the
        same as the entire array.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of the dataspace object to set hyperslab in.
        <dt><em>hssize_t *</em><code>start</code>
            <dd>Pointer to array to store starting location of hyperslab.
        <dt><em>hsize_t *</em><code>count</code>
            <dd>Pointer to array to store magnitude of hyperslab.
        <dt><em>hsize_t *</em><code>stride</code>
            <dd>Pointer to array to store stride of hyperslab.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Hyperslab dimensionality on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Dataspace-Close">H5Sclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Sclose</code>(<em>hid_t </em><code>space_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function releases a dataspace.  Further access through the dataspace
        ID is illegal.  Failure to release a dataspace with this call will
        result in resource leaks.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>space_id</code>
            <dd>ID of dataspace to release.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="Group">Group Object API Functions</a></h2>

<p>A group associates names with objects and provides a mechanism
which can map a name to an object. Since all objects
appear in at least one group (with the possible exception of the root
object) and since objects can have names in more than one group, the
set of all objects in an HDF5 file is a directed graph.  The internal
nodes (nodes with out-degree greater than zero) must be groups while
the leaf nodes (nodes with out-degree zero) are either empty groups or
objects of some other type.  Exactly one object in every non-empty
file is the root object.  The root object always has a positive
in-degree because it is pointed to by the file boot block.

<p>Every file handle returned by <code>H5Fcreate</code> or
<code>H5Fopen</code> maintains an independent current working group
stack, the top item of which is the current working group (the root
object is the current working group if the stack is empty).  The stack
can be manipulated with <code>H5Gset</code>, <code>H5Gpush</code>, and
<code>H5Gpop</code>.

<p>An object name consists of one or more components separated from
one another by slashes. If the name begins with a slash then the
object is located by looking for the first component in the root
object, then looking for the second component in that object, etc.,
until the entire name is traversed.  If the name doesn't begin with a
slash then the traversal begins with the current working group.

<p>The library does not maintain the full absolute name of its current
working group because (1) cycles in the graph can make the name length
unbounded and (2) a group doesn't necessarily have a unique name.  A
more Unix-like hierarchical naming scheme can be implemented on top of
the directed graph scheme by creating a ".." entry in each group that
points to its single predecessor and then a <code>getcwd</code>
function would be trivial.

<br>
<br>

<hr>
    <dl>
      <dt><strong>Name:</strong> <a name="Group-Create">H5Gcreate</a>
      <dt><strong>Signature:</strong>
      <dd><em>herr_t </em><code>H5Gset</code> (<em>hid_t</em>
	<code>file</code>, <em>const char *</em><code>name</code>,
	<em>size_t</em> <code>size_hint</code>)
      <dt><strong>Description:</strong>
      <dd>This function creates a new empty group and gives it a name.
      <dt><strong>Parameters:</strong>
      <dd>
	<dl>
	  <dt><em>hid_t</em> <code>file</code>
	  <dd>The file handle returned by <code>H5Fcreate</code> or
	    <code>H5Fopen</code>.
	  <dt><em>const char *</em><code>name</code>
	  <dd>The absolute or relative name of the new group.
	  <dt><em>size_t</em> <code>size_hint</code>
	  <dd>The size hint is an optional parameter that indicates
	    the number of bytes to reserve for the names that will
	    appear in the group. A conservative estimate could result
	    in multiple system-level I/O requests to read the group
	    name heap while a liberal estimate could result in a
	    single large I/O request even when the group has just a
	    few names.  HDF5 stores each name with a null terminator.
	</dl>
      <dt><strong>Returns:</strong>
      <dd>Returns a negative value on failure, non-negative otherwise.
    </dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-Open">H5Sopen</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Gopen</code>(<em>hid_t</em> <code>file_id</code>,
        <em>const char *</em><code>name</code>
    )
<dt><strong>Description:</strong>
    <dd>This function opens an existing group for modification.  When finished,
     call H5Gclose() to close it and release resources.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>file_id</code>
            <dd>ID of file to open group within.
        <dt><em>const char *</em> <code>name</code>
            <dd>Name of group to open.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Valid group ID on success, negative on failure.
</dl>

<hr>
    <dl>
      <dt><strong>Name:</strong> <a name="Group-Set">H5Gset</a>
      <dt><strong>Signature:</strong>
      <dd><em>herr_t </em><code>H5Gset</code> (<em>hid_t</em>
	<code>file</code>, <em>const char *</em><code>name</code>)
      <dt><strong>Description:</strong>
      <dd>This function sets the current working group by modifying the
	top element of the current working group stack or, if the
	stack is empty, by pushing a new element onto the stack.
      <dt><strong>Parameters:</strong>
      <dd>
	<dl>
	  <dt><em>hid_t</em> <code>file</code>
	  <dd>The file handle returned by <code>H5Fcreate</code> or
	    <code>H5Fopen</code>.
	  <dt><em>const char *</em><code>name</code>
	  <dd>The name of the new current working group.  If the name
	    doesn't begin with a slash then it is looked up relative the
	    the previous current working group.
	</dl>
      <dt><strong>Returns:</strong>
      <dd>Returns a negative value on failure, non-negative otherwise.
    </dl>

<hr>
    <dl>
      <dt><strong>Name:</strong> <a name="Group-Push">H5Gpush</a>
      <dt><strong>Signature:</strong>
      <dd><em>herr_t </em><code>H5Gpush</code> (<em>hid_t</em>
	<code>file</code>, <em>const char *</em><code>name</code>)
      <dt><strong>Description:</strong>
      <dd>This function sets the current working group by pushing a
	new element onto the current working group stack.
      <dt><strong>Parameters:</strong>
      <dd>
	<dl>
	  <dt><em>hid_t</em> <code>file</code>
	  <dd>The file handle returned by <code>H5Fcreate</code> or
	    <code>H5Fopen</code>.
	  <dt><em>const char *</em><code>name</code>
	  <dd>The name of the new current working group.  If the name
	    doesn't begin with a slash then it is looked up relative the
	    the previous current working group.
	</dl>
      <dt><strong>Returns:</strong>
      <dd>Returns a negative value on failure, non-negative otherwise.
    </dl>

<hr>
    <dl>
      <dt><strong>Name:</strong> <a name="Group-Pop">H5Gpop</a>
      <dt><strong>Signature:</strong>
      <dd><em>herr_t </em><code>H5Gpop</code> (<em>hid_t</em> 
	<code>file</code>)
      <dt><strong>Description:</strong>
      <dd>This function restores the previous current working group by
	popping an element from the current working group stack.  An
	empty stack implies that the current working group is the root
	object. Attempting to pop an empty stack results in failure.
      <dt><strong>Parameters:</strong>
      <dd>
	<dl>
	  <dt><em>hid_t</em> <code>file</code>
	  <dd>The file handle returned by <code>H5Fcreate</code> or
	    <code>H5Fopen</code>.
	</dl>
      <dt><strong>Returns:</strong>
      <dd>Returns a negative value on failure, non-negative otherwise.
    </dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-Close">H5Gclose</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Gclose</code>(<em>hid_t </em><code>group_id</code>
    )
<dt><strong>Description:</strong>
    <dd>This function releases a group.  Further access through the group
        ID is illegal.  Failure to release a group with this call will
        result in resource leaks.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>group_id</code>
            <dd>ID of group to release.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<!--
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetNumContents">H5Gget_num_contents</a>
<dt><strong>Signature:</strong>
    <dd><em>uint32 </em><code>H5Gget_num_contents</code>(<em>hid_t </em><code>grp_id</code>)
<dt><strong>Description:</strong>
    <dd>This function retrieves the number of objects in the contents of the
        group.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
    </dl>
<dt><strong>Returns:</strong>
    <dd>Number of objects in group's contents on success, Unegative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetContentInfo">H5Gget_content_info</a>
<dt><strong>Signature:</strong>
    <dd><em>uint32 </em><code>H5Gget_content_info</code>(<em>hid_t </em><code>grp_id</code>,
            <em>int32 </em><code>index</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the type (dataset, dimension, datatype or
        group) of an item in a group.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>uint32</em> <code>index</code>
            <dd>Item index in the group to query the type of
    </dl>
<dt><strong>Returns:</strong>
    <dd>The type of the object for an item on success, or Unegative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetContentInfoMult">H5Gget_content_info_mult</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Gget_content_info</code>(<em>hid_t </em><code>grp_id</code>,
            <em>int32 </em><code>start_index</code>,
            <em>int32 </em><code>num_items</code>,
            <em>int32 </em><code>itemtype_list[]</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the type (dataset, dimension, datatype or
        group) of a list of items in a group.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>uint32</em> <code>start_index</code>
            <dd>The starting index to query the types of items
        <dt><em>uint32</em> <code>num_items</code>
            <dd>The number of items to query the types of
        <dt><em>uint32</em> <code>itemtype_list[]</code>
            <dd>A list to store the types of the items in
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetOIDByName">H5Gget_oid_by_name</a>
<dt><strong>Signature:</strong>
    <dd><em>hoid_t </em><code>H5Gget_oid_by_name</code>(<em>hid_t </em><code>grp_id</code>,
            <em>char *</em><code>name</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the OID of an item in the group which matches
        the name supplied.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>char *</em> <code>name</code>
            <dd>The name of the item to find
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid OID on success, or negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetOIDByIndex">H5Gget_oid_by_index</a>
<dt><strong>Signature:</strong>
    <dd><em>hoid_t </em><code>H5Gget_oid_by_index</code>(<em>hid_t </em><code>grp_id</code>,
            <em>uint32</em><code>index</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the OID of the n'th item in a group.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>uint32</em> <code>index</code>
            <dd>The index of the item in the group
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid OID on success, or negative on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetNameByOID">H5Gget_name_by_oid</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Gget_name_by_oid</code>(<em>hid_t </em><code>grp_id</code>,
            <em>hoid_t</em><code>oid</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the name of the item in a group whose OID
        matches the one supplied.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>hoid_t</em> <code>oid</code>
            <dd>The OID of the item in the group
    </dl>
<dt><strong>Returns:</strong>
    <dd>An atom for the string on success, NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-GetNameByIndex">H5Gget_name_by_index</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Gget_name_by_index</code>(<em>hid_t </em><code>grp_id</code>,
            <em>uint32</em><code>index</code>
    )
<dt><strong>Description:</strong>
    <dd>This function retrieves the name of the n'th item in a group
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to query
        <dt><em>uint32</em> <code>index</code>
            <dd>The index of the item in the group
    </dl>
<dt><strong>Returns:</strong>
    <dd>An atom for the string on success, NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-InsertItem">H5Ginsert_item</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Ginsert_item</code>(<em>hid_t </em><code>grp_id</code>,
            <em>hoid_t</em><code>item</code>
    )
<dt><strong>Description:</strong>
    <dd>This function inserts the item into a group
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to change
        <dt><em>hoid_t</em> <code>item</code>
            <dd>The OID of the item to insert into the group
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-InsertItemMult">H5Ginsert_item_mult</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Ginsert_item_mult</code>(<em>hid_t </em><code>grp_id</code>,
            <em>uint32</em><code>num_items</code>
            <em>hoid_t</em><code>item_list[]</code>
    )
<dt><strong>Description:</strong>
    <dd>This function inserts multiple items into a group
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to change
        <dt><em>hoid_t</em> <code>num_items</code>
            <dd>The number of items to insert into the group
        <dt><em>hoid_t</em> <code>item_list[]</code>
            <dd>The OIDs of the items to insert
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-RemoveItem">H5Gremove_item</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Gremove_item</code>(<em>hid_t </em><code>grp_id</code>,
            <em>hoid_t</em><code>item</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes an item from a group
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to change
        <dt><em>hoid_t</em> <code>item_list[]</code>
            <dd>The OID of the items to remove
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Group-RemoveItemMult">H5Gremove_item_mult</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Gremove_item_mult</code>(<em>hid_t </em><code>grp_id</code>,
            <em>uint32</em><code>num_items</code>
            <em>hoid_t</em><code>item_list[]</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes multiple items from a group
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>grp_id</code>
            <dd>ID of the group object to change
        <dt><em>hoid_t</em> <code>num_items</code>
            <dd>The number of items to remove from the group
        <dt><em>hoid_t</em> <code>item_list[]</code>
            <dd>The OIDs of the items to remove
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>
-->

<!--
<hr>
<h2><a name="LinkList">Linked-List Object API Functions</a></h2>
<P>These functions manage in-memory linked lists in various useful ways.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-AddToBeginning">H5Ladd_to_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Ladd_to_beginning</code>(<em>hid_t </em><code>lst_id</code>,
            <em>VOIDP</em><code>item</code>
    )
<dt><strong>Description:</strong>
    <dd>This function adds an object to the beginning of a linked list
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>VOIDP</em> <code>item</code>
            <dd>A pointer to the object to add to the list.  This must not
                be NULL.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-AddToEnd">H5Ladd_to_end</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Ladd_to_end</code>(<em>hid_t </em><code>lst_id</code>,
            <em>VOIDP</em><code>item</code>
    )
<dt><strong>Description:</strong>
    <dd>This function adds an object to the end of a linked list
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>VOIDP</em> <code>item</code>
            <dd>A pointer to the object to add to the list.  This must not
                be NULL.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-RemoveFromBeginning">H5Lremove_from_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lremove_from_beginning</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function removes an object from the front of a linked list and
        returns it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-RemoveFromEnd">H5Lremove_from_end</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lremove_from_end</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function removes an object from the back of a linked list and
        returns it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-RemoveCurrent">H5Lremove_current</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lremove_current</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function removes the current object from the list and returns
        a pointer to it.  The list's current object is moved back to the
        previous item in the list, or set to NULL if the object removed is at
        the beginning of the list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-DeleteAll">H5Ldelete_all</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Ldelete_all</code>(<em>hid_t </em><code>lst_id</code>,
            <em>void</em><code>(*free_func)(VOIDP)</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes all the objects from a list.  If 
        <code>free_func</code> is not NULL, each object removed from the list
        is passed to <code>free_func</code> before being removed from the list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>void</em> <code>(*free_func)(VOIDP)</code>
            <dd>Pointer to the function to call for each item removed from
                the list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-Index">H5Lindex</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lindex</code>(<em>hid_t </em><code>lst_id</code>,
            <em>uintn</em><code>indx</code>
    )
<dt><strong>Description:</strong>
    <dd>This function finds the n'th object in a list and returns it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>uintn</em> <code>indx</code>
            <dd>Index of the object to return.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-PeekAtBeginning">H5Lpeek_at_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lpeek_at_beginning</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the first object in the list.  If
        the list is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-PeekAtEnd">H5Lpeek_at_end</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lpeek_at_end</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the last object in the list.  If
        the list is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-FirstInList">H5Lfirst_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lfirst_in_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the first object in the list, and
        marks it as the current object.  If the list is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-LastInList">H5Llast_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Llast_in_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the last object in the list, and
        marks it as the current object.  If the list is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-CurrentInList">H5Lcurrent_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lcurrent_in_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the object that is considered the
        "current object" in the list.
        If the current object has been removed, or current points before or
        after the list or the list is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-NextInList">H5Lnext_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lnext_in_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the next object in the list and marks
        it as the current object.
        If the end of the list has been reached or the list is empty, NULL is
        returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-PreviousInList">H5Lprevious_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lprevious_in_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the previous object in the list and
        marks it as the current object.
        If the beginning of the list has been reached or the list is empty, NULL
        is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-ResetToBeginning">H5Lreset_to_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Lreset_to_beginning</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function resets the "current object" to the beginning of the list.
        Therefore the next object in the list is the first object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-ResetToEnd">H5Lreset_to_end</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Lreset_to_end</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function resets the "current object" to the end of the list.
        Therefore the previous object in the list is the last object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-NumOfObjects">H5Lnum_of_objects</a>
<dt><strong>Signature:</strong>
    <dd><em>uintn </em><code>H5Lnum_of_objects</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns the number of objects in the list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>The number of nodes in the list (possibly zero) on success or UFAIL on
        failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-IsEmpty">H5Lis_empty</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Lis_empty</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function determines if the list is empty.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE if the list is empty, FALSE if the list has objects, negative on
        failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-IsInList">H5Lis_in_list</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Lis_in_list</code>(<em>hid_t </em><code>lst_id</code>,
            <em>VOIDP</em><code>search_ptr</code>
    )
<dt><strong>Description:</strong>
    <dd>This function determines if an object is in the list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>VOIDP</em> <code>search_ptr</code>
            <dd>Pointer to look for in list
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE if the list contains the pointer, FALSE if the list has does not,
        negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-CopyList">H5Lcopy_list</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Lcopy_list</code>(<em>hid_t </em><code>lst_id</code>)
<dt><strong>Description:</strong>
    <dd>This function makes a copy of the list.  The objects themselves are not
        copied, only new references to them are made.  The new list has no
        current object set.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid list atom on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-PerformOnList">H5Lperform_on_list</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Lperform_on_list</code>(<em>hid_t </em><code>lst_id</code>,
            <em>void</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function performs the specified function on each object in the
        list.  Any options arguments required can be passed through the "args"
        pointer.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>void</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-FirstThat">H5Lfirst_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lfirst_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the first object in the list which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the list meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-NextThat">H5Lnext_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lnext_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the next object in the list which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the list meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-PreviousThat">H5Lprevious_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Lprevious_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the previous object in the list which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the list meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-LastThat">H5Llast_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Llast_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the last object in the list which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the list meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-AllSuchThat">H5Lall_such_that</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Lall_such_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will return a new list containing all of the objects in
        the list which cause the specified function to return a TRUE (non-zero)
        value.  Any optional arguments required can be passed through the "args"
        variable.  The objects themselves are not copied, onle new references
        to them are made.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid list atom on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="LinkList-RemoveAllSuchThat">H5Lremove_all_such_that</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Lremove_all_such_that</code>(<em>hid_t </em><code>lst_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will remove all of the objects in the list which cause
        the specified function to return a TRUE (non-zero) value.  Any optional
        arguments required can be passed through the "args" variable.  Note that
        the memory for the objects will not be reclaimed, so if the objects have
        no other references, it is best to avoid this function and remove the
        objects one by one, freeing them when necessary.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>lst_id</code>
            <dd>ID of the list object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="TBBT">Threaded, Balanced, Binary-Tree Object API Functions</a></h2>
<P>These functions manage in-memory TBBTs in various useful ways.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-Add">H5Badd</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Badd</code>(<em>hid_t </em><code>tree_id</code>,
            <em>VOIDP</em><code>item</code>,
            <em>VOIDP</em><code>key</code>
    )
<dt><strong>Description:</strong>
    <dd>This function inserts a new node having a key value of <code>key</code>
        and a data pointer of <code>item</code> into the tree.  If a node
        already exists in the tree with the same key value or an error occurs,
        negative is returned, otherwise, zero is returned.  The comparison
        function which the tree was created with is used to determine the
        location of the new node in the tree.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>VOIDP</em> <code>item</code>
            <dd>Pointer to the data of the object to insert into the tree.
        <dt><em>VOIDP</em> <code>key</code>
            <dd>Pointer to the key of the object to insert into the tree.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-Remove">H5Bremove</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bremove</code>(<em>hid_t </em><code>tree_id</code>,
            <em>VOIDP</em><code>key</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes a node with a key value of <code>key</code>.
        The data pointer corresponding to the key is returned on success, or
        a NULL value is returned on failure.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>VOIDP</em> <code>key</code>
            <dd>Pointer to the key of the object to remove from the tree.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-RemoveAll">H5Bremove_all</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Bremove_all</code>(<em>hid_t </em><code>tree_id</code>,
            <em>void</em><code>(*free_func)(VOIDP)</code>
    )
<dt><strong>Description:</strong>
    <dd>This function removes all nodes from the tree.  If 
        <code>free_func</code> is not NULL, each object removed from the list
        is passed to <code>free_func</code> before being removed from the list.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>void</em> <code>(*free_func)(VOIDP)</code>
            <dd>Pointer to the function to call for each item removed from
                the list.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-RemoveCurrent">H5Bremove_current</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bremove_all</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function removes the "current object" from the tree and returns
        a pointer to it.  The tree's current object is moved back to the
        previous node in the tree, or set to NULL if the object removed is at
        the beginning of the tree.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item removed on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-PeekAtBeginning">H5Bpeek_at_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bpeek_at_beginning</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the first object in the tree.  If
        the tree is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the first data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-PeekAtEnd">H5Bpeek_at_end</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bpeek_at_end</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the last object in the tree.  If
        the tree is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the last data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-Find">H5Bfind</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bfind</code>(<em>hid_t </em><code>tree_id</code>,
            <em>VOIDP</em><code>key</code>
    )
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the object in the tree who's key
        matches the argument passed in.  If the no match is found, NULL is
        returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>VOIDP</em> <code>key</code>
            <dd>Pointer to the key of the object to search for the tree.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-Index">H5Bindex</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bindex</code>(<em>hid_t </em><code>tree_id</code>,
            <em>uintn</em><code>indx</code>
    )
<dt><strong>Description:</strong>
    <dd>This function finds the n'th object in a tree and returns it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>uintn</em> <code>indx</code>
            <dd>Index of the object to return.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-FirstInTree">H5Bfirst_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bfirst_in_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the first object in the tree, and
        marks it as the current object.  If the tree is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-LastInTree">H5Blast_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Blast_in_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the last object in the tree, and
        marks it as the current object.  If the tree is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-CurrentInTree">H5Bcurrent_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bcurrent_in_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the object that is considered the
        "current object" in the tree.
        If the current object has been removed, or current points before or
        after the tree or the tree is empty, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-NextInTree">H5Bnext_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bnext_in_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the next object in the tree and marks
        it as the current object.
        If the end of the tree has been reached or the tree is empty, NULL is
        returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-PreviousInTree">H5Bprevious_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bprevious_in_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns a pointer to the previous object in the tree and
        marks it as the current object.
        If the beginning of the tree has been reached or the tree is empty, NULL
        is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-ResetToBeginning">H5Breset_to_beginning</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Breset_to_beginning</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function resets the "current object" to the beginning of the tree.
        Therefore the next object in the tree is the first object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-ResetToEnd">H5Breset_to_end</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Breset_to_end</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function resets the "current object" to the end of the tree.
        Therefore the previous object in the tree is the last object.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to the data item on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-NumOfObjects">H5Bnum_of_objects</a>
<dt><strong>Signature:</strong>
    <dd><em>uintn </em><code>H5Bnum_of_objects</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function returns the number of objects in the tree.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>The number of nodes in the tree (possibly zero) on success or UFAIL on
        failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-IsEmpty">H5Bis_empty</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Bis_empty</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function determines if the tree is empty.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE if the tree is empty, FALSE if the tree has objects, negative on
        failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-IsInTree">H5Bis_in_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Bis_in_tree</code>(<em>hid_t </em><code>tree_id</code>,
            <em>VOIDP</em><code>item</code>,
            <em>VOIDP</em><code>key</code>
    )
<dt><strong>Description:</strong>
    <dd>This function determines if an object is in the tree.  If 
    <code>item</code> is NULL, only the key pointer will be used to search
    for nodes in the tree.  If <code>key</code> is NULL, only the item pointer
    will be used to search for nodes in the tree.  If both <code>item</code>
    and <code>key</code> are not NULL, only a node which matches both pointers
    will be considered a match for the search.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>VOIDP</em> <code>item</code>
            <dd>Pointer to the data of the object to search for in the tree.
        <dt><em>VOIDP</em> <code>key</code>
            <dd>Pointer to the key of the object to search for in the tree.
    </dl>
<dt><strong>Returns:</strong>
    <dd>TRUE if a search node is found, FALSE if no nodes match, negative on
        failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-CopyTree">H5Bcopy_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Bcopy_tree</code>(<em>hid_t </em><code>tree_id</code>)
<dt><strong>Description:</strong>
    <dd>This function makes a copy of the tree.  The objects themselves are not
        copied, only new references to them are made.  The new tree has no
        current object set.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid tree atom on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-PerformOnTree">H5Bperform_on_tree</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Bperform_on_tree</code>(<em>hid_t </em><code>tree_id</code>,
            <em>void</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function performs the specified function on each object in the
        tree.  Any options arguments required can be passed through the "args"
        pointer.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>void</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-FirstThat">H5Bfirst_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bfirst_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the first object in the tree which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the tree meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-NextThat">H5Bnext_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bnext_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the next object in the tree which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the tree meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-PreviousThat">H5Bprevious_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Bprevious_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the previous object in the tree which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the tree meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-LastThat">H5Blast_that</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Blast_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the last object in the tree which
        causes the specified function to return a TRUE (non-zero) value.  Any
        optional arguments required can be passed through the "args" variable.
        The found object is then marked as the current object.  If no objects
        in the tree meet the criteria of the specified function or an error
        occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-AllSuchThat">H5Ball_such_that</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Ball_such_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will return a new tree containing all of the objects in
        the tree which cause the specified function to return a TRUE (non-zero)
        value.  Any optional arguments required can be passed through the "args"
        variable.  The objects themselves are not copied, onle new references
        to them are made.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid tree atom on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="TBBT-RemoveAllSuchThat">H5Bremove_all_such_that</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Bremove_all_such_that</code>(<em>hid_t </em><code>tree_id</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will remove all of the objects in the tree which cause
        the specified function to return a TRUE (non-zero) value.  Any optional
        arguments required can be passed through the "args" variable.  Note that
        the memory for the objects will not be reclaimed, so if the objects have
        no other references, it is best to avoid this function and remove the
        objects one by one, freeing them when necessary.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>tree_id</code>
            <dd>ID of the TBBT object
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<h2><a name="BitVector">Bit-Vector Object API Functions</a></h2>
<P>These functions manage in-memory bit-vectors used to provide "set"
operations and maintain groups of flags about file information.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="BitVector-Set">H5Vset</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Vset</code>(<em>hid_t </em><code>bv_id</code>,
            <em>uint32</em><code>bit_num</code>,
            <em>hbool_t</em><code>value</code>
    )
<dt><strong>Description:</strong>
    <dd>This function sets a bit in a bit-vector to a given boolean value.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>bv_id</code>
            <dd>ID of the bit-vector object.
        <dt><em>uint32</em> <code>bit_num</code>
            <dd>Which bit in the vector to set.
        <dt><em>hbool_t</em> <code>value</code>
            <dd>Value to set the bit to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="BitVector-Get">H5Vget</a>
<dt><strong>Signature:</strong>
    <dd><em>hbool_t </em><code>H5Vget</code>(<em>hid_t </em><code>bv_id</code>,
            <em>uint32</em><code>bit_num</code>
    )
<dt><strong>Description:</strong>
    <dd>This function gets the value of a bit in a bit-vector.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>bv_id</code>
            <dd>ID of the bit-vector object.
        <dt><em>uint32</em> <code>bit_num</code>
            <dd>Which bit in the vector to get.
    </dl>
<dt><strong>Returns:</strong>
    <dd>Value of the bit or negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="BitVector-Clear">H5Vclear</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Vclear</code>(<em>hid_t </em><code>bv_id</code>,
            <em>hbool_t</em><code>value</code>
    )
<dt><strong>Description:</strong>
    <dd>This function clears an entire bit-vector to a given boolean value.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>bv_id</code>
            <dd>ID of the bit-vector object.
        <dt><em>hbool_t</em> <code>value</code>
            <dd>The value to clear the bit-vector to.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="BitVector-Size">H5Vsize</a>
<dt><strong>Signature:</strong>
    <dd><em>uint32 </em><code>H5Vclear</code>(<em>hid_t </em><code>bv_id</code>)
<dt><strong>Description:</strong>
    <dd>This function reports the number of bits used in a bit-vector.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>bv_id</code>
            <dd>ID of the bit-vector object.
    </dl>
<dt><strong>Returns:</strong>
    <dd>The number of bits in the bit-vector (possibly zero) on success or
        UFAIL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="BitVector-Find">H5Vfind</a>
<dt><strong>Signature:</strong>
    <dd><em>uint32 </em><code>H5Vfind</code>(<em>hid_t </em><code>bv_id</code>,
            <em>hbool_t</em><code>value</code>
    )
<dt><strong>Description:</strong>
    <dd>This function finds the first bit in a bit-vector with a given value.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>bv_id</code>
            <dd>ID of the bit-vector object.
        <dt><em>hbool_t</em> <code>value</code>
            <dd>The value to search for.
    </dl>
<dt><strong>Returns:</strong>
    <dd>The position of the first bit with the given value on success or UFAIL
        on failure.
</dl>

<hr>
<h2><a name="Atom">Atom Object API Functions</a></h2>
<P>These functions manage in-memory atoms, which provide a portable and 
protected way of refering to memory structures.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Atom-Register">H5Aregister</a>
<dt><strong>Signature:</strong>
    <dd><em>hid_t </em><code>H5Aregister</code>(<em>hgroup_t </em><code>grp_id</code>,
            <em>VOIDP</em><code>ptr</code>
    )
<dt><strong>Description:</strong>
    <dd>This function registers a pointer (to a data-structure, usually) in a
        group and provides an atom for it.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hgroup_t</em> <code>grp_id</code>
            <dd>ID of the atom group.
        <dt><em>VOIDP</em> <code>ptr</code>
            <dd>The pointer (to a data-structure) to register in the group.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A value atom on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Atom-Unregister">H5Aunregister</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Aunregister</code>(<em>hid_t </em><code>atm</code>)
<dt><strong>Description:</strong>
    <dd>This function removes an atom from a group and returns a pointer to
        the structure which was registered.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>atm</code>
            <dd>Atom to remove.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid memory pointer on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Atom-LookupObject">H5Alookup_object</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Alookup_object</code>(<em>hid_t </em><code>atm</code>)
<dt><strong>Description:</strong>
    <dd>This function retrieves the memory pointer which is associated with
        the atom.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>atm</code>
            <dd>Atom to look up.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid memory pointer on success, NULL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Atom-LookupGroup">H5Alookup_group</a>
<dt><strong>Signature:</strong>
    <dd><em>hgroup_t </em><code>H5Alookup_group</code>(<em>hid_t </em><code>atm</code>)
<dt><strong>Description:</strong>
    <dd>This function retrieves the group that the atom is in.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>atm</code>
            <dd>Atom to look up.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A valid atom group on success, negative on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="Atom-Search">H5Asearch</a>
<dt><strong>Signature:</strong>
    <dd><em>VOIDP </em><code>H5Asearch</code>(<em>hgroup_t </em><code>grp</code>,
            <em>intn</em><code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>,
            <em>VOIDP</em><code>args</code>,
    )
<dt><strong>Description:</strong>
    <dd>This function will find and return the first object in the atomic
        group which causes the specified function to return a TRUE (non-zero)
        value.  Any optional arguments required can be passed through the
        "args" variable.  Currently, there is no way to resume a search.
        If no objects in the group meet the criteria of the specified function
        or an error occurs, NULL is returned.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hgroup_t</em> <code>grp</code>
            <dd>ID of the atom group to search.
        <dt><em>intn</em> <code>(*fcn)(VOIDP /* object */, VOIDP /* args */)</code>
            <dd>Pointer to the function to operate on the objects
        <dt><em>VOIDP</em> <code>args</code>
            <dd>Pointer any additional arguments needed by the function as
                it is operating on the objects.
    </dl>
<dt><strong>Returns:</strong>
    <dd>A pointer to an object on success/NULL on failure or no matching objects
</dl>

<hr>
<h2><a name="String">String Object API Functions</a></h2>
<P>These functions manage in-memory character strings in an object-oriented
way.
<br>
<br>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="String-Copy">H5Scopy</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Scopy</code>(<em>hid_t </em><code>strg_id1</code>,
            <em>hid_t</em><code>strg_id2</code>
    )
<dt><strong>Description:</strong>
    <dd>This function copies a string from one string object to another.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>strg_id1</code>
            <dd>ID of the destination string.
        <dt><em>hid_t</em> <code>strg_id2</code>
            <dd>ID of the source string.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="String-Convert">H5Sconvert</a>
<dt><strong>Signature:</strong>
    <dd><em>herr_t </em><code>H5Sconvert</code>(<em>hid_t </em><code>strg_id/code>,
            <em>char *</em><code>buf</code>
    )
<dt><strong>Description:</strong>
    <dd>This function copies a string object into a zero-terminated character
        buffer.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>strg_id</code>
            <dd>ID of the destination string.
        <dt><em>char *</em> <code>buf</code>
            <dd>Character buffer to store string in.
    </dl>
<dt><strong>Returns:</strong>
    <dd>zero/negative
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="String-Len">H5Slen</a>
<dt><strong>Signature:</strong>
    <dd><em>uintn </em><code>H5Slen</code>(<em>hid_t </em><code>strg_id</code>)
<dt><strong>Description:</strong>
    <dd>This function return the length of a string in characters.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>strg_id</code>
            <dd>ID of the string.
    </dl>
<dt><strong>Returns:</strong>
    <dd>The length of the string (possibly 0) on success, or UFAIL on failure.
</dl>

<hr>
<dl>
<dt><strong>Name:</strong> <a name="String-Compare">H5Scompare</a>
<dt><strong>Signature:</strong>
    <dd><em>intn </em><code>H5Scompare</code>(<em>hid_t </em><code>strg_id1</code>,
            <em>hid_t</em><code>strg_id2</code>
    )
<dt><strong>Description:</strong>
    <dd>This function compares the two strings, returning an integer less than,
        equal to, or greater than zero, indicating that the string referenced
        by <code>strg_id1</code> is less than, equal to, or greater than the
        string referenced by <code>strg_id2</code>.
<dt><strong>Parameters:</strong>
    <dl>
        <dt><em>hid_t</em> <code>strg_id1</code>
            <dd>ID of the first string.
        <dt><em>hid_t</em> <code>strg_id1</code>
            <dd>ID of the second string.
    </dl>
<dt><strong>Returns:</strong>
    <dd>An integer less than, equal to, or greater than zero based on the values
        of the strings.
</dl>
-->

<hr>
<h2><a name="Glossary">Glossary of data-types used</a></h2>
<P>Since many of the typedefs in the HDF5 API are not well-defined yet,
the types below may change radically en route to a final API...
<br>
<br>

<a name="Glossary-Basic">Basic Types:</a>
<ul>
    <li>char     - 8-bit character (only for ASCII information)
    <li>int8     - 8-bit signed integer
    <li>uint8    - 8-bit unsigned integer
    <li>int16    - 16-bit signed integer
    <li>uint16   - 16-bit unsigned integer
    <li>int32    - 32-bit signed integer
    <li>uint32   - 32-bit unsigned integer
    <li>intn     - "native" signed integer
    <li>uintn    - "native" unsigned integer
    <li>int64    - 64-bit signed integer (new)
    <li>uint64   - 64-bit unsigned integer (new)
    <li>float32  - 32-bit IEEE float
    <li>float64  - 64-bit IEEE float
</ul>

<a name="Glossary-Complex">Complex Types:</a>
<ul>
    <li>hid_t   - 32-bit unsigned integer used as ID for memory objects
    <li>hoid_t  - 32-bit unsigned integer (currently) used as ID for disk-based
                objects
    <li>hbool_t - boolean to indicate true/false/error codes from functions
    <li>herr_t  - 32-bit integer to indicate succeed/fail codes from functions
</ul>

<a name="Glossary-DiskIO">Disk I/O Types:</a>
<ul>
    <li>hoff_t  - (64-bit?) offset on disk in bytes
    <li>hlen_t  - (64-bit?) length on disk in bytes
</ul>