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
|
<html>
<head><title>
HDF5/H5T API Specification
</title>
<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->
<!--
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>
<body bgcolor="#FFFFFF">
<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<a href="RM_H5P.html">H5P</a>
<br>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><center>
<h1>H5T: Datatype Interface</h1>
</center>
<h2>Datatype Object API Functions</h2>
These functions create and manipulate the datatype which describes elements
of a dataset.
<p>
<strong>The C Interfaces:</strong>
<table border=0>
<tr><td valign=top>
<i>General Datatype Operations</i>
<li><a href="#Datatype-Create">H5Tcreate</a>
<li><a href="#Datatype-Open">H5Topen</a>
<li><a href="#Datatype-Commit">H5Tcommit</a>
<li><a href="#Datatype-Committed">H5Tcommitted</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-GetSuper">H5Tget_super</a>
<li><a href="#Datatype-GetNativeType">H5Tget_native_type</a>
<li><a href="#Datatype-DetectClass">H5Tdetect_class</a>
<li><a href="#Datatype-Close">H5Tclose</a>
<br><br>
<i>Conversion Functions</i>
<li><a href="#Datatype-Convert">H5Tconvert</a>
<li><a href="#Datatype-Find">H5Tfind</a>
<li><a href="#Datatype-SetOverflow">H5Tset_overflow</a>
<li><a href="#Datatype-GetOverflow">H5Tget_overflow</a>
<li><a href="#Datatype-Register">H5Tregister</a>
<li><a href="#Datatype-Unregister">H5Tunregister</a>
</td><td> </td><td valign=top>
<i>Atomic Datatype Properties</i>
<table><tr><td valign=top>
<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>
</td><td valign=top>
<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>
</td></tr></table>
<br><br>
<i>Enumeration Datatypes</i>
<li><a href="#Datatype-EnumCreate">H5Tenum_create</a>
<li><a href="#Datatype-EnumInsert">H5Tenum_insert</a>
<li><a href="#Datatype-EnumNameOf">H5Tenum_nameof</a>
<li><a href="#Datatype-EnumValueOf">H5Tenum_valueof</a>
<li><a href="#Datatype-GetMemberValue">H5Tget_member_value</a>
<li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a>
<li><a href="#Datatype-GetMemberName">H5Tget_member_name</a>
<li><a href="#Datatype-GetMemberIndex">H5Tget_member_index</a>
</td><td> </td><td valign=top>
<i>Compound Datatype Properties</i>
<li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a>
<li><a href="#Datatype-GetMemberClass">H5Tget_member_class</a>
<li><a href="#Datatype-GetMemberName">H5Tget_member_name</a>
<li><a href="#Datatype-GetMemberIndex">H5Tget_member_index</a>
<li><a href="#Datatype-GetMemberOffset">H5Tget_member_offset</a>
<li><a href="#Datatype-GetMemberType">H5Tget_member_type</a>
<li><a href="#Datatype-Insert">H5Tinsert</a>
<li><a href="#Datatype-Pack">H5Tpack</a>
<br><br>
<i>Array Datatypes</i>
<li><a href="#Datatype-ArrayCreate">H5Tarray_create</a>
<li><a href="#Datatype-GetArrayNdims">H5Tget_array_ndims</a>
<li><a href="#Datatype-GetArrayDims">H5Tget_array_dims</a>
<br><br>
<i>Variable-length Datatypes</i>
<li><a href="#Datatype-VLCreate">H5Tvlen_create</a>
<li><a href="#Datatype-IsVariableString">H5Tis_variable_str</a>
<br><br>
<i>Opaque Datatypes</i>
<li><a href="#Datatype-SetTag">H5Tset_tag</a>
<li><a href="#Datatype-GetTag">H5Tget_tag</a>
</td></tr>
</table>
<br>
<!-- NEW PAGE -->
<i>Alphabetical Listing</i>
<table border="0" width=100%>
<tr>
<td valign="top" width=30%>
<li><a href="#Datatype-ArrayCreate">H5Tarray_create</a>
<li><a href="#Datatype-Close">H5Tclose</a>
<li><a href="#Datatype-Commit">H5Tcommit</a>
<li><a href="#Datatype-Committed">H5Tcommitted</a>
<li><a href="#Datatype-Convert">H5Tconvert</a>
<li><a href="#Datatype-Copy">H5Tcopy</a>
<li><a href="#Datatype-Create">H5Tcreate</a>
<li><a href="#Datatype-DetectClass">H5Tdetect_class</a>
<li><a href="#Datatype-EnumCreate">H5Tenum_create</a>
<li><a href="#Datatype-EnumInsert">H5Tenum_insert</a>
<li><a href="#Datatype-EnumNameOf">H5Tenum_nameof</a>
<li><a href="#Datatype-EnumValueOf">H5Tenum_valueof</a>
<li><a href="#Datatype-Equal">H5Tequal</a>
<li><a href="#Datatype-Find">H5Tfind</a>
<li><a href="#Datatype-GetArrayDims">H5Tget_array_dims</a>
<li><a href="#Datatype-GetArrayNdims">H5Tget_array_ndims</a>
<li><a href="#Datatype-GetClass">H5Tget_class</a>
<li><a href="#Datatype-GetCset">H5Tget_cset</a>
<li><a href="#Datatype-GetEbias">H5Tget_ebias</a>
<li><a href="#Datatype-GetFields">H5Tget_fields</a>
<li><a href="#Datatype-GetInpad">H5Tget_inpad</a>
</td>
<td width=3%> </td>
<td valign="top" width=30%>
<li><a href="#Datatype-GetMemberClass">H5Tget_member_class</a>
<li><a href="#Datatype-GetMemberIndex">H5Tget_member_index</a>
<li><a href="#Datatype-GetMemberName">H5Tget_member_name</a>
<li><a href="#Datatype-GetMemberOffset">H5Tget_member_offset</a>
<li><a href="#Datatype-GetMemberType">H5Tget_member_type</a>
<li><a href="#Datatype-GetMemberValue">H5Tget_member_value</a>
<li><a href="#Datatype-GetNativeType">H5Tget_native_type</a>
<li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a>
<li><a href="#Datatype-GetNorm">H5Tget_norm</a>
<li><a href="#Datatype-GetOffset">H5Tget_offset</a>
<li><a href="#Datatype-GetOrder">H5Tget_order</a>
<li><a href="#Datatype-GetOverflow">H5Tget_overflow</a>
<li><a href="#Datatype-GetPad">H5Tget_pad</a>
<li><a href="#Datatype-GetPrecision">H5Tget_precision</a>
<li><a href="#Datatype-GetSign">H5Tget_sign</a>
<li><a href="#Datatype-GetSize">H5Tget_size</a>
<li><a href="#Datatype-GetStrpad">H5Tget_strpad</a>
<li><a href="#Datatype-GetSuper">H5Tget_super</a>
<li><a href="#Datatype-GetTag">H5Tget_tag</a>
<li><a href="#Datatype-Insert">H5Tinsert</a>
<li><a href="#Datatype-IsVariableString">H5Tis_variable_str</a>
</td>
<td width=3%> </td>
<td valign="top">
<li><a href="#Datatype-Lock">H5Tlock</a>
<li><a href="#Datatype-Open">H5Topen</a>
<li><a href="#Datatype-Pack">H5Tpack</a>
<li><a href="#Datatype-Register">H5Tregister</a>
<li><a href="#Datatype-SetCset">H5Tset_cset</a>
<li><a href="#Datatype-SetEbias">H5Tset_ebias</a>
<li><a href="#Datatype-SetFields">H5Tset_fields</a>
<li><a href="#Datatype-SetInpad">H5Tset_inpad</a>
<li><a href="#Datatype-SetNorm">H5Tset_norm</a>
<li><a href="#Datatype-SetOffset">H5Tset_offset</a>
<li><a href="#Datatype-SetOrder">H5Tset_order</a>
<li><a href="#Datatype-SetOverflow">H5Tset_overflow</a>
<li><a href="#Datatype-SetPad">H5Tset_pad</a>
<li><a href="#Datatype-SetPrecision">H5Tset_precision</a>
<li><a href="#Datatype-SetSign">H5Tset_sign</a>
<li><a href="#Datatype-SetSize">H5Tset_size</a>
<li><a href="#Datatype-SetStrpad">H5Tset_strpad</a>
<li><a href="#Datatype-SetTag">H5Tset_tag</a>
<li><a href="#Datatype-Unregister">H5Tunregister</a>
<li><a href="#Datatype-VLCreate">H5Tvlen_create</a>
</td>
</tr>
</table>
<br>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function.
<br>
<table border=0>
<tr><td valign=top width=32%>
<i>General Datatype Operations</i>
<li><a href="#Datatype-Create">h5tcreate_f</a>
<li><a href="#Datatype-Open">h5topen_f</a>
<li><a href="#Datatype-Commit">h5tcommit_f</a>
<li><a href="#Datatype-Committed">h5tcommitted_f</a>
<li><a href="#Datatype-Copy">h5tcopy_f</a>
<li><a href="#Datatype-Equal">h5tequal_f</a>
<!--<li><a href="#Datatype-Lock">h5tlock_f</a> -->
<li><a href="#Datatype-GetClass">h5tget_class_f</a>
<li><a href="#Datatype-GetSize">h5tget_size_f</a>
<li><a href="#Datatype-GetSuper">h5tget_super_f</a>
<!--<li><a href="#Datatype-GetNativeType">h5tget_native_type_f</a> -->
<!--<li><a href="#Datatype-DetectClass">h5tdetect_class_f</a> -->
<li><a href="#Datatype-Close">h5tclose_f</a>
<!--<br><br> -->
<!--<i>Conversion Functions</i> -->
<!--<li><a href="#Datatype-Convert">h5tconvert_f</a> -->
<!--<li><a href="#Datatype-Find">h5tfind_f</a> -->
<!--<li><a href="#Datatype-SetOverflow">h5tset_overflow_f</a> -->
<!--<li><a href="#Datatype-GetOverflow">h5tget_overflow_f</a> -->
<!--<li><a href="#Datatype-Register">h5tregister_f</a> -->
<!--<li><a href="#Datatype-Unregister">h5tunregister_f</a> -->
<br><br>
<i>Enumeration Datatypes</i>
<li><a href="#Datatype-EnumCreate">h5tenum_create_f</a>
<li><a href="#Datatype-EnumInsert">h5tenum_insert_f</a>
<li><a href="#Datatype-EnumNameOf">h5tenum_nameof_f</a>
<li><a href="#Datatype-EnumValueOf">h5tenum_valueof_f</a>
<li><a href="#Datatype-GetMemberValue">h5tget_member_value_f</a>
<li><a href="#Datatype-GetNmembers">h5tget_nmembers_f</a>
<li><a href="#Datatype-GetMemberName">h5tget_member_name_f</a>
<li><a href="#Datatype-GetMemberIndex">h5tget_member_index_f</a>
</td><td> </td><td valign=top width=32%>
<i>Atomic Datatype Properties</i>
<li><a href="#Datatype-SetSize">h5tset_size_f</a>
<li><a href="#Datatype-GetOrder">h5tget_order_f</a>
<li><a href="#Datatype-SetOrder">h5tset_order_f</a>
<li><a href="#Datatype-GetPrecision">h5tget_precision_f</a>
<li><a href="#Datatype-SetPrecision">h5tset_precision_f</a>
<li><a href="#Datatype-GetOffset">h5tget_offset_f</a>
<li><a href="#Datatype-SetOffset">h5tset_offset_f</a>
<li><a href="#Datatype-GetPad">h5tget_pad_f</a>
<li><a href="#Datatype-SetPad">h5tset_pad_f</a>
<li><a href="#Datatype-GetSign">h5tget_sign_f</a>
<li><a href="#Datatype-SetSign">h5tset_sign_f</a>
<li><a href="#Datatype-GetFields">h5tget_fields_f</a>
<li><a href="#Datatype-SetFields">h5tset_fields_f</a>
<li><a href="#Datatype-GetEbias">h5tget_ebiass_f</a>
<li><a href="#Datatype-SetEbias">h5tset_ebiass_f</a>
<li><a href="#Datatype-GetNorm">h5tget_norm_f</a>
<li><a href="#Datatype-SetNorm">h5tset_norm_f</a>
<li><a href="#Datatype-GetInpad">h5tget_inpad_f</a>
<li><a href="#Datatype-SetInpad">h5tset_inpad_f</a>
<li><a href="#Datatype-GetCset">h5tget_cset_f</a>
<li><a href="#Datatype-SetCset">h5tset_cset_f</a>
<li><a href="#Datatype-GetStrpad">h5tget_strpad_f</a>
<li><a href="#Datatype-SetStrpad">h5tset_strpad_f</a>
<!--<br><br> -->
<!--<i>Variable-length Datatypes</i> -->
<!--<li><a href="#Datatype-VLCreate">h5tvlen_create_f</a> -->
</td><td> </td><td valign=top width=32%>
<i>Array Datatypes</i>
<li><a href="#Datatype-ArrayCreate">h5tarray_create_f</a>
<li><a href="#Datatype-GetArrayNdims">h5tget_array_ndims_f</a>
<li><a href="#Datatype-GetArrayDims">h5tget_array_dims_f</a>
<br><br>
<i>Compound Datatype Properties</i>
<li><a href="#Datatype-GetNmembers">h5tget_nmembers_f</a>
<li><a href="#Datatype-GetMemberClass">h5tget_member_class_f</a>
<li><a href="#Datatype-GetMemberName">h5tget_member_name_f</a>
<li><a href="#Datatype-GetMemberIndex">h5tget_member_index_f</a>
<li><a href="#Datatype-GetMemberOffset">h5tget_member_offset_f</a>
<!--<li><a href="#Datatype-GetMemberDims">h5tget_member_dims_f</a> -->
<li><a href="#Datatype-GetMemberType">h5tget_member_type_f</a>
<li><a href="#Datatype-Insert">h5tinsert_f</a>
<li><a href="#Datatype-Pack">h5tpack_f</a>
<!--<li><a href="#Datatype-InsertArray">h5tinsert_array_f</a> -->
<br><br>
<i>Variable-length Datatypes</i>
<li><a href="#Datatype-VLCreate">h5tvlen_create_f</a>
<li><a href="#Datatype-IsVariableString">h5tis_variable_str_f</a>
<br><br>
<i>Opaque Datatypes</i>
<li><a href="#Datatype-SetTag">h5tset_tag_f</a>
<li><a href="#Datatype-GetTag">h5tget_tag_f</a>
</td></tr>
</table>
<p>
The Datatype interface, H5T, provides a mechanism to describe the
storage format of individual data points of a data set and is
hopefully designed in such a way as to allow new features to be
easily added without disrupting applications that use the data
type interface. A dataset (the H5D interface) is composed of a
collection or raw data points of homogeneous type organized
according to the data space (the H5S interface).
<p>
A datatype is a collection of datatype properties, all of
which can be stored on disk, and which when taken as a whole,
provide complete information for data conversion to or from that
datatype. The interface provides functions to set and query
properties of a datatype.
<p>
A <em>data point</em> is an instance of a <em>datatype</em>,
which is an instance of a <em>type class</em>. We have defined
a set of type classes and properties which can be extended at a
later time. The atomic type classes are those which describe
types which cannot be decomposed at the datatype interface
level; all other classes are compound.
<p>
See <a href="Datatypes.html"><cite>The Datatype Interface (H5T)</cite></a>
in the <cite>HDF5 User's Guide</cite> for further information, including a complete list of all supported datatypes.
<!-- NEW PAGE -->
<!-- HEADER RIGHT " " -->
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tarray_create" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-ArrayCreate">H5Tarray_create</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Tarray_create</code>(
<em>hid_t</em> <code>base</code>,
<em>int</em> <code>rank</code>,
<em>const hsize_t</em> <code>dims[/*rank*/]</code>,
<em>const int</em> <code>perm[/*rank*/]</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates an array datatype object.
<dt><strong>Description:</strong>
<dd><code>H5Tarray_create</code> creates a new array datatype object.
<p>
<code>base</code> is the datatype of every element of the array,
i.e., of the number at each position in the array.
<p>
<code>rank</code> is the number of dimensions and the
size of each dimension is specified in the array <code>dims</code>.
The value of <code>rank</code> is currently limited to
<code>H5S_MAX_RANK</code> and must be greater than <code>0</code>
(zero).
All dimension sizes specified in <code>dims</code> must be greater
than <code>0</code> (zero).
<p>
The array <code>perm</code> is designed to contain the dimension
permutation, i.e. C versus FORTRAN array order.
<b><i>(The parameter </i><code>perm</code><i> is currently unused and is not yet implemented.)</i></b>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>base</code></td>
<td valign="top">IN: Datatype identifier for the array base datatype.</td></tr>
<tr>
<td valign="top"><em>int</em> <code>rank</code></td>
<td valign="top">IN: Rank of the array.</td></tr>
<tr>
<td valign="top"><em>const hsize_t</em> <code>dims[/*rank*/] </code></td>
<td valign="top">IN: Size of each array dimension.</td></tr>
<tr>
<td valign="top"><em>const int</em> <code>perm[/*rank*/]</code></td>
<td valign="top">IN: Dimension permutation.
<b><i>(Currently not implemented.)</i></b></td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tarray_create_f
<dd>
<pre>
SUBROUTINE h5tarray_create_f(base_id, rank, dims, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: base_id ! Identifier of array base datatype
INTEGER, INTENT(IN) :: rank ! Rank of the array
INTEGER(HSIZE_T), DIMENSION(*), INTENT(IN) :: dims
! Sizes of each array dimension
INTEGER(HID_T), INTENT(OUT) :: type_id ! Identifier of the array datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tarray_create_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tclose" -->
<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>Purpose:</strong>
<dd>Releases a datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tclose</code> releases a datatype. Further access
through the datatype identifier is illegal. Failure to release
a datatype with this call will result in resource leaks.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to release.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tclose_f
<dd>
<pre>
SUBROUTINE h5tclose_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tclose_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tcommit" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Commit">H5Tcommit</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em><code>H5Tcommit</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em> <code>name</code>,
<em>hid_t</em> <code>type</code>
)
<dt><strong>Purpose:</strong>
<dd>Commits a transient datatype to a file, creating a new named datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tcommit</code> commits a transient datatype
(not immutable) to a file, turned it into a named datatype.
The <code>loc_id</code> is either a file or group identifier
which, when combined with <code>name</code>, refers to a new
named datatype.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>loc_id</code></td>
<td valign="top">IN: A file or group identifier.</td></tr>
<tr>
<td valign="top"><em>const char *</em> <code>name </code></td>
<td valign="top">IN: A datatype name.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>type</code></td>
<td valign="top">IN: A datatype identifier.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tcommit_f
<dd>
<pre>
SUBROUTINE h5tcommit_f(loc_id, name, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Datatype name within file or group
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tcommit_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tcommitted" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Committed">H5Tcommitted</a>
<dt><strong>Signature:</strong>
<dd><em>htri_t</em><code>H5Tcommitted</code>(<em>hid_t</em> <code>type</code>)
<dt><strong>Purpose:</strong>
<dd>Determines whether a datatype is a named type or a transient type.
<dt><strong>Description:</strong>
<dd><code>H5Tcommitted</code> queries a type to determine whether
the type specified by the <code>type</code> identifier
is a named type or a transient type. If this function returns
a positive value, then the type is named (that is, it has been
committed, perhaps by some other application). Datasets which
return committed datatypes with <code>H5Dget_type()</code> are
able to share the datatype with other datasets in the same file.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type </code></td>
<td valign="top">IN: Datatype identifier.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>When successful, returns a positive value, for <code>TRUE</code>,
if the datatype has been committed, or <code>0</code> (zero),
for <code>FALSE</code>, if the datatype has not been committed.
Otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tcommitted_f
<dd>
<pre>
SUBROUTINE h5tcommitted_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tcommitted_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tconvert" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Convert">H5Tconvert</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tconvert</code>(<em>hid_t</em> <code>src_id</code>,
<em>hid_t</em> <code>dst_id</code>,
<em>size_t</em> <code>nelmts</code>,
<em>void *</em><code>buf</code>,
<em>void *</em><code>background</code>,
<em>hid_t</em> <code>plist_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Converts data from between specified datatypes.
<dt><strong>Description:</strong>
<dd><code>H5Tconvert</code> converts <code>nelmts</code> elements
from the type specified by the <code>src_id</code> identifier
to type <code>dst_id</code>.
The source elements are packed in <code>buf</code> and on return
the destination will be packed in <code>buf</code>.
That is, the conversion is performed in place.
The optional background buffer is an array of <code>nelmts</code>
values of destination type which are merged with the converted
values to fill in cracks (for instance, <code>background</code>
might be an array of structs with the <code>a</code> and
<code>b</code> fields already initialized and the conversion
of <code>buf</code> supplies the <code>c</code> and <code>d</code>
field values).
<p>
The parameter <code>plist_id</code> contains the dataset transfer
property list identifier which is passed to the conversion functions.
As of Release 1.2, this parameter is only used to pass along the
variable-length datatype custom allocation information.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>src_id</code></td>
<td valign="top">Identifier for the source datatype.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>dst_id</code></td>
<td valign="top">Identifier for the destination datatype.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>nelmts</code></td>
<td valign="top">Size of array <code>buf</code>.</td></tr>
<tr>
<td valign="top"><em>void *</em><code>buf</code></td>
<td valign="top">Array containing pre- and post-conversion values.</td></tr>
<tr>
<td valign="top"><em>void *</em><code>background </code></td>
<td valign="top">Optional background buffer.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>plist_id</code></td>
<td valign="top">Dataset transfer property list identifier.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tcopy" -->
<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>Purpose:</strong>
<dd>Copies an existing datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tcopy</code> copies an existing datatype.
The returned type is always transient and unlocked.
<p>
The <code>type_id</code> argument can be either a datatype
identifier, a predefined datatype (defined in
<code>H5Tpublic.h</code>), or a dataset identifier.
If <code>type_id</code> is a dataset identifier instead of a
datatype identifier, then this function returns a transient,
modifiable datatype which is a copy of the dataset's datatype.
<p>
The datatype identifier returned should be released with
<code>H5Tclose</code> or resource leaks will occur.
<!--
<p>
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'
<dt>H5T_NATIVE_HSIZE
<dd> Native size_t type, declare dataset array as 'hsize_t'
<dt>H5T_NATIVE_HSSIZE
<dd> Native signed size_t type, declare dataset array as 'hssize_t'
<dt>H5T_NATIVE_HERR
<dd> Native error type, declare dataset array as 'herr_t'
<dt>H5T_NATIVE_HBOOL
<dd> Native boolean type, declare dataset array as 'hbool_t'
</dl> </ul>
-->
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to copy. Can be a datatype
identifier, a predefined datatype (defined in
<code>H5Tpublic.h</code>), or a dataset identifier.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a datatype identifier if successful;
otherwise returns a negative value
<dt><strong>Fortran90 Interface:</strong> h5tcopy_f
<dd>
<pre>
SUBROUTINE h5tcopy_f(type_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER(HID_T), INTENT(OUT) :: new_type_id ! Identifier of datatype's copy
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tcopy_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tcreate" -->
<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>Purpose:</strong>
<dd>Creates a new datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tcreate</code> creates a new datatype of the specified
class with the specified number of bytes.
<p>
The following datatype classes are supported with this function:
<ul>
<li><code>H5T_COMPOUND</code>
<li><code>H5T_OPAQUE</code>
<li><code>H5T_ENUM</code>
</ul>
<p>
Use <code>H5Tcopy</code> to create integer or floating-point datatypes.
<p>
The datatype identifier returned from this function should be
released with <code>H5Tclose</code> or resource leaks will result.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5T_class_t</em> <code>class </code></td>
<td valign="top">Class of datatype to create.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>size</code></td>
<td valign="top">The number of bytes in the datatype to create.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns datatype identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tcreate_f
<dd>
<pre>
SUBROUTINE h5tcreate_f(class, size, type_id, hdferr)
IMPLICIT NONE
INTEGER, INTENT(IN) :: class ! Datatype class can be one of
! H5T_COMPOUND_F (6)
! H5T_ENUM_F (8)
! H5T_OPAQUE_F (9)
INTEGER(SIZE_T), INTENT(IN) :: size ! Size of the datatype
INTEGER(HID_T), INTENT(OUT) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tcreate_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tdetect_class" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-DetectClass">H5Tdetect_class</a>
<dt><strong>Signature:</strong>
<dd><em>htri_t </em><code>H5Tdetect_class</code>(<em>hid_t</em> <code>dtype_id</code>,
<em>H5T_class_t</em><code>dtype_class</code>
)
<dt><strong>Purpose:</strong>
<dd>Determines whether a datatype contains any datatypes of the
given datatype class.
<dt><strong>Description:</strong>
<dd><code>H5Tdetect_class</code> determines whether the datatype
specified in <code>dtype_id</code> contains any datatypes of the
datatype class specified in <code>dtype_class</code>.
<p>
This function is useful primarily in recursively examining
all the fields and/or base types
of compound, array, and variable-length datatypes.
<p>
Valid class identifiers are as defined in
<a href="#Datatype-GetClass"><code>H5Tget_class</code></a>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>dtype_id</code></td>
<td valign="top">Datatype identifier.</td></tr>
<tr>
<td valign="top"><em>H5T_class_t</em> <code>dtype_class </code></td>
<td valign="top">Datatype class.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tenum_create" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-EnumCreate">H5Tenum_create</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Tenum_create</code>(<em>hid_t</em> <code>parent_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a new enumeration datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tenum_create</code> creates a new enumeration datatype
based on the specified base datatype, <code>parent_id</code>,
which must be an integer type.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>parent_id </code></td>
<td valign="top">IN: Datatype identifier for the base datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the datatype identifier for the new enumeration datatype if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tenum_create_f
<dd>
<pre>
SUBROUTINE h5tenum_create_f(parent_id, new_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: parent_id ! Datatype identifier for
! the base datatype
INTEGER(HID_T), INTENT(OUT) :: new_type_id ! Datatype identifier for the
! new enumeration datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tenum_create_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tenum_insert" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-EnumInsert">H5Tenum_insert</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tenum_insert</code>(<em>hid_t</em> <code>type</code>,
<em>const char</em> *<code>name</code>,
<em>void</em> *<code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Inserts a new enumeration datatype member.
<dt><strong>Description:</strong>
<dd><code>H5Tenum_insert</code> inserts a
new enumeration datatype member into an enumeration datatype.
<p>
<code>type</code> is the enumeration datatype,
<code>name</code> is the name of the new member, and
<code>value</code> points to the value of the new member.
<p>
<code>name</code> and <code>value</code> must both
be unique within <code>type</code>.
<p>
<code>value</code> points to data which is of the
datatype defined when the enumeration datatype was created.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type</code></td>
<td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr>
<tr>
<td valign="top"><em>const char</em> *<code>name </code></td>
<td valign="top">IN: Name of the new member.</td></tr>
<tr>
<td valign="top"><em>void</em> *<code>value</code></td>
<td valign="top">IN: Pointer to the value of the new member.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tenum_insert_f
<dd>
<pre>
SUBROUTINE h5tenum_insert_f(type_id, name, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the new member
INTEGER, INTENT(IN) :: value ! Value of the new member
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tenum_insert_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tenum_nameof" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-EnumNameOf">H5Tenum_nameof</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tenum_nameof</code>(<em>hid_t</em> <code>type</code>
<em>void</em> *<code>value</code>,
<em>char</em> *<code>name</code>,
<em>size_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the symbol name corresponding to a specified member of an enumeration datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tenum_nameof</code> finds the symbol name that
corresponds to the specified <code>value</code>
of the enumeration datatype <code>type</code>.
<p>
At most <code>size</code> characters of the symbol
name are copied into the <code>name</code> buffer.
If the entire symbol name and null terminator
do not fit in the <code>name</code> buffer, then as
many characters as possible are copied
(not null terminated) and the function fails.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type</code></td>
<td valign="top">IN: Enumeration datatype identifier.</td></tr>
<tr>
<td valign="top"><em>void</em> *<code>value, </code></td>
<td valign="top">IN: Value of the enumeration datatype.</td></tr>
<tr>
<td valign="top"><em>char</em> *<code>name</code>,</td>
<td valign="top">OUT: Buffer for output of the symbol name.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>size</code></td>
<td valign="top">IN: Anticipated size of the symbol name, in bytes (characters).</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value
and, if <code>size</code> allows it,
the first character of <code>name</code> is
set to <code>NULL</code>.
<dt><strong>Fortran90 Interface:</strong> h5tenum_nameof_f
<dd>
<pre>
SUBROUTINE h5tenum_nameof_f(type_id, name, namelen, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(OUT) :: name ! Name of the enumeration datatype
INTEGER(SIZE_T), INTENT(IN) :: namelen ! Length of the name
INTEGER, INTENT(IN) :: value ! Value of the enumeration datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tenum_nameof_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tenum_valueof" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-EnumValueOf">H5Tenum_valueof</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tenum_valueof</code>(<em>hid_t</em> <code>type</code>
<em>char</em> *<code>name</code>,
<em>void</em> *<code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the value corresponding to a specified member of an enumeration datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tenum_valueof</code> finds the value that
corresponds to the specified <code>name</code>
of the enumeration datatype <code>type</code>.
<p>
The <code>value</code> argument should be at least
as large as the value of <code>H5Tget_size(type)</code>
in order to hold the result.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type</code></td>
<td valign="top">IN: Enumeration datatype identifier.</td></tr>
<tr>
<td valign="top"><em>const char</em> *<code>name, </code></td>
<td valign="top">IN: Symbol name of the enumeration datatype.</td></tr>
<tr>
<td valign="top"><em>void</em> *<code>value</code>,</td>
<td valign="top">OUT: Buffer for output of the value of the enumeration datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tenum_valueof_f
<dd>
<pre>
SUBROUTINE h5tenum_valueof_f(type_id, name, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the enumeration datatype
INTEGER, INTENT(OUT) :: value ! Value of the enumeration datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tenum_valueof_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tequal" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Equal">H5Tequal</a>
<dt><strong>Signature:</strong>
<dd><em>htri_t </em><code>H5Tequal</code>(<em>hid_t </em><code>type_id1</code>,
<em>hid_t</em><code>type_id2</code>
)
<dt><strong>Purpose:</strong>
<dd>Determines whether two datatype identifiers refer to the same datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tequal</code> determines whether two datatype identifiers
refer to the same datatype.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id1 </code></td>
<td valign="top">Identifier of datatype to compare.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id2</code></td>
<td valign="top">Identifier of datatype to compare.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>When successful, returns a positive value, for <code>TRUE</code>,
if the datatype identifiers refer to the same datatype,
or <code>0</code> (zero), for <code>FALSE</code>.
Otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tequal_f
<dd>
<pre>
SUBROUTINE h5tequal_f(type1_id, type2_id, flag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type1_id ! Datatype identifier
INTEGER(HID_T), INTENT(IN) :: type2_id ! Datatype identifier
LOGICAL, INTENT(OUT) :: flag ! TRUE/FALSE flag to indicate
! if two datatypes are equal
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tequal_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tfind" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Find">H5Tfind</a>
<dt><strong>Signature:</strong>
<dd><em>H5T_conv_t</em> <code>H5Tfind</code>(<em>hid_t</em> <code>src_id</code>,
<em>hid_t</em> <code>dst_id</code>,
<em>H5T_cdata_t **</em><code>pcdata</code>
)
<dt><strong>Purpose:</strong>
<dd>Finds a conversion function.
<dt><strong>Description:</strong>
<dd><code>H5Tfind</code> finds a conversion function that can
handle a conversion from type <code>src_id</code> to type
<code>dst_id</code>.
The <code>pcdata</code> argument is a pointer to a pointer
to type conversion data which was created and initialized
by the soft type conversion function of this path when the
conversion function was installed on the path.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>src_id</code></td>
<td valign="top">IN: Identifier for the source datatype.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>dst_id</code></td>
<td valign="top">IN: Identifier for the destination datatype.</td></tr>
<tr>
<td valign="top"><em>H5T_cdata_t **</em><code>pcdata </code></td>
<td valign="top">OUT: Pointer to type conversion data.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a pointer to a suitable conversion function if successful.
Otherwise returns NULL.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_array_dims" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetArrayDims">H5Tget_array_dims</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Tget_array_dims</code>(
<em>hid_t</em> <code>adtype_id</code>,
<em>hsize_t *</em><code>dims[]</code>,
<em>int *</em><code>perm[]</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves sizes of array dimensions and dimension permutations.
<dt><strong>Description:</strong>
<dd><code>H5Tget_array_dims</code> returns the sizes of the dimensions
and the dimension permutations of the specified array datatype object.
<p>
The sizes of the dimensions are returned in the array <code>dims</code>.
The dimension permutations, i.e., C versus FORTRAN array order,
are returned in the array <code>perm</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>adtype_id </code></td>
<td valign="top">IN: Datatype identifier of array object.</td></tr>
<tr>
<td valign="top"><em>hsize_t *</em><code>dims[]</code></td>
<td valign="top">OUT: Sizes of array dimensions.</td></tr>
<tr>
<td valign="top"><em>int *</em><code>perm[]</code></td>
<td valign="top">OUT: Dimension permutations.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the non-negative number of dimensions of the array type if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_array_dims_f
<dd>
<pre>
SUBROUTINE h5tget_array_dims_f(type_id, dims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Identifier of the array datatype
INTEGER(HSIZE_T), DIMENSION(*), INTENT(OUT) :: dims
! Buffer to store array datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_array_dims_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_array_ndims" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetArrayNdims">H5Tget_array_ndims</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Tget_array_ndims</code>(
<em>hid_t</em> <code>adtype_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the rank of an array datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_array_ndims</code> returns the rank,
the number of dimensions, of an array datatype object.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>adtype_id </code></td>
<td valign="top">IN: Datatype identifier of array object.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the rank of the array if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_array_ndims_f
<dd>
<pre>
SUBROUTINE h5tget_array_ndims_f(type_id, ndims, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Identifier of the array datatype
INTEGER, INTENT(OUT) :: ndims ! Number of array dimensions
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_array_ndims_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_class" -->
<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>Purpose:</strong>
<dd>Returns the datatype class identifier.
<dt><strong>Description:</strong>
<dd><code>H5Tget_class</code> returns the datatype class identifier.
<p>
Valid class identifiers, as defined in <code>H5Tpublic.h</code>, are:
<ul><li><code>H5T_INTEGER</code>
<li><code>H5T_FLOAT</code>
<li><code>H5T_TIME</code>
<li><code>H5T_STRING</code>
<li><code>H5T_BITFIELD</code>
<li><code>H5T_OPAQUE</code>
<li><code>H5T_COMPOUND</code>
<li><code>H5T_REFERENCE</code>
<li><code>H5T_ENUM</code>
<li><code>H5T_VLEN</code>
<li><code>H5T_ARRAY</code>
</ul>
<p>
Note that the library returns <code>H5T_STRING</code>
for both fixed-length and variable-length strings.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns datatype class identifier if successful;
otherwise <code>H5T_NO_CLASS</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_class_f
<dd>
<pre>
SUBROUTINE h5tget_class_f(type_id, class, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: class ! Datatype class, possible values are:
! H5T_NO_CLASS_F
! H5T_INTEGER_F
! H5T_FLOAT_F
! H5T_TIME_F
! H5T_STRING_F
! H5T_BITFIELD_F
! H5T_OPAQUE_F
! H5T_COMPOUND_F
! H5T_REFERENCE_F
! H5T_ENUM_F
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tget_class_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_cset" -->
<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>Purpose:</strong>
<dd>Retrieves the character set type of a string datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_cset</code> retrieves the character set type
of a string datatype. Valid character set types are:
<dl><ul>
<dt>H5T_CSET_ASCII (<code>0</code>)
<dd>Character set is US ASCII
</ul></dl>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid character set type if successful;
otherwise <code>H5T_CSET_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_cset_f
<dd>
<pre>
SUBROUTINE h5tget_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: cset ! Character set type of a string
! datatype
! Possible values of padding type are:
! H5T_CSET_ASCII_F = 0
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_cset_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_ebias" -->
<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>Purpose:</strong>
<dd>Retrieves the exponent bias of a floating-point type.
<dt><strong>Description:</strong>
<dd><code>H5Tget_ebias</code> retrieves the exponent bias of a floating-point type.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the bias if successful;
otherwise 0.
<dt><strong>Fortran90 Interface:</strong> h5tget_ebias_f
<dd>
<pre>
SUBROUTINE h5tget_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: ebias ! Datatype exponent bias
! of a floating-point type
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_ebias_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_fields" -->
<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>spos</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>Purpose:</strong>
<dd>Retrieves floating point datatype bit field information.
<dt><strong>Description:</strong>
<dd><code>H5Tget_fields</code> retrieves information about the locations of the various
bit fields of a floating point datatype. The field positions are bit
positions in the significant region of the datatype. 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>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">IN: Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>spos</code></td>
<td valign="top">OUT: Pointer to location to return floating-point sign bit.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>epos</code></td>
<td valign="top">OUT: Pointer to location to return exponent bit-position.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>esize</code></td>
<td valign="top">OUT: Pointer to location to return size of exponent in bits.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>mpos</code></td>
<td valign="top">OUT: Pointer to location to return mantissa bit-position.</td></tr>
<tr>
<td valign="top"><em>size_t *</em><code>msize</code></td>
<td valign="top">OUT: Pointer to location to return size of mantissa in bits.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_fields_f
<dd>
<pre>
SUBROUTINE h5tget_fields_f(type_id, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: epos ! Exponent bit-position
INTEGER, INTENT(OUT) :: esize ! Size of exponent in bits
INTEGER, INTENT(OUT) :: mpos ! Mantissa bit-position
INTEGER, INTENT(OUT) :: msize ! Size of mantissa in bits
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_fields_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_inpad" -->
<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>Purpose:</strong>
<dd>Retrieves the internal padding type for unused bits in floating-point datatypes.
<dt><strong>Description:</strong>
<dd><code>H5Tget_inpad</code> retrieves the internal padding type for
unused bits in floating-point datatypes.
Valid padding types are:
<ul> <dl>
<dt>H5T_PAD_ZERO (<code>0</code>)
<dd>Set background to zeros.
<dt>H5T_PAD_ONE (<code>1</code>)
<dd>Set background to ones.
<dt>H5T_PAD_BACKGROUND (<code>2</code>)
<dd>Leave background alone.
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid padding type if successful;
otherwise <code>H5T_PAD_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_inpad_f
<dd>
<pre>
SUBROUTINE h5tget_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: padtype ! Padding type for unused bits
! in floating-point datatypes
! Possible values of padding type are:
! H5T_PAD_ZERO_F = 0
! H5T_PAD_ONE_F = 1
! H5T_PAD_BACKGROUND_F = 2
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_inpad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_class" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberClass">H5Tget_member_class</a>
<dt><strong>Signature:</strong>
<dd><em>H5T_class_t</em> <code>H5Tget_member_class</code>(
<em>hid_t</em> <code>cdtype_id</code>,
<em>unsigned </em><code>member_no</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns datatype class of compound datatype member.
<dt><strong>Description:</strong>
<dd>Given a compound datatype, <code>cdtype_id</code>, the function
<code>H5Tget_member_class</code> returns the datatype class of
the compound datatype member specified by <code>member_no</code>.
<p>
Valid class identifiers are as defined in
<a href="#Datatype-GetClass"><code>H5Tget_class</code></a>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>cdtype_id </code></td>
<td valign="top">IN: Datatype identifier of compound object.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>member_no</code></td>
<td valign="top">IN: Compound object member number.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the datatype class, a non-negative value, if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_class_f
<dd>
<pre>
SUBROUTINE h5tget_member_class_f(type_id, member_no, class, hdferr)
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: member_no ! Member number
INTEGER, INTENT(OUT) :: class ! Member class
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_class_f
</pre>
<!--
<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_index" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberIndex">H5Tget_member_index</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Tget_member_index</code>(<em>hid_t </em><code>type_id</code>,
<em>const char *</em> <code>field_name</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the index of a compound or enumeration datatype member.
<dt><strong>Description:</strong>
<dd><code>H5Tget_member_index</code> retrieves the index of a field
of a compound datatype or an element of an enumeration datatype.
<p>
The name of the target field or element is specified in
<code>field_name</code>.
<p>
Fields are stored in no particular order
with index values of 0 through <em>N</em>-1, where <em>N</em> is
the value returned by <code>H5Tget_nmembers</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>const char *</em> <code>field_name </code></td>
<td valign="top">Name of the field or member whose index is to be retrieved.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid field or member index if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_index_f
<dd>
<pre>
SUBROUTINE h5tget_member_index_f(type_id, name, index, hdferr)
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Member name
INTEGER, INTENT(OUT) :: index ! Member index
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_index_f
</pre>
<!--
<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_name" -->
<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>unsigned</em> <code>field_idx</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the name of a compound or enumeration datatype member.
<dt><strong>Description:</strong>
<dd><code>H5Tget_member_name</code> retrieves the name of a field
of a compound datatype or an element of an enumeration datatype.
<p>
The index of the target field or element is specified in
<code>field_idx</code>.
Compound datatype fields and enumeration datatype elements
are stored in no particular order
with index values of 0 through <em>N</em>-1, where <em>N</em>
is the value returned by <code>H5Tget_nmembers</code>.
<p>
A buffer to receive the name of the field is
allocated with <code>malloc()</code> and the caller is responsible
for freeing the memory used.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>field_idx</code></td>
<td valign="top">Zero-based index of the field or element whose name
is to be retrieved.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid pointer to a string allocated with
<code>malloc()</code> if successful;
otherwise returns NULL.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_name_f
<dd>
<pre>
SUBROUTINE h5tget_member_name_f(type_id,index, member_name, namelen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: index ! Field index (0-based) of
! the field name to retrieve
CHARACTER(LEN=*), INTENT(OUT) :: member_name ! Name of a field of
! a compound datatype
INTEGER, INTENT(OUT) :: namelen ! Length of the name
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_name_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_offset" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberOffset">H5Tget_member_offset</a>
<dt><strong>Signature:</strong>
<dd><em>size_t</em> <code>H5Tget_member_offset</code>(<em>hid_t </em><code>type_id</code>,
<em>unsigned</em> <code>memb_no</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the offset of a field of a compound datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_member_offset</code> retrieves the
byte offset of the beginning of a field within a
compound datatype with respect to the beginning
of the compound data type datum.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>memb_no</code></td>
<td valign="top">Number of the field whose offset is requested.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the byte offset of the field if successful;
otherwise returns <code>0</code> (zero).
Note that zero is a valid offset and that this function
will fail only if a call to <code>H5Tget_member_class()</code>
fails with the same arguments.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_offset_f
<dd>
<pre>
SUBROUTINE h5tget_member_offset_f(type_id, member_no, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: member_no ! Number of the field
! whose offset is requested
INTEGER(SIZE_T), INTENT(OUT) :: offset ! Byte offset of the the
! beginning of the field
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_offset_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_type" -->
<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>unsigned</em> <code>field_idx</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the datatype of the specified member.
<dt><strong>Description:</strong>
<dd><code>H5Tget_member_type</code> returns the datatype of the specified member. The caller
should invoke H5Tclose() to release resources associated with the type.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>field_idx</code></td>
<td valign="top">Field index (0-based) of the field type to retrieve.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the identifier of a copy of the datatype of the field
if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_type_f
<dd>
<pre>
SUBROUTINE h5tget_member_type_f(type_id, field_idx, datatype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: field_idx ! Field index (0-based) of the
! field type to retrieve
INTEGER(HID_T), INTENT(OUT) :: datatype ! Identifier of a copy of
! the datatype of the field
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_type_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_member_value" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberValue">H5Tget_member_value</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tget_member_value</code>(<em>hid_t</em> <code>type</code>
<em>unsigned</em> <code>memb_no</code>,
<em>void</em> *<code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the value of an enumeration datatype member.
<dt><strong>Description:</strong>
<dd><code>H5Tget_member_value</code> returns the value of
the enumeration datatype member <code>memb_no</code>.
<p>
The member value is returned in a user-supplied buffer
pointed to by <code>value</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type</code></td>
<td valign="top">IN: Datatype identifier for the enumeration datatype.</td></tr>
<tr>
<td valign="top"><em>unsigned</em> <code>memb_no</code>,</td>
<td valign="top">IN: Number of the enumeration datatype member.</td></tr>
<tr>
<td valign="top"><em>void</em> *<code>value </code></td>
<td valign="top">OUT: Pointer to a buffer for output of the
value of the enumeration datatype member.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_member_value_f
<dd>
<pre>
SUBROUTINE h5tget_member_value_f(type_id, member_no, value, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: member_no ! Number of the enumeration
! datatype member
INTEGER, INTENT(OUT) :: value ! Value of the enumeration datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_member_value_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_native_type" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetNativeType">H5Tget_native_type</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Tget_native_type</code>(<em>hid_t</em> <code>type_id</code>,
<em>H5T_direction_t</em> <code>direction</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the native datatype of a specified datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_native_type</code> returns the equivalent native datatype
for the datatype specified in <code>type_id</code>.
<p>
<code>H5Tget_native_type</code> is a high-level function designed
primarily to facilitate use of the <code>H5Dread</code> function,
for which users otherwise must undertake a multi-step process to
determine the native datatype of a dataset prior to reading it
into memory.
It can be used not only to determine
the native datatype for atomic datatypes,
but also to determine the native datatypes of the individual components of
a compound datatype, an enumerated datatype, an array datatype, or
a variable-length datatype.
<p>
<code>H5Tget_native_type</code> selects the matching native datatype
from the following list:
<pre> H5T_NATIVE_CHAR
H5T_NATIVE_SHORT
H5T_NATIVE_INT
H5T_NATIVE_LONG
H5T_NATIVE_LLONG
H5T_NATIVE_UCHAR
H5T_NATIVE_USHORT
H5T_NATIVE_UINT
H5T_NATIVE_ULONG
H5T_NATIVE_ULLONG
H5T_NATIVE_FLOAT
H5T_NATIVE_DOUBLE
H5T_NATIVE_LDOUBLE</pre>
<p>
The <code>direction</code> parameter indicates the order
in which the library searches for a native datatype match.
Valid values for <code>direction</code> are as follows:
<table border=0>
<tr valign=top><td> </td><td>
<code>H5T_DIR_ASCEND</code></td><td>
Searches the above list in ascending size of the datatype,<br>
i.e., from top to bottom. (Default)
</td></tr>
<tr valign=top><td> </td><td>
<code>H5T_DIR_DESCEND</code> </td><td>
Searches the above list in descending size of the datatype,<br>
i.e., from bottom to top.
</td></tr>
</table>
<p>
<code>H5Tget_native_type</code> is designed primarily for
use with intenger and floating point datatypes.
Time, bifield, opaque, and reference datatypes are returned
as a copy of <code>type_id</code>.
<p>
The identifier returned by <code>H5Tget_native_type</code>
should eventually be closed by calling <code>H5Tclose</code>
to release resources.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Datatype identifier for the dataset datatype.</td></tr>
<tr>
<td valign="top"><em>H5T_direction_t</em> <code>direction </code></td>
<td valign="top">Direction of search.</td></tr>
</table></ul>
<!-- NEW PAGE -->
<dt><strong>Returns:</strong>
<dd>Returns the native datatype identifier for the
specified dataset datatype if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_nmembers" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetNmembers">H5Tget_nmembers</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Tget_nmembers</code>(<em>hid_t </em><code>type_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the number of elements in a compound or enumeration datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_nmembers</code> retrieves
the number of fields in a compound datatype or
the number of members of an enumeration datatype.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the number of elements if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_nmembers_f
<dd>
<pre>
SUBROUTINE h5tget_nmembers_f(type_id, num_members, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: num_members ! Number of fields in a
! compound datatype
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_nmembers_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_norm" -->
<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>Purpose:</strong>
<dd>Retrieves mantissa normalization of a floating-point datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_norm</code> retrieves the mantissa normalization of
a floating-point datatype. Valid normalization types are:
<ul> <dl>
<dt>H5T_NORM_IMPLIED (<code>0</code>)
<dd>MSB of mantissa is not stored, always 1
<dt>H5T_NORM_MSBSET (<code>1</code>)
<dd>MSB of mantissa is always 1
<dt>H5T_NORM_NONE (<code>2</code>)
<dd>Mantissa is not normalized
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid normalization type if successful;
otherwise <code>H5T_NORM_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_norm_f
<dd>
<pre>
SUBROUTINE h5tget_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(OUT) :: norm ! Mantissa normalization of a
! floating-point datatype
! Valid normalization types are:
! H5T_NORM_IMPLIED_F(0)
! MSB of mantissa is not
! stored, always 1
! H5T_NORM_MSBSET_F(1)
! MSB of mantissa is always 1
! H5T_NORM_NONE_F(2)
! Mantissa is not normalized
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_norm_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_offset" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetOffset">H5Tget_offset</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Tget_offset</code>(<em>hid_t </em><code>type_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the bit offset of the first significant bit.
<dt><strong>Description:</strong>
<dd><code>H5Tget_offset</code> retrieves the bit offset of the first significant bit.
The significant 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 laid 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>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns an offset value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_offset_f
<dd>
<pre>
SUBROUTINE h5tget_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: offset ! Datatype bit offset of the
! first significant bit
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_offset_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_order" -->
<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>Purpose:</strong>
<dd>Returns the byte order of an atomic datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_order</code> returns the byte order of an
atomic datatype.
<p>
Possible return values are:
<ul><dl>
<dt><code>H5T_ORDER_LE</code> (<code>0</code>)
<dd>Little endian byte ordering (default).
<dt><code>H5T_ORDER_BE</code> (<code>1</code>)
<dd>Big endian byte ordering.
<dt><code>H5T_ORDER_VAX</code> (<code>2</code>)
<dd>VAX mixed byte ordering (not currently supported).
</dl></ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a byte order constant if successful;
otherwise <code>H5T_ORDER_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_order_f
<dd>
<pre>
SUBROUTINE h5tget_order_f(type_id, order, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: order ! Datatype byte order
! Possible values are:
! H5T_ORDER_LE_F
! H5T_ORDER_BE_F
! H5T_ORDER_VAX_F
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tget_order_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_overflow" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetOverflow">H5Tget_overflow</a>
<dt><strong>Signature:</strong>
H5Tget_overflow ()
<dd><em>H5T_overflow_t</em> <code>H5Tget_overflow</code>(<code>void</code>)
<dt><strong>Purpose:</strong>
<dd>Returns a pointer to the current global overflow function.
<dt><strong>Description:</strong>
<dd><code>H5Tset_overflow</code> returns a pointer
to the current global overflow function.
This is an application-defined function that is called whenever a
datatype conversion causes an overflow.
<dt><strong>Parameters:</strong>
<dl>
<dt>None.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a pointer to an application-defined function if successful.
Otherwise returns NULL; this can happen if no overflow handling
function is registered.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_pad" -->
<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>Purpose:</strong>
<dd>Retrieves the padding type of the least and most-significant bit padding.
<dt><strong>Description:</strong>
<dd><code>H5Tget_pad</code> retrieves the padding type of the least and most-significant
bit padding. Valid types are:
<ul> <dl>
<dt>H5T_PAD_ZERO (<code>0</code>)
<dd>Set background to zeros.
<dt>H5T_PAD_ONE (<code>1</code>)
<dd>Set background to ones.
<dt>H5T_PAD_BACKGROUND (<code>2</code>)
<dd>Leave background alone.
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">IN: Identifier of datatype to query.</td></tr>
<tr>
<td valign="top"><em>H5T_pad_t *</em> <code>lsb </code></td>
<td valign="top">OUT: Pointer to location to return least-significant
bit padding type.</td></tr>
<tr>
<td valign="top"><em>H5T_pad_t *</em> <code>msb</code></td>
<td valign="top">OUT: Pointer to location to return most-significant
bit padding type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_pad_f
<dd>
<pre>
SUBROUTINE h5tget_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: lsbpad ! Padding type of the
! least significant bit
INTEGER, INTENT(OUT) :: msbpad ! Padding type of the
! most significant bit
! Possible values of
! padding type are:
! H5T_PAD_ZERO_F = 0
! H5T_PAD_ONE_F = 1
! H5T_PAD_BACKGROUND_F = 2
! H5T_PAD_ERROR_F = -1
! H5T_PAD_NPAD_F = 3
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_pad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_precision" -->
<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>Purpose:</strong>
<dd>Returns the precision of an atomic datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_precision</code> returns the precision of an atomic datatype. 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>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the number of significant bits if successful;
otherwise 0.
<dt><strong>Fortran90 Interface:</strong> h5tget_precision_f
<dd>
<pre>
SUBROUTINE h5tget_precision_f(type_id, precision, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: precision ! Datatype precision
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_precision_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_sign" -->
<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>Purpose:</strong>
<dd>Retrieves the sign type for an integer type.
<dt><strong>Description:</strong>
<dd><code>H5Tget_sign</code> retrieves the sign type for an integer type.
Valid types are:
<ul> <dl>
<dt>H5T_SGN_NONE (<code>0</code>)
<dd>Unsigned integer type.
<dt>H5T_SGN_2 (<code>1</code>)
<dd>Two's complement signed integer type.
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid sign type if successful;
otherwise <code>H5T_SGN_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_sign_f
<dd>
<pre>
SUBROUTINE h5tget_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: sign ! Sign type for an integer type
! Possible values are:
! Unsigned integer type
! H5T_SGN_NONE_F = 0
! Two's complement signed
! integer type
! H5T_SGN_2_F = 1
! or error value
! H5T_SGN_ERROR_F = -1
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_sign_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_size" -->
<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>Purpose:</strong>
<dd>Returns the size of a datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_size</code> returns the size of a datatype in bytes.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the size of the datatype in bytes if successful;
otherwise 0.
<dt><strong>Fortran90 Interface:</strong> h5tget_size_f
<dd>
<pre>
SUBROUTINE h5tget_size_f(type_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER(SIZE_T), INTENT(OUT) :: size ! Datatype size
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tget_size_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_strpad" -->
<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>Purpose:</strong>
<dd>Retrieves the storage mechanism for a string datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_strpad</code> retrieves the storage mechanism
for a string datatype, as defined in
<a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to query.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a valid string storage mechanism if successful;
otherwise <code>H5T_STR_ERROR</code> (-1).
<dt><strong>Fortran90 Interface:</strong> h5tget_strpad_f
<dd>
<pre>
SUBROUTINE h5tget_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(OUT) :: strpad ! String padding method for a string datatype
! Possible values of padding type are:
! Pad with zeros (as C does):
! H5T_STR_NULLPAD_F(0)
! Pad with spaces (as FORTRAN does):
! H5T_STR_SPACEPAD_F(1)
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_strpad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_super" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetSuper">H5Tget_super</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Tget_super</code>(<em>hid_t</em> <code>type</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the base datatype from which a datatype is derived.
<dt><strong>Description:</strong>
<dd><code>H5Tget_super</code> returns the base datatype from which the
datatype <code>type</code> is derived.
<P>
In the case of an enumeration type, the return value is an integer type.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type </code></td>
<td valign="top">Datatype identifier for the derived datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns the datatype identifier for the base datatype if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tget_super_f
<dd>
<pre>
SUBROUTINE h5tget_super_f(type_id, base_type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER(HID_T), INTENT(OUT) :: type_id ! Base datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_super_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tget_tag" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetTag">H5Tget_tag</a>
<dt><strong>Signature:</strong>
<dd><em>char</em> *<code>H5Tget_tag</code>(<em>hid_t</em> <code>type_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets the tag associated with an opaque datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_tag</code> returns the tag associated with
the opaque datatype <code>type_id</code>.
<P>
The tag is returned via a pointer to an
allocated string, which the caller must free.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Datatype identifier for the opaque datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a pointer to an allocated string if successful;
otherwise returns <code>NULL</code>.
<dt><strong>Fortran90 Interface:</strong> h5tget_tag_f
<dd>
<pre>
SUBROUTINE h5tget_tag_f(type_id, tag,taglen, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(OUT) :: tag ! Unique ASCII string with which the
! opaque datatype is to be tagged
INTEGER, INTENT(OUT) :: taglen ! Length of tag
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tget_tag_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tinsert" -->
<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>size_t</em> <code>offset</code>,
<em>hid_t</em> <code>field_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Adds a new member to a compound datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tinsert</code> adds another member to the compound datatype
<code>type_id</code>. The new member has a <code>name</code> which
must be unique within the compound datatype.
The <code>offset</code> argument defines the start of the member
in an instance of the compound datatype, and <code>field_id</code>
is the datatype identifier of the new member.
<P>
Note: Members of a compound datatype do not have to be atomic datatypes;
a compound datatype can have a member which is a compound datatype.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of compound datatype to modify.</td></tr>
<tr>
<td valign="top"><em>const char *</em> <code>name </code></td>
<td valign="top">Name of the field to insert.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>offset</code></td>
<td valign="top">Offset in memory structure of the field to insert.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>field_id</code></td>
<td valign="top">Datatype identifier of the field to insert.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tinsert_f
<dd>
<pre>
SUBROUTINE h5tinsert_f(type_id, name, offset, field_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the field to insert
INTEGER(SIZE_T), INTENT(IN) :: offset ! Offset in memory structure
! of the field to insert
INTEGER(HID_T), INTENT(IN) :: field_id ! Datatype identifier of the
! new member
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tinsert_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tis_variable_str" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-IsVariableString">H5Tis_variable_str</a>
<dt><strong>Signature:</strong>
<dd><em>htri_t </em><code>H5Tis_variable_str</code>(<em>hid_t </em><code>dtype_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Determines whether datatype is a variable-length string.
<dt><strong>Description:</strong>
<dd><code>H5Tvlen_create</code> determines whether the datatype
identified in <code>dtype_id</code> is a variable-length string.
<p>
This function can be used to distinguish between
fixed and variable-length string datatypes.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>dtype_id </code></td>
<td valign="top">Datatype identifier.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tis_variable_str_f
<dd>
<pre>
SUBROUTINE h5tis_variable_str_f(type_id, status, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
LOGICAL, INTENT(OUT) :: status ! Logical flag:
! .TRUE. if datatype is a
! varibale string
! .FALSE. otherwise
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tis_variable_str_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tlock" -->
<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>Purpose:</strong>
<dd>Locks a datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tlock</code> locks the datatype specified by the
<code>type_id</code> identifier, making it read-only and
non-destructible. This is normally done by the library for
predefined datatypes so the application does not
inadvertently change or delete a predefined type.
Once a datatype is locked it can never be unlocked.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to lock.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Topen" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Open">H5Topen</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em><code>H5Topen</code>(<em>hid_t</em> <code>loc_id</code>,
<em>const char *</em> <code>name</code>
)
<dt><strong>Purpose:</strong>
<dd>Opens a named datatype.
<dt><strong>Description:</strong>
<dd><code>H5Topen</code> opens a named datatype at the location
specified by <code>loc_id</code> and returns an identifier
for the datatype. <code>loc_id</code> is either a file or
group identifier. The identifier should eventually be closed
by calling <code>H5Tclose</code> to release resources.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>loc_id</code></td>
<td valign="top">IN: A file or group identifier.</td></tr>
<tr>
<td valign="top"><em>const char *</em> <code>name </code></td>
<td valign="top">IN: A datatype name, defined within the file
or group identified by <code>loc_id</code>.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a named datatype identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5topen_f
<dd>
<pre>
SUBROUTINE h5topen_f(loc_id, name, type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File or group identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Datatype name within file or
! group
INTEGER(HID_T), INTENT(out) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5topen_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tpack" -->
<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>Purpose:</strong>
<dd>Recursively removes padding from within a compound datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tpack</code> recursively removes padding from within a compound
datatype to make it more efficient (space-wise) to store that data.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to modify.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tpack_f
<dd>
<pre>
SUBROUTINE h5tpack_f(type_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tpack_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tregister" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-Register">H5Tregister</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tregister</code>(<em>H5T_pers_t</em> <code>pers</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>Purpose:</strong>
<dd>Registers a conversion function.
<dt><strong>Description:</strong>
<dd><code>H5Tregister</code> registers a hard or soft conversion function
for a datatype conversion path.
<p>
The parameter <code>pers</code> indicates whether a conversion function
is <em>hard</em> (<code>H5T_PERS_HARD</code>)
or <em>soft</em> (<code>H5T_PERS_SOFT</code>).
<p>
A conversion path can have only one hard function.
When <code>pers</code> is <code>H5T_PERS_HARD</code>,
<code>func</code> replaces any previous hard function.
If <code>pers</code> is <code>H5T_PERS_HARD</code> and
<code>func</code> is the null pointer, then any hard function
registered for this path is removed.
<p>
When <code>pers</code> is <code>H5T_PERS_SOFT</code>,
<code>H5Tregister</code>
adds the function to the end of the master soft list and replaces
the soft function in all applicable existing conversion paths.
Soft functions are used when determining which conversion function
is appropriate for this path.
<p>
The <code>name</code> is used only for debugging and should be a
short identifier for the function.
<p>
The path is specified by the source and destination datatypes
<code>src_id</code> and <code>dst_id</code>.
For soft conversion functions, only the class of these types is important.
<p>
The type of the conversion function pointer is declared as:
<dir>
<pre><code>typedef</code> <em>herr_t </em>(<code>*H5T_conv_t</code>) (<em>hid_t </em><code>src_id</code>,
<em>hid_t </em><code>dst_id</code>,
<em>H5T_cdata_t *</em><code>cdata</code>,
<em>size_t </em><code>nelmts</code>,
<em>size_t </em><code>buf_stride</code>,
<em>size_t </em><code>bkg_stride</code>,
<em>void *</em><code>buf</code>,
<em>void *</em><code>bkg</code>,
<em>hid_t </em><code>dset_xfer_plist</code>)</pre>
</dir>
<p>
The <code>H5T_cdata_t</code> struct is declared as:
<dir>
<pre><code>typedef</code> <em>struct </em><code>*H5T_cdata_t</code> (<em>H5T_cmd_t </em><code>command</code>,
<em>H5T_bkg_t </em><code>need_bkg</code>,
<em>hbool_t *</em><code>recalc</code>,
<em>void *</em><code>priv</code>)</pre>
</dir>
<p>
The <code>H5T_conv_t</code> parameters and
the elements of the <code>H5T_cdata_t</code> struct
are described more fully in the
“<a href="Datatypes.html#Datatypes-DataConversion"
target="WinUG">Data Conversion</a>”
section of “The Datatype Interface (H5T)”
in the <cite>HDF5 User's Guide</cite>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5T_pers_t</em> <code>pers</code></td>
<td valign="top"><code>H5T_PERS_HARD</code> for hard conversion functions;
<code>H5T_PERS_SOFT</code> for soft conversion functions.</td></tr>
<tr>
<td valign="top"><em>const char *</em> <code>name</code></td>
<td valign="top">Name displayed in diagnostic output.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>src_id</code></td>
<td valign="top">Identifier of source datatype.</td></tr>
<tr>
<td valign="top"><em>hid_t</em> <code>dst_id</code></td>
<td valign="top">Identifier of destination datatype.</td></tr>
<tr>
<td valign="top"><em>H5T_conv_t</em> <code>func </code></td>
<td valign="top">Function to convert between source and destination datatypes.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_cset" -->
<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>Purpose:</strong>
<dd>Sets character set to be used.
<dt><strong>Description:</strong>
<dd><code>H5Tset_cset</code> the character set to be used.
<p>
HDF5 is able to distinguish between character sets of different
nationalities and to convert between them to the extent possible.
Valid character set types are:
<ul> <dl>
<dt>H5T_CSET_ASCII (<code>0</code>)
<dd>Character set is US ASCII.
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to modify.</td></tr>
<tr>
<td valign="top"><em>H5T_cset_t</em> <code>cset </code></td>
<td valign="top">Character set type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_cset_f
<dd>
<pre>
SUBROUTINE h5tset_cset_f(type_id, cset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(IN) :: cset ! Character set type of a string datatype
! Possible values of padding type are:
! H5T_CSET_ASCII_F = 0
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_cset_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_ebias" -->
<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>Purpose:</strong>
<dd>Sets the exponent bias of a floating-point type.
<dt><strong>Description:</strong>
<dd><code>H5Tset_ebias</code> sets the exponent bias of a floating-point type.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>ebias</code></td>
<td valign="top">Exponent bias value.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_ebias_f
<dd>
<pre>
SUBROUTINE h5tset_ebias_f(type_id, ebias, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: ebias ! Datatype exponent bias
! of a floating-point type,
! which cannot be 0
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_ebias_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_fields" -->
<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>spos</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>Purpose:</strong>
<dd>Sets locations and sizes of floating point bit fields.
<dt><strong>Description:</strong>
<dd><code>H5Tset_fields</code> sets the locations and sizes of the various
floating-point bit fields. The field positions are bit positions in the
significant region of the datatype. 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>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>spos</code></td>
<td valign="top">Sign position, i.e., the bit offset of the floating-point
sign bit.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>epos</code></td>
<td valign="top">Exponent bit position.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>esize</code></td>
<td valign="top">Size of exponent in bits.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>mpos</code></td>
<td valign="top">Mantissa bit position.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>msize</code></td>
<td valign="top">Size of mantissa in bits.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_fields_f
<dd>
<pre>
SUBROUTINE h5tset_fields_f(type_id, epos, esize, mpos, msize, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: epos ! Exponent bit-position
INTEGER, INTENT(IN) :: esize ! Size of exponent in bits
INTEGER, INTENT(IN) :: mpos ! Mantissa bit-position
INTEGER, INTENT(IN) :: msize ! Size of mantissa in bits
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_fields_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_inpad" -->
<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>Purpose:</strong>
<dd>Fills unused internal floating point bits.
<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 <code>H5Tset_inpad</code> will be filled
according to the value of the padding value property <code>inpad</code>.
Valid padding types are:
<ul> <dl>
<dt>H5T_PAD_ZERO (<code>0</code>)
<dd>Set background to zeros.
<dt>H5T_PAD_ONE (<code>1</code>)
<dd>Set background to ones.
<dt>H5T_PAD_BACKGROUND (<code>2</code>)
<dd>Leave background alone.
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to modify.</td></tr>
<tr>
<td valign="top"><em>H5T_pad_t</em> <code>pad </code></td>
<td valign="top">Padding type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_inpad_f
<dd>
<pre>
SUBROUTINE h5tset_inpad_f(type_id, padtype, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(IN) :: padtype ! Padding type for unused bits
! in floating-point datatypes.
! Possible values of padding type are:
! H5T_PAD_ZERO_F = 0
! H5T_PAD_ONE_F = 1
! H5T_PAD_BACKGROUND_F = 2
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_inpad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_norm" -->
<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>Purpose:</strong>
<dd>Sets the mantissa normalization of a floating-point datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tset_norm</code> sets the mantissa normalization of
a floating-point datatype. Valid normalization types are:
<ul> <dl>
<dt>H5T_NORM_IMPLIED (<code>0</code>)
<dd>MSB of mantissa is not stored, always 1
<dt>H5T_NORM_MSBSET (<code>1</code>)
<dd>MSB of mantissa is always 1
<dt>H5T_NORM_NONE (<code>2</code>)
<dd>Mantissa is not normalized
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>H5T_norm_t</em> <code>norm </code></td>
<td valign="top">Mantissa normalization type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_norm_f
<dd>
<pre>
SUBROUTINE h5tset_norm_f(type_id, norm, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(IN) :: norm ! Mantissa normalization of a
! floating-point datatype
! Valid normalization types are:
! H5T_NORM_IMPLIED_F(0)
! MSB of mantissa is not stored,
! always 1
! H5T_NORM_MSBSET_F(1)
! MSB of mantissa is always 1
! H5T_NORM_NONE_F(2)
! Mantissa is not normalized
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_norm_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_offset" -->
<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>Purpose:</strong>
<dd>Sets the bit offset of the first significant bit.
<dt><strong>Description:</strong>
<dd><code>H5Tset_offset</code> sets the bit offset of the first significant bit. The
significant 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 laid 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 datatype.
<P>The offset of an H5T_STRING cannot be set to anything but
zero.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>offset</code></td>
<td valign="top">Offset of first significant bit.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_offset_f
<dd>
<pre>
SUBROUTINE h5tset_offset_f(type_id, offset, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: offset ! Datatype bit offset of
! the first significant bit
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_offset_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_order" -->
<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>Purpose:</strong>
<dd>Sets the byte ordering of an atomic datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tset_order</code> sets the byte ordering of an atomic datatype.
Byte orderings currently supported are:
<ul> <dl>
<dt>H5T_ORDER_LE (<code>0</code>)
<dd> Little-endian byte ordering (default).
<dt>H5T_ORDER_BE (<code>1</code>)
<dd> Big-endian byte ordering.
<dt>H5T_ORDER_VAX (<code>2</code>)
<dd>VAX mixed byte ordering (not currently supported).
</dl> </ul>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>H5T_order_t</em> <code>order </code></td>
<td valign="top">Byte ordering constant.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_order_f
<dd>
<pre>
SUBROUTINE h5tset_order_f(type_id, order, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: order ! Datatype byte order
! Possible values are:
! H5T_ORDER_LE_F
! H5T_ORDER_BE_F
! H5T_ORDER_VAX_F
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tset_order_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_overflow" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetOverflow">H5Tset_overflow</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tset_overflow</code>(<em>H5T_overflow_t</em> <code>func</code>)
<dt><strong>Purpose:</strong>
<dd>Sets the overflow handler to a specified function.
<dt><strong>Description:</strong>
<dd><code>H5Tset_overflow</code> sets the overflow handler
to be the function specified by <code>func</code>.
<code>func</code> will be called for all datatype conversions that
result in an overflow.
<p>
See the definition of <code>H5T_overflow_t</code> in
<code>H5Tpublic.h</code> for documentation
of arguments and return values.
The prototype for <code>H5T_overflow_t</code> is as follows:<br>
<code>herr_t (*H5T_overflow_t)(hid_t src_id, hid_t dst_id,
void *src_buf, void *dst_buf);
</code>
<p>
The NULL pointer may be passed to remove the overflow handler.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5T_overflow_t</em> <code>func </code></td>
<td valign="top">Overflow function.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_pad" -->
<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>Purpose:</strong>
<dd>Sets the least and most-significant bits padding types.
<dt><strong>Description:</strong>
<dd><code>H5Tset_pad</code> sets the least and most-significant bits padding types.
<dl> <ul>
<dt>H5T_PAD_ZERO (<code>0</code>)
<dd>Set background to zeros.
<dt>H5T_PAD_ONE (<code>1</code>)
<dd>Set background to ones.
<dt>H5T_PAD_BACKGROUND (<code>2</code>)
<dd>Leave background alone.
</ul> </dl>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>H5T_pad_t</em> <code>lsb </code></td>
<td valign="top">Padding type for least-significant bits.</td></tr>
<tr>
<td valign="top"><em>H5T_pad_t</em> <code>msb</code></td>
<td valign="top">Padding type for most-significant bits.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_pad_f
<dd>
<pre>
SUBROUTINE h5tset_pad_f(type_id, lsbpad, msbpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: lsbpad ! Padding type of the
! least significant bit
INTEGER, INTENT(IN) :: msbpad ! Padding type of the
! most significant bit
! Possible values of padding
! type are:
! H5T_PAD_ZERO_F = 0
! H5T_PAD_ONE_F = 1
! H5T_PAD_BACKGROUND_F = 2
! H5T_PAD_ERROR_F = -1
! H5T_PAD_NPAD_F = 3
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_pad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_precision" -->
<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>Purpose:</strong>
<dd>Sets the precision of an atomic datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tset_precision</code> sets the precision of an atomic datatype.
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 datatype.
<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>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>precision </code></td>
<td valign="top">Number of bits of precision for datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_precision_f
<dd>
<pre>
SUBROUTINE h5tset_precision_f(type_id, precision, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER, INTENT(IN) :: precision ! Datatype precision
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_precision_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_sign" -->
<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>Purpose:</strong>
<dd>Sets the sign property for an integer type.
<dt><strong>Description:</strong>
<dd><code>H5Tset_sign</code> sets the sign property for an integer type.
<dl>
<dt>H5T_SGN_NONE (<code>0</code>)
<dd>Unsigned integer type.
<dt>H5T_SGN_2 (<code>1</code>)
<dd>Two's complement signed integer type.
</dl>
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to set.</td></tr>
<tr>
<td valign="top"><em>H5T_sign_t</em> <code>sign </code></td>
<td valign="top">Sign type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_sign_f
<dd>
<pre>
SUBROUTINE h5tset_sign_f(type_id, sign, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(IN) :: sign ! Sign type for an integer type
! Possible values are:
! Unsigned integer type
! H5T_SGN_NONE_F = 0
! Two's complement signed integer type
! H5T_SGN_2_F = 1
! or error value
! H5T_SGN_ERROR_F=-1
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_sign_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_size" -->
<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>Purpose:</strong>
<dd>Sets the total size for an atomic datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tset_size</code> sets the total size in bytes,
<code>size</code>, for a datatype. If the datatype is atomic and size
is decreased so that the significant bits of the datatype 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 datatype still hang over the edge of the new size, then
the number of significant bits is decreased.
The size set for a string should include space for the null-terminator
character, otherwise it will not be stored on (or retrieved from) disk.
Adjusting the size of a string automatically sets the precision
to 8*<code>size</code>. A compound datatype may increase in size,
but may not shrink. All datatypes must have a positive size.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id </code></td>
<td valign="top">Identifier of datatype to change size.</td></tr>
<tr>
<td valign="top"><em>size_t</em> <code>size</code></td>
<td valign="top">Size in bytes to modify datatype.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_size_f
<dd>
<pre>
SUBROUTINE h5tset_size_f(type_id, size, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
INTEGER(SIZE_T), INTENT(IN) :: size ! Datatype size
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5tset_size_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_strpad" -->
<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>Purpose:</strong>
<dd>Defines the storage mechanism for character strings.
<dt><strong>Description:</strong>
<dd><code>H5Tset_strpad</code> defines the storage mechanism for the string.
<p>
The method used to store character strings differs with the
programming language:
<ul>
<li>C usually null terminates strings while
<li>Fortran left-justifies and space-pads strings.
</ul>
Valid string padding values, as passed in the parameter
<code>strpad</code>, are as follows:
<ul> <dl>
<dt>H5T_STR_NULLTERM (<code>0</code>)
<dd>Null terminate (as C does)
<dt>H5T_STR_NULLPAD (<code>1</code>)
<dd>Pad with zeros
<dt>H5T_STR_SPACEPAD (<code>2</code>)
<dd>Pad with spaces (as FORTRAN does)
</dl> </ul>
<p>
When converting from a longer string to a shorter string,
the behavior is as follows.
If the short string is <code>H5T_STR_NULLPAD</code> or
<code>H5T_STR_SPACEPAD</code>, then the string is simply truncated.
If the short string is <code>H5T_STR_NULLTERM</code>, it is
truncated and a null terminator is appended.
<p>
When converting from a shorter string to a longer string,
the long string is padded on the end by appending nulls or spaces.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">Identifier of datatype to modify.</td></tr>
<tr>
<td valign="top"><em>H5T_str_t</em> <code>strpad </code></td>
<td valign="top">String padding type.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_strpad_f
<dd>
<pre>
SUBROUTINE h5tset_strpad_f(type_id, strpad, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id
! Datatype identifier
INTEGER, INTENT(IN) :: strpad ! String padding method for a string datatype
! Possible values of padding type are:
! Pad with zeros (as C does):
! H5T_STR_NULLPAD_F(0)
! Pad with spaces (as FORTRAN does):
! H5T_STR_SPACEPAD_F(1)
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_strpad_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tset_tag" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-SetTag">H5Tset_tag</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Tset_tag</code>(<em>hid_t</em> <code>type_id</code>
<em>const char</em> *<code>tag</code>
)
<dt><strong>Purpose:</strong>
<dd>Tags an opaque datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tset_tag</code> tags an opaque datatype <code>type_id</code>
with a descriptive ASCII identifier,<code> tag</code>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>type_id</code></td>
<td valign="top">IN: Datatype identifier for the opaque datatype to be tagged.</td></tr>
<tr>
<td valign="top"><em>const char</em> *<code>tag </code></td>
<td valign="top">IN: Descriptive ASCII string with which the
opaque datatype is to be tagged.</td></tr>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tset_tag_f
<dd>
<pre>
SUBROUTINE h5tset_tag_f(type_id, tag, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: tag ! Unique ASCII string with which the
! opaque datatype is to be tagged
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tset_tag_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tunregister" -->
<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>Purpose:</strong>
<dd>Removes a conversion function from all conversion paths.
<dt><strong>Description:</strong>
<dd><code>H5Tunregister</code> removes a conversion function from all conversion paths.
<P>
The conversion function pointer type declaration is described in
<a href="#Datatype-Register">H5Tregister</a>.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>H5T_conv_t</em> <code>func </code></td>
<td valign="top">Function to remove from conversion paths.</td>
</table></ul>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong>
<dd>None.
<!--
<pre>
SUBROUTINE
</pre>
-->
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- NEW PAGE -->
<!-- HEADER RIGHT "H5Tvlen_create" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Datatype-VLCreate">H5Tvlen_create</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Tvlen_create</code>(<em>hid_t </em><code>base_type_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a new variable-length datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tvlen_create</code> creates a new variable-length (VL) datatype.
<p>
The base datatype will be the datatype that the sequence is composed of,
characters for character strings, vertex coordinates for polygon lists, etc.
The base type specified for the VL datatype can be of any HDF5 datatype,
including another VL datatype, a compound datatype or an atomic datatype.
<p>
When necessary, use <code>H5Tget_super</code> to determine the base type
of the VL datatype.
<p>
The datatype identifier returned from this function should be
released with <code>H5Tclose</code> or resource leaks will result.
<dt><strong>Parameters:</strong>
<ul><table>
<tr>
<td valign="top"><em>hid_t</em> <code>base_type_id </code></td>
<td valign="top">Base type of datatype to create.</td></tr>
</table></ul>
<dt><strong>See Also:</strong>
<dd><a href="RM_H5D.html#Dataset-GetVLBuf">H5Dget_vlen_buf_size</a>
<dd><a href="RM_H5D.html#Dataset-VLReclaim">H5Dvlen_reclaim</a>
<dt><strong>Returns:</strong>
<dd>Returns datatype identifier if successful;
otherwise returns a negative value.
<dt><strong>Fortran90 Interface:</strong> h5tvlen_create_f
<dd>
<pre>
SUBROUTINE h5tvlen_create_f(type_id, vltype_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: type_id ! Datatype identifier of base type
! Base type can only be atomic
INTEGER(HID_T), INTENT(OUT) :: vltype_id ! VL datatype identifier
INTEGER, INTENT(OUT) :: hdferr ! Error code
END SUBROUTINE h5tvlen_create_f
</pre>
<!--<dt><strong>Non-C API(s):</strong>
<dd>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a> <br>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<a href="RM_H5P.html">H5P</a>
<br>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
</td></tr>
</table>
</center>
<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 27 April 2005");
-->
</SCRIPT>
</body>
</html>
|
