1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
|
<html>
<head><title>
HDF5/H5P API Specification
</title></head>
<body bgcolor="#FFFFFF">
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</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>
H5P
<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>
<center>
<h1>H5P: Property List Interface</h1>
</center>
<h2>Property List API Functions</h2>
These functions manipulate property list objects to allow objects which require
many different parameters to be easily manipulated.
<p>
<strong>The C Interfaces:</strong>
<table border=0>
<tr><td valign=top>
<i>General Property List <br> Operations</i>
<ul>
<li><a href="#Property-Create">H5Pcreate</a>
<li><a href="#Property-GetClass">H5Pget_class</a>
<li><a href="#Property-Copy">H5Pcopy</a>
<li><a href="#Property-Close">H5Pclose</a>
</ul>
<p><i>File Creation Properties</i>
<ul>
<li><a href="#Property-GetVersion">H5Pget_version</a>
<li><a href="#Property-SetUserblock">H5Pset_userblock</a>
<li><a href="#Property-GetUserblock">H5Pget_userblock</a>
<li><a href="#Property-SetSizes">H5Pset_sizes</a>
<li><a href="#Property-GetSizes">H5Pget_sizes</a>
<li><a href="#Property-SetSymK">H5Pset_sym_k</a>
<li><a href="#Property-GetSymK">H5Pget_sym_k</a>
<li><a href="#Property-SetIstoreK">H5Pset_istore_k</a>
<li><a href="#Property-GetIstoreK">H5Pget_istore_k</a>
</ul>
<br>
<br>
<br>
<br>
<br>
<br>
<br>
|| <i>Indicates functions <br>
available only in the <br>
parallel HDF5 library.</i>
</td><td> </td><td valign=top>
<i>File Access Properties</i>
<ul>
<li><a href="#Property-SetFaplCore">H5Pset_fapl_core</a>
<li><a href="#Property-GetFaplCore">H5Pget_fapl_core</a>
<li><a href="#Property-SetFaplFamily">H5Pset_fapl_family</a>
<li><a href="#Property-GetFaplFamily">H5Pget_fapl_family</a>
<li><a href="#Property-SetFaplLog">H5Pset_fapl_log</a>
<li><a href="#Property-SetFaplMpio">H5Pset_fapl_mpio</a> ||
<li><a href="#Property-GetFaplMpio">H5Pget_fapl_mpio</a> ||
<li><a href="#Property-SetFaplMulti">H5Pset_fapl_multi</a>
<li><a href="#Property-GetFaplMulti">H5Pget_fapl_multi</a>
<li><a href="#Property-SetFaplSplit">H5Pset_fapl_split</a>
<li><a href="#Property-SetFaplSec2">H5Pset_fapl_sec2</a>
<li><a href="#Property-SetFaplStdio">H5Pset_fapl_stdio</a>
<li><a href="#Property-SetFaplStream">H5Pset_fapl_stream</a>
<li><a href="#Property-GetFaplStream">H5Pget_fapl_stream</a>
<!--<li><a href="#Property-SetDriver">H5Pset_driver</a> -->
<li><a href="#Property-GetDriver">H5Pget_driver</a>
<!--<li><a href="#Property-GetDriverInfo">H5Pget_driver_info</a> -->
<li><a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
<li><a href="#Property-GetMetaBlockSize">H5Pget_meta_block_size</a>
<li><a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
<li><a href="#Property-GetSieveBufSize">H5Pget_sieve_buf_size</a>
<li><a href="#Property-SetAlignment">H5Pset_alignment</a>
<li><a href="#Property-GetAlignment">H5Pget_alignment</a>
<li><a href="#Property-SetCache">H5Pset_cache</a>
<li><a href="#Property-GetCache">H5Pget_cache</a>
<li><a href="#Property-SetGCReferences">H5Pset_gc_references</a>
<li><a href="#Property-GetGCReferences">H5Pget_gc_references</a>
<li><a href="#Property-SetFaplGass">H5Pset_fapl_gass</a>
<li><a href="#Property-GetFaplGass">H5Pget_fapl_gass</a>
<li><a href="#Property-SetFaplDpss">H5Pset_fapl_dpss</a>
<li><a href="#Property-SetFaplSrb">H5Pset_fapl_srb</a>
<li><a href="#Property-GetFaplSrb">H5Pget_fapl_srb</a>
<!--
<li><a href="#Property-xxx">xxx</a>
<li><a href="#Property-xxx">xxx</a> ||
-->
</ul>
</td><td> </td><td valign=top>
<i>Dataset Creation Properties</i>
<ul>
<li><a href="#Property-SetLayout">H5Pset_layout</a>
<li><a href="#Property-GetLayout">H5Pget_layout</a>
<li><a href="#Property-SetChunk">H5Pset_chunk</a>
<li><a href="#Property-GetChunk">H5Pget_chunk</a>
<li><a href="#Property-SetDeflate">H5Pset_deflate</a>
<!--
<li><a href="#Property-GetDeflate">H5Pget_deflate</a>
<li><a href="#Property-SetCompression">H5Pset_compression</a>
<li><a href="#Property-GetCompression">H5Pget_compression</a>
-->
<li><a href="#Property-SetFillValue">H5Pset_fill_value</a>
<li><a href="#Property-GetFillValue">H5Pget_fill_value</a>
<li><a href="#Property-SetFilter">H5Pset_filter</a>
<li><a href="#Property-GetNFilters">H5Pget_nfilters</a>
<li><a href="#Property-GetFilter">H5Pget_filter</a>
<li><a href="#Property-SetExternal">H5Pset_external</a>
<li><a href="#Property-GetExternalCount">H5Pget_external_count</a>
<li><a href="#Property-GetExternal">H5Pget_external</a>
</ul>
<p><i>Dataset Access, Memory, and <br> Transfer Properties</i>
<ul>
<li><a href="#Property-SetBuffer">H5Pset_buffer</a>
<li><a href="#Property-GetBuffer">H5Pget_buffer</a>
<li><a href="#Property-SetPreserve">H5Pset_preserve</a>
<li><a href="#Property-GetPreserve">H5Pget_preserve</a>
<li><a href="#Property-SetHyperCache">H5Pset_hyper_cache</a>
<li><a href="#Property-GetHyperCache">H5Pget_hyper_cache</a>
<li><a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a>
<li><a href="#Property-GetBTreeRatios">H5Pget_btree_ratios</a>
<li><a href="#Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
<li><a href="#Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
<li><a href="#Property-SetDxplMpio">H5Pset_dxpl_mpio</a> ||
<li><a href="#Property-GetDxplMpio">H5Pget_dxpl_mpio</a> ||
<li><a href="#Property-SetDxplMulti">H5Pset_dxpl_multi</a>
<li><a href="#Property-GetDxplMulti">H5Pget_dxpl_multi</a>
</ul>
</td></tr>
<!--
<tr><td colspan=5 align=right>
<br>
|| <i>Available only in the parallel HDF5 library.</i>
</td></tr>
-->
</table>
<p>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
<font size=-1>
<i>In general, each FORTRAN90 subroutine performs exactly the same task
as the corresponding C function. The links below go to the C function
descriptions, which serve as general descriptions for both. A button,
under <strong>Non-C API(s)</strong> at the end of the C function description,
opens an external browser window displaying the FORTRAN90-specific
information. You will probably want to adjust the size and location of
this external window so that both browser windows are visible and to
facilitate moving easily between them.</i>
</font>
<table border=0>
<tr><td valign=top>
<i>General Property List Operations</i>
<ul>
<li><a href="#Property-Create">h5pcreate_f</a>
<li><a href="#Property-GetClass">h5pget_class_f</a>
<li><a href="#Property-Copy">h5pcopy_f</a>
<li><a href="#Property-Close">h5pclose_f</a>
</ul>
<p><i>File Creation Properties</i>
<ul>
<li><a href="#Property-GetVersion">h5pget_version_f</a>
<li><a href="#Property-SetUserblock">h5pset_userblock_f</a>
<li><a href="#Property-GetUserblock">h5pget_userblock_f</a>
<li><a href="#Property-SetSizes">h5pset_sizes_f</a>
<li><a href="#Property-GetSizes">h5pget_sizes_f</a>
<li><a href="#Property-SetSymK">h5pset_sym_k_f</a>
<li><a href="#Property-GetSymK">h5pget_sym_k_f</a>
<li><a href="#Property-SetIstoreK">h5pset_istore_k_f</a>
<li><a href="#Property-GetIstoreK">h5pget_istore_k_f</a>
</ul>
<!--<p><i>Variable-length Datatype Properties</i> -->
<!--<ul> -->
<!--<li><a href="#Property-SetVLMemManager">h5pset_vlen_mem_manager_f</a> -->
<!--<li><a href="#Property-GetVLMemManager">h5pget_vlen_mem_manager_f</a> -->
<!--</ul> -->
</td><td> </td><td valign=top>
<i>File Access Properties</i>
<ul>
<li><a href="#Property-GetDriver">h5pget_driver_f</a>
<li><a href="#Property-SetStdio">h5pset_stdio_f</a>
<li><a href="#Property-GetStdio">h5pget_stdio_f</a>
<li><a href="#Property-SetSec2">h5pset_sec2_f</a>
<li><a href="#Property-GetSec2">h5pget_sec2_f</a>
<li><a href="#Property-SetAlignment">h5pset_alignment_f</a>
<li><a href="#Property-GetAlignment">h5pget_alignment_f</a>
<li><a href="#Property-SetCore">h5pset_core_f</a>
<li><a href="#Property-GetCore">h5pget_core_f</a>
<li><a href="#Property-SetMPI">h5pset_mpi_f</a> ||
<li><a href="#Property-GetMPI">h5pget_mpi_f</a> ||
<!--<li><a href="#Property-SetFamily">h5pset_family_f</a> -->
<!--<li><a href="#Property-GetFamily">h5pget_family_f</a> -->
<li><a href="#Property-SetCache">h5pset_cache_f</a>
<li><a href="#Property-GetCache">h5pget_cache_f</a>
<li><a href="#Property-SetSplit">h5pset_split_f</a>
<li><a href="#Property-GetSplit">h5pget_split_f</a>
<li><a href="#Property-SetGCReferences">h5pset_gc_references_f</a>
<li><a href="#Property-GetGCReferences">h5pget_gc_references_f</a>
</ul>
<!--
<br>
<br>
<br>
<br>
<br>
-->
<br>
<br>
|| <i>Available only in the parallel HDF5 library.</i>
</td><td> </td><td valign=top>
<i>Dataset Creation Properties</i>
<ul>
<li><a href="#Property-SetLayout">h5pset_layout_f</a>
<li><a href="#Property-GetLayout">h5pget_layout_f</a>
<li><a href="#Property-SetChunk">h5pset_chunk_f</a>
<li><a href="#Property-GetChunk">h5pget_chunk_f</a>
<li><a href="#Property-SetDeflate">h5pset_deflate_f</a>
<!--<li><a href="#Property-GetDeflate">h5pget_deflate_f</a> -->
<!--<li><a href="#Property-SetCompression">h5pset_compression_f</a> -->
<!--<li><a href="#Property-GetCompression">h5pget_compression_f</a> -->
<li><a href="#Property-SetFillValue">h5pset_fill_value_f</a>
<li><a href="#Property-GetFillValue">h5pget_fill_value_f</a>
<li><a href="#Property-SetFilter">h5pset_filter_f</a>
<!--<li><a href="#Property-GetNFilters">h5pget_nfilters_f</a> -->
<li><a href="#Property-GetFilter">h5pget_filter_f</a>
<li><a href="#Property-SetExternal">h5pset_external_f</a>
<li><a href="#Property-GetExternalCount">h5pget_external_count_f</a>
<li><a href="#Property-GetExternal">h5pget_external_f</a>
</ul>
<p><i>Dataset Memory and Transfer Properties</i>
<ul>
<!--<li><a href="#Property-SetBuffer">h5pset_buffer_f</a> -->
<!--<li><a href="#Property-GetBuffer">h5pget_buffer_f</a> -->
<!--<li><a href="#Property-SetPreserve">h5pset_preserve_f</a> -->
<!--<li><a href="#Property-GetPreserve">h5pget_preserve_f</a> -->
<li><a href="#Property-SetHyperCache">h5pset_hyper_cache_f</a>
<li><a href="#Property-GetHyperCache">h5pget_hyper_cache_f</a>
<li><a href="#Property-SetBTreeRatios">h5pset_btree_ratios_f</a>
<li><a href="#Property-GetBTreeRatios">h5pget_btree_ratios_f</a>
<li><a href="#Property-SetXfer">h5pset_xfer_f</a> ||
<li><a href="#Property-GetXfer">h5pget_xfer_f</a> ||
</ul>
</td></tr>
</table>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Create">H5Pcreate</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Pcreate</code>(<em>H5P_class_t</em> <code>type</code>
)
<dt><strong>Purpose:</strong>
<dd>Creates a new property as an instance of a property list class.
<dt><strong>Description:</strong>
<dd><code>H5Pcreate</code> creates a new property as an instance of some
property list class. The new property list is initialized
with default values for the specified class. The classes are:
<dl>
<dt><code>H5P_FILE_CREATE</code>
<dd>Properties for file creation.
See <a href="Files.html">Files</a>
in the <cite>HDF User's Guide</cite>
for details about the file creation properties.
<dt><code>H5P_FILE_ACCESS</code>
<dd>Properties for file access.
See <a href="Files.html">Files</a>
in the <cite>HDF User's Guide</cite>
for details about the file creation properties.
<dt><code>H5P_DATASET_CREATE</code>
<dd>Properties for dataset creation.
See <a href="Datasets.html">Datasets</a>
in the <cite>HDF User's Guide</cite>
for details about dataset creation properties.
<dt><code>H5P_DATASET_XFER</code>
<dd>Properties for raw data transfer.
See <a href="Datasets.html">Datasets</a>
in the <cite>HDF User's Guide</cite>
for details about raw data transfer properties.
<dt><code>H5P_MOUNT</code>
<dd>Properties for file mounting.
With this parameter, <code>H5Pcreate</code>
creates and returns a new mount property list
initialized with default values.
</dl>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>H5P_class_t</em> <code>type</code>
<dd>IN: The type of property list to create.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list identifier (<code>plist</code>) if successful;
otherwise Fail (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pcreate_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Close">H5Pclose</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pclose</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Terminates access to a property list.
<dt><strong>Description:</strong>
<dd><code>H5Pclose</code> terminates access to a property list.
All property lists should be closed when the application is
finished accessing them.
This frees resources used by the property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of the property list to terminate access to.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pclose_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetClass">H5Pget_class</a>
<dt><strong>Signature:</strong>
<dd><em>H5P_class_t </em><code>H5Pget_class</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the property list class for a property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_class</code> returns the property list class for the
property list identified by the <code>plist</code> parameter.
Valid property list classes are defined in the description of
<code>H5Pcreate()</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list class if successful.
Otherwise returns H5P_NO_CLASS (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_class_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-Copy">H5Pcopy</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t </em><code>H5Pcopy</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Copies an existing property list to create a new property list.
<dt><strong>Description:</strong>
<dd><code>H5Pcopy</code> copies an existing property list to create
a new property list.
The new property list has the same properties and values
as the original property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to duplicate.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a property list identifier if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pcopy_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetVersion">H5Pget_version</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_version</code>(<em>hid_t</em> <code>plist</code>,
<em>int *</em> <code>super</code>,
<em>int *</em> <code>freelist</code>,
<em>int *</em> <code>stab</code>,
<em>int *</em> <code>shhdr</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the version information of various objects for
a file creation property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_version</code> retrieves the version information of various objects
for a file creation property list. Any pointer parameters which are
passed as NULL are not queried.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of the file creation property list.
<dt><em>int *</em> <code>super</code>
<dd>OUT: Pointer to location to return super block version number.
<dt><em>int *</em> <code>freelist</code>
<dd>OUT: Pointer to location to return global freelist version number.
<dt><em>int *</em> <code>stab</code>
<dd>OUT: Pointer to location to return symbol table version number.
<dt><em>int *</em> <code>shhdr</code>
<dd>OUT: Pointer to location to return shared object header version number.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_version_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetUserblock">H5Pset_userblock</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_userblock</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets user block size.
<dt><strong>Description:</strong>
<dd><code>H5Pset_userblock</code> sets the user block size of a
file creation property list.
The default user block size is 0; it may be set to any
power of 2 equal to 512 or greater (512, 1024, 2048, etc.).
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to modify.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Size of the user-block in bytes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_userblock_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetUserblock">H5Pget_userblock</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_userblock</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t *</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of a user block.
<dt><strong>Description:</strong>
<dd><code>H5Pget_userblock</code> retrieves the size of a user block
in a file creation property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>hsize_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return user-block size.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_userblock_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetSizes">H5Pset_sizes</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_sizes</code>(<em>hid_t</em> <code>plist</code>,
<em>size_t</em> <code>sizeof_addr</code>,
<em>size_t</em> <code>sizeof_size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the byte size of the offsets and lengths used to address objects
in an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Pset_sizes</code> sets the byte size of the offsets and lengths used to
address objects in an HDF5 file. This function is only valid for
file creation property lists. Passing in a value of 0 for one of the
sizeof parameters retains the current value. The default value
for both values is 4 bytes. Valid values currently are 2, 4, 8 and
16.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to modify.
<dt><em>size_t</em> <code>sizeof_addr</code>
<dd>IN: Size of an object offset in bytes.
<dt><em>size_t</em> <code>sizeof_size</code>
<dd>IN: Size of an object length in bytes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_sizes_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetSizes">H5Pget_sizes</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_sizes</code>(<em>hid_t</em> <code>plist</code>,
<em>size_t *</em> <code>sizeof_addr</code>,
<em>size_t *</em> <code>sizeof_size</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of the offsets and lengths used in an HDF5 file.
<dt><strong>Description:</strong>
<dd><code>H5Pget_sizes</code> retrieves the size of the offsets
and lengths used in an HDF5 file.
This function is only valid for file creation property lists.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>size_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return offset size in bytes.
<dt><em>size_t *</em> <code>size</code>
<dd>OUT: Pointer to location to return length size in bytes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_sizes_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetSymK">H5Pset_sym_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_sym_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ik</code>,
<em>int</em> <code>lk</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of parameters used to control the symbol table nodes.
<dt><strong>Description:</strong>
<dd><code>H5Pset_sym_k</code> sets the size of parameters used to
control the symbol table nodes. This function is only valid
for file creation property lists. Passing in a value of 0 for
one of the parameters retains the current value.
<p>
<code>ik</code> is one half the rank of a tree that stores a symbol
table for a group. Internal nodes of the symbol table are on
average 75% full. That is, the average rank of the tree is
1.5 times the value of <code>ik</code>.
<p>
<code>lk</code> is one half of the number of symbols that can
be stored in a symbol table node. A symbol table node is the
leaf of a symbol table tree which is used to store a group.
When symbols are inserted randomly into a group, the group's
symbol table nodes are 75% full on average. That is, they
contain 1.5 times the number of symbols specified by
<code>lk</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>int</em> <code>ik</code>
<dd>IN: Symbol table tree rank.
<dt><em>int</em> <code>lk</code>
<dd>IN: Symbol table node size.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_sym_k_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetSymK">H5Pget_sym_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_sym_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int *</em> <code>ik</code>,
<em>int *</em> <code>lk</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of the symbol table B-tree 1/2 rank
and the symbol table leaf node 1/2 size.
<dt><strong>Description:</strong>
<dd><code>H5Pget_sym_k</code> retrieves the size of the
symbol table B-tree 1/2 rank and the symbol table leaf
node 1/2 size. This function is only valid for file creation
property lists. If a parameter valued is set to NULL, that
parameter is not retrieved. See the description for
<a href="#Property-SetSymK">H5Pset_sym_k</a> for more
information.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list to query.
<dt><em>int *</em> <code>ik</code>
<dd>OUT: Pointer to location to return the symbol table's B-tree 1/2 rank.
<dt><em>int *</em> <code>size</code>
<dd>OUT: Pointer to location to return the symbol table's leaf node 1/2 size.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_sym_k_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetIstoreK">H5Pset_istore_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_istore_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ik</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of the parameter used to control the
B-trees for indexing chunked datasets.
<dt><strong>Description:</strong>
<dd><code>H5Pset_istore_k</code> sets the size of the parameter
used to control the B-trees for indexing chunked datasets.
This function is only valid for file creation property lists.
Passing in a value of 0 for one of the parameters retains
the current value.
<p>
<code>ik</code> is one half the rank of a tree that stores
chunked raw data. On average, such a tree will be 75% full,
or have an average rank of 1.5 times the value of
<code>ik</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int</em> <code>ik</code>
<dd>IN: 1/2 rank of chunked storage B-tree.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_istore_k_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetIstoreK">H5Pget_istore_k</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pget_istore_k</code>(<em>hid_t</em> <code>plist</code>,
<em>int *</em> <code>ik</code>
)
<dt><strong>Purpose:</strong>
<dd>Queries the 1/2 rank of an indexed storage B-tree.
<dt><strong>Description:</strong>
<dd><code>H5Pget_istore_k</code> queries the 1/2 rank of
an indexed storage B-tree.
The argument <code>ik</code> may be the null pointer (NULL).
This function is only valid for file creation property lists.
<p>
See <a href="#Property-SetIstoreK">H5Pset_istore_k</a> for details.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int *</em> <code>ik</code>
<dd>OUT: Pointer to location to return the chunked storage B-tree 1/2 rank.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_istore_k_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetLayout">H5Pset_layout</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_layout</code>(<em>hid_t</em> <code>plist</code>,
<em>H5D_layout_t</em> <code>layout</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the type of storage used store the raw data for a dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pset_layout</code> sets the type of storage used store the
raw data for a dataset.
This function is only valid for dataset creation property lists.
Valid parameters for <code>layout</code> are:
<ul><dl>
<dt>H5D_COMPACT <i><b>(Not yet implemented.)</b></i>
<dd>Store raw data and object header contiguously in file.
This should only be used for very small amounts of raw
data (suggested less than 1KB).
<dt>H5D_CONTIGUOUS
<dd>Store raw data separately from object header in one
large chunk in the file.
<dt>H5D_CHUNKED
<dd>Store raw data separately from object header in one
large chunk in the file and store chunks of the raw
data in separate locations in the file.
</dl></ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>H5D_layout_t</em> <code>layout</code>
<dd>IN: Type of storage layout for raw data.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_layout_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetLayout">H5Pget_layout</a>
<dt><strong>Signature:</strong>
<dd><em>H5D_layout_t</em> <code>H5Pget_layout</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Returns the layout of the raw data for a dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pget_layout</code> returns the layout of the raw data for
a dataset. This function is only valid for dataset creation
property lists. Valid types for <code>layout</code> are:
<ul> <dl>
<dt>H5D_COMPACT <i><b>(Not yet implemented.)</b></i>
<dd>Raw data and object header stored contiguously in file.
<dt>H5D_CONTIGUOUS
<dd>Raw data stored separately from object header in one
large chunk in the file.
<dt>H5D_CHUNKED
<dd>Raw data stored separately from object header in
chunks in separate locations in the file.
</dl> </ul>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the layout type of a a dataset creation property list
if successful.
Otherwise returns H5D_LAYOUT_ERROR (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_layout_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetChunk">H5Pset_chunk</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t </em><code>H5Pset_chunk</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>ndims</code>,
<em>const hsize_t *</em> <code>dim</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the size of the chunks used to store a chunked layout dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pset_chunk</code> sets the size of the chunks used to
store a chunked layout dataset. This function is only valid
for dataset creation property lists.
The <code>ndims</code> parameter currently must be the same size
as the rank of the dataset. The values of the <code>dim</code>
array define the size of the chunks to store the dataset's raw data.
As a side-effect, the layout of the dataset is changed to
<code>H5D_CHUNKED</code>, if it is not already.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for property list to query.
<dt><em>int</em> <code>ndims</code>
<dd>IN: The number of dimensions of each chunk.
<dt><em>const hsize_t *</em> <code>dim</code>
<dd>IN: An array containing the size of each chunk.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_chunk_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetChunk">H5Pget_chunk</a>
<dt><strong>Signature:</strong>
<dd><em>int </em><code>H5Pget_chunk</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>max_ndims</code>,
<em>hsize_t *</em> <code>dims</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the size of chunks for the raw data of a chunked layout dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pget_chunk</code> retrieves the size of chunks for the
raw data of a chunked layout dataset.
This function is only valid for dataset creation property lists.
At most, <code>max_ndims</code> elements of <code>dims</code>
will be initialized.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of property list to query.
<dt><em>int</em> <code>max_ndims</code>
<dd>IN: Size of the <code>dims</code> array.
<dt><em>hsize_t *</em> <code>dims</code>
<dd>OUT: Array to store the chunk dimensions.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns chunk dimensionality successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_chunk_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetAlignment">H5Pset_alignment</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_alignment</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>threshold</code>,
<em>hsize_t</em> <code>alignment</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets alignment properties of a file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pset_alignment</code> sets the alignment properties
of a file access property list
so that any file object greater than or equal in size to
<code>threshold</code> bytes will be aligned on an address
which is a multiple of <code>alignment</code>. The addresses
are relative to the end of the user block; the alignment is
calculated by subtracting the user block size from the
absolute file address and then adjusting the address to be a
multiple of <code>alignment</code>.
<p>
Default values for <code>threshold</code> and
<code>alignment</code> are one, implying
no alignment. Generally the default values will result in
the best performance for single-process access to the file.
For MPI-IO and other parallel systems, choose an alignment
which is a multiple of the disk block size.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for a file access property list.
<dt><em>hsize_t</em> <code>threshold</code>
<dd>IN: Threshold value.
Must be non-negative.
Note that setting the threshold value to 0 (zero) has
the effect of a special case, forcing everything
to be aligned.
<dt><em>hsize_t</em> <code>alignment</code>
<dd>IN: Alignment value.
Must be a positive value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_alignment_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetAlignment">H5Pget_alignment</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_alignment</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>*threshold</code>,
<em>hsize_t</em> <code>*alignment</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the current settings for alignment properties from a
file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_alignment</code> retrieves the current settings for
alignment properties from a file access property list.
The <code>threshold</code> and/or <code>alignment</code> pointers
may be null pointers (NULL).
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a file access property list.
<dt><em>hsize_t</em> <code>*threshold</code>
<dd>OUT: Pointer to location of return threshold value.
<dt><em>hsize_t</em> <code>*alignment</code>
<dd>OUT: Pointer to location of return alignment value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_alignment_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetExternal">H5Pset_external</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_external</code>(<em>hid_t</em> <code>plist</code>,
<em>const char</em> <code>*name</code>,
<em>off_t</em> <code>offset</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Adds an external file to the list of external files.
<dt><strong>Description:</strong>
<dd><code>H5Pset_external</code> adds an external file to the
list of external files.
<p>
If a dataset is split across multiple files then the files
should be defined in order. The total size of the dataset is
the sum of the <code>size</code> arguments for all the external files. If
the total size is larger than the size of a dataset then the
dataset can be extended (provided the data space also allows
the extending).
<p>
The <code>size</code> argument specifies number of bytes reserved
for data in the external file.
If <code>size</code> is set to <code>H5F_UNLIMITED</code>, the
external file can be of unlimited size and no more files can be added to
the external files list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
<dt><em>const char</em> <code>*name</code>
<dd>IN: Name of an external file.
<dt><em>off_t</em> <code>offset</code>
<dd>IN: Offset, in bytes, from the beginning of the file
to the location in the file where the data starts.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Number of bytes reserved in the file for the data.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_external_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetExternalCount">H5Pget_external_count</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_external_count</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the number of external files for a dataset.
<dt><strong>Description:</strong>
<dd><code>H5Pget_external_count</code> returns the number of external files
for the specified dataset.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the number of external files if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_external_count_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetExternal">H5Pget_external</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_external</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>idx</code>,
<em>size_t</em> <code>name_size</code>,
<em>char</em> <code>*name</code>,
<em>off_t</em> <code>*offset</code>,
<em>hsize_t</em> <code>*size</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information about an external file.
<dt><strong>Description:</strong>
<dd><code>H5Pget_external</code> returns information about an external
file. The external file is specified by its index, <code>idx</code>,
which is a number from zero to N-1, where N is the value
returned by <code>H5Pget_external_count()</code>.
At most <code>name_size</code> characters are copied into the
<code>name</code> array. If the external file name is
longer than <code>name_size</code> with the null terminator, the
return value is not null terminated (similar to <code>strncpy()</code>).
<p>
If <code>name_size</code> is zero or <code>name</code> is the
null pointer, the external file name is not returned.
If <code>offset</code> or <code>size</code> are null pointers
then the corresponding information is not returned.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier of a dataset creation property list.
<dt><em>int</em> <code>idx</code>
<dd>IN: External file index.
<dt><em>size_t</em> <code>name_size</code>
<dd>IN: Maximum length of <code>name</code> array.
<dt><em>char</em> <code>*name</code>
<dd>OUT: Name of the external file.
<dt><em>off_t</em> <code>*offset</code>
<dd>OUT: Pointer to a location to return an offset value.
<dt><em>hsize_t</em> <code>*size</code>
<dd>OUT: Pointer to a location to return the size of the
external file data.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_external_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFillValue">H5Pset_fill_value</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fill_value</code>(<em>hid_t</em> <code>plist_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>const void *</em><code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets a dataset fill value.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fill_value</code> sets the fill value for a
dataset creation property list.
<p>
The <code>value</code> is interpreted as being of type
<code>type_id</code>. This need not be the same type
as the dataset, but the library must be able to convert
<code>value</code> to the dataset type when the dataset
is created.
<dt><strong>Notes:</strong>
<dd>If a fill value is set for a dataset (even if the
fill value is all zeros), the fill value will be written
to the file. If no fill value is set, then HDF5 relies on
the underlying file driver (usually a Unix file system)
to initialize unwritten parts of the file to zeros.
<p>
Creating a contiguous dataset with a fill value can be a
very expensive operation since the optimization has not
yet been implemented that would delay the writing of the
fill values until after some data has been written.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Property list identifier.
<dt><em>hid_t</em> <code>type_id</code>,
<dd>IN: The datatype identifier of <code>value</code>.
<dt><em>const void *</em><code>value</code>
<dd>IN: The fill value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_fill_value_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFillValue">H5Pget_fill_value</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fill_value</code>(<em>hid_t</em> <code>plist_id</code>,
<em>hid_t</em> <code>type_id</code>,
<em>void *</em><code>value</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves a dataset fill value.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fill_value</code> queries the
fill value property of a dataset creation property list.
<p>
The fill value is returned through the <code>value</code>
pointer.
<p>
Memory is allocated by the caller.
<p>
The fill value will be converted from its current
data type to the type specified by <code>type_id</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Property list identifier.
<dt><em>hid_t</em> <code>type_id</code>,
<dd>IN: The datatype identifier of <code>value</code>.
<dt><em>const void *</em><code>value</code>
<dd>IN: The fill value.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_fill_value_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFilter">H5Pset_filter</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_filter</code>(<em>hid_t</em> <code>plist</code>,
<em>H5Z_filter_t</em> <code>filter</code>,
<em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_nelmts</code>,
<em>const unsigned int</em> <code>cd_values[]</code>
)
<dt><strong>Purpose:</strong>
<dd>Adds a filter to the filter pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Pset_filter</code> adds the specified
<code>filter</code> and corresponding properties to the
end of an output filter pipeline.
If <code>plist</code> is a dataset creation property list,
the filter is added to the permanent filter pipeline;
if <code>plist</code> is a dataset transfer property list,
the filter is added to the transient filter pipeline.
<p>
The array <code>cd_values</code> contains
<code>cd_nelmts</code> integers which are auxiliary data
for the filter. The integer values will be stored in the
dataset object header as part of the filter information.
<p>
The <code>flags</code> argument is a bit vector with
the following fields specifying certain general properties
of the filter:
<center>
<table align=center width="80%">
<tr valign=top>
<td valign=top><code>H5Z_FLAG_OPTIONAL</code></td>
<td> </td>
<td valign=top>If this bit is set then the filter is
optional. If the filter fails (see below) during an
<code>H5Dwrite()</code> operation then the filter is
just excluded from the pipeline for the chunk for which
it failed; the filter will not participate in the
pipeline during an <code>H5Dread()</code> of the chunk.
This is commonly used for compression filters: if the
compression result would be larger than the input then
the compression filter returns failure and the
uncompressed data is stored in the file. If this bit is
clear and a filter fails then <code>H5Dwrite()</code>
or <code>H5Dread()</code> also fails.</td>
</tr>
</table>
</center>
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist_id</code> must be a dataset creation
property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
<dt><em>H5Z_filter_t</em> <code>filter</code>
<dd>IN: Filter to be added to the pipeline.
<dt><em>unsigned int</em> <code>flags</code>
<dd>IN: Bit vector specifying certain general properties
of the filter.
<dt><em>size_t</em> <code>cd_nelmts</code>
<dd>IN: Number of elements in <code>cd_values</code>.
<dt><em>const unsigned int</em> <code>cd_values[]</code>
<dd>IN: Auxiliary data for the filter.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_filter_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetNFilters">H5Pget_nfilters</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_nfilters</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Returns the number of filters in the pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Pget_nfilters</code> returns the number of filters
defined in the filter pipeline associated with the property list
<code>plist</code>.
<p>
In each pipeline, the filters are numbered from
0 through <em>N</em>-1, where <em>N</em> is the value returned
by this function. During output to the file, the filters are
applied in increasing order; during input from the file, they
are applied in decreasing order.
<p>
<code>H5Pget_nfilters</code> returns the number of filters
in the pipeline, including zero (<code>0</code>) if there
are none.
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist_id</code> must be a dataset creation
property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the number of filters in the pipeline if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_nfilters_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFilter">H5Pget_filter</a>
<dt><strong>Signature:</strong>
<dd><em>H5Z_filter_t</em> <code>H5Pget_filter</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>filter_number</code>,
<em>unsigned int *</em><code>flags</code>,
<em>size_t *</em><code>cd_nelmts</code>,
<em>unsigned int *</em><code>cd_values</code>,
<em>size_t</em> <code>namelen</code>,
<em>char</em> <code>name[]</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information about a filter in a pipeline.
<dt><strong>Description:</strong>
<dd><code>H5Pget_filter</code> returns information about a
filter, specified by its filter number, in a filter pipeline,
specified by the property list with which it is associated.
<p>
If <code>plist</code> is a dataset creation property list,
the pipeline is a permanent filter pipeline;
if <code>plist</code> is a dataset transfer property list,
the pipeline is a transient filter pipeline.
<p>
On input, <code>cd_nelmts</code> indicates the number of entries
in the <code>cd_values</code> array, as allocated by the caller;
on return,<code>cd_nelmts</code> contains the number of values
defined by the filter.
<p>
<code>filter_number</code> is a value between zero and
<em>N</em>-1, as described in
<a href="#Property-GetNFilters"><code>H5Pget_nfilters()</code></a>.
The function will return a negative value if the filter number
is out of range.
<p>
If <code>name</code> is a pointer to an array of at least
<code>namelen</code> bytes, the filter name will be copied
into that array. The name will be null terminated if
<code>namelen</code> is large enough. The filter name returned
will be the name appearing in the file, the name registered
for the filter, or an empty string.
<p>
The structure of the <code>flags</code> argument is discussed
in <a href="#Property-SetFilter"><code>H5Pset_filter()</code></a>.
<dt><strong>Note:</strong>
<dd>This function currently supports only the permanent filter
pipeline; <code>plist</code> must be a dataset creation property
list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Property list identifier.
<dt><em>int</em> <code>filter_number</code>
<dd>IN: Sequence number within the filter pipeline of
the filter for which information is sought.
<dt><em>unsigned int *</em><code>flags</code>
<dd>OUT: Bit vector specifying certain general properties
of the filter.
<dt><em>size_t *</em><code>cd_nelmts</code>
<dd>IN/OUT: Number of elements in <code>cd_values</code>.
<dt><em>unsigned int *</em><code>cd_values</code>
<dd>OUT: Auxiliary data for the filter.
<dt><em>size_t</em> <code>namelen</code>
<dd>IN: Anticipated number of characters in <code>name</code>.
<dt><em>char</em> <code>name[]</code>
<dd>OUT: Name of the filter.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns the filter identification number if successful.
Otherwise returns H5Z_FILTER_ERROR (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_filter_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_meta_block_size</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the minimum metadata block size.
<dt><strong>Description:</strong>
<dd><code>H5Pset_meta_block_size</code> sets the
minimum size, in bytes, of metadata block allocations when
<code>H5FD_FEAT_AGGREGATE_METADATA</code> is set by a VFL driver.
<p>
Each <i>raw</i> metadata block is initially allocated to be of the
given size. Specific metadata objects (e.g., object headers,
local heaps, B-trees) are then sub-allocated from this block.
<p>
The default setting is 2048 bytes, meaning that the library
will attempt to aggregate metadata in at least 2K blocks in the file.
Setting the value to <code>0</code> (zero) with this function
will turn off metadata aggregation, even if the VFL driver attempts
to use the metadata aggregation strategy.
<p>
Metadata aggregation reduces the number of small data objects
in the file that would otherwise be required for metadata.
The aggregated block of metadata is usually written in a
single write action and always in a contiguous block,
potentially significantly improving library and application
performance.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Minimum size, in bytes, of metadata block allocations.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetMetaBlockSize">H5Pget_meta_block_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_meta_block_size</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the current metadata block size setting.
<dt><strong>Description:</strong>
<dd><code>H5Pget_meta_block_size</code> returns the current
minimum size, in bytes, of new metadata block allocations.
This setting is retrieved from the file access property list
<code>fapl_id</code>.
<p>
This value is set by
<a href="#Property-SetMetaBlockSize">H5Pset_meta_block_size</a>
and is retrieved from the file access property list
<code>fapl_id</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>hsize_t *</em><code>size</code>
<dd>OUT: Minimum size, in bytes, of metadata block allocations.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_sieve_buf_size</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t</em> <code>size</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the maximum size of the data sieve buffer.
<dt><strong>Description:</strong>
<dd><code>H5Pset_sieve_buf_size</code> sets <code>size</code>,
the maximum size in bytes of the data sieve buffer, which is
used by file drivers that are capable of using data sieving.
<p>
The data sieve buffer is used when performing I/O on datasets
in the file. Using a buffer which is large anough to hold
several pieces of the dataset being read in for
hyperslab selections boosts performance by quite a bit.
<p>
The default value is set to 64KB, indicating that file I/O for
raw data reads and writes will occur in at least 64KB blocks.
Setting the value to 0 with this API function will turn off the
data sieving, even if the VFL driver attempts to use that strategy.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Maximum size, in bytes, of data sieve buffer.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetSieveBufSize">H5Pget_sieve_buf_size</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_sieve_buf_size</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>size</code>
)
<br>
<br>
<dt><strong>Purpose:</strong>
<dd> Returns maximum data sieve buffer size.
<dt><strong>Description:</strong>
<dd><code>H5Pget_sieve_buf_size</code> retrieves, <code>size</code>,
the current maximum size of the data sieve buffer.
<p>
This value is set by
<a href="#Property-SetSieveBufSize">H5Pset_sieve_buf_size</a>
and is retrieved from the file access property list
<code>fapl_id</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>hsize_t *</em><code>size</code>
<dd>IN: Maximum size, in bytes, of data sieve buffer.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetGCReferences">H5Pset_gc_references</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_gc_reference</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned</em> <code>gc_ref</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets garbage collecting references flag.
<dt><strong>Description:</strong>
<dd><code>H5Pset_gc_references</code> sets the flag for
garbage collecting references for the file.
<p>
Dataset region references and other reference types use space
in an HDF5 file's global heap. If garbage collection is on
and the user passes in an uninitialized value in a reference structure,
the heap might get corrupted. When garbage collection is off, however,
and the user re-uses a reference, the previous heap block will be
orphaned and not returned to the free heap space.
<p>
When garbage collection is on, the user must initialize the
reference structures to 0 or risk heap corruption.
<p>
The default value for garbage collecting references is off.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: File access property list identifier.
<dt><em>unsigned</em> <code>gc_ref</code>
<dd>IN: Flag setting reference garbage collection to
on (<code>1</code>) or off (<code>0</code>).
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_gc_references_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetGCReferences">H5Pget_gc_references</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_gc_references</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned</em> *<code>gc_ref</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns garbage collecting references setting.
<dt><strong>Description:</strong>
<dd><code>H5Pget_gc_references</code> returns the current setting
for the garbage collection references property from
the specified file access property list.
The garbage collection references property is set
by <a href="#Property-SetGCReferences">H5Pset_gc_references</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: File access property list identifier.
<dt><em>unsigned</em> <code>gc_ref</code>
<dd>OUT: Flag returning the state of reference garbage collection.
A returned value of <code>1</code> indicates that
garbage collection is on while
<code>0</code> indicates that garbage collection is off.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_gc_references_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetCache">H5Pset_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_cache</code>(<em>hid_t</em> <code>plist_id</code>,
<em>int</em> <code>mdc_nelmts</code>,
<em>int</em> <code>rdcc_nelmts</code>,
<em>size_t</em> <code>rdcc_nbytes</code>,
<em>double</em> <code>rdcc_w0</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the meta data cache and raw data chunk cache parameters.
<dt><strong>Description:</strong>
<dd><code>H5Pset_cache</code> sets
the number of elements (objects) in the meta data cache and
the number of elements, the total number of bytes, and
the preemption policy value in the raw data chunk cache.
<p>
The <em>plist_id</em> is a file access property list.
The number of elements (objects) in the meta data cache
and the raw data chunk cache are <em>mdc_nelmts</em> and
<em>rdcc_nelmts</em>, respectively.
The total size of the raw data chunk cache and the preemption policy
are <em>rdcc_nbytes</em> and <em>rdcc_w0</em>.
<p>
Any (or all) of the <code>H5Pget_cache()</code> pointer arguments
may be null pointers.
<p>
The <em>rdcc_w0</em> value should be between 0 and 1 inclusive and
indicates how much chunks that have been fully read are
favored for preemption. A value of zero means fully read
chunks are treated no differently than other chunks (the
preemption is strictly LRU) while a value of one means fully
read chunks are always preempted before other chunks.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Identifier of the file access property list.
<dt><em>int</em> <code>mdc_nelmts</code>
<dd>IN: Number of elements (objects) in the meta data cache.
<dt><em>int</em> <code>rdcc_nelmts</code>
<dd>IN: Number of elements (objects) in the raw data chunk cache.
<dt><em>size_t</em> <code>rdcc_nbytes</code>
<dd>IN: Total size of the raw data chunk cache, in bytes.
<dt><em>double</em> <code>rdcc_w0</code>
<dd>IN: Preemption policy.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_cache_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetCache">H5Pget_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_cache</code>(<em>hid_t</em> <code>plist_id</code>,
<em>int</em> <code>*mdc_nelmts</code>,
<em>int</em> <code>*rdcc_nelmts</code>,
<em>size_t</em> <code>*rdcc_nbytes</code>,
<em>double</em> <code>*rdcc_w0</code>
)
<dt><strong>Purpose:</strong>
<dd>Queries the meta data cache and raw data chunk cache parameters.
<dt><strong>Description:</strong>
<dd><code>H5Pget_cache</code> retrieves the maximum possible
number of elements in the meta
data cache and raw data chunk cache, the maximum possible number of
bytes in the raw data chunk cache, and the preemption policy value.
<p>
Any (or all) arguments may be null pointers, in which case the
corresponding datum is not returned.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: Identifier of the file access property list.
<dt><em>int</em> <code>*mdc_nelmts</code>
<dd>IN/OUT: Number of elements (objects) in the meta data cache.
<dt><em>int</em> <code>*rdcc_nelmts</code>
<dd>IN/OUT: Number of elements (objects) in the raw data chunk cache.
<dt><em>size_t</em> <code>*rdcc_nbytes</code>
<dd>IN/OUT: Total size of the raw data chunk cache, in bytes.
<dt><em>double</em> <code>*rdcc_w0</code>
<dd>IN/OUT: Preemption policy.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_cache_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetHyperCache">H5Pset_hyper_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned</em> <code>cache</code>,
<em>unsigned</em> <code>limit</code>
)
<dt><strong>Purpose:</strong>
<dd>Indicates whether to cache hyperslab blocks during I/O.
<dt><strong>Description:</strong>
<dd>Given a dataset transfer property list, <code>H5Pset_hyper_cache</code>
indicates whether to cache hyperslab blocks during I/O,
a process which can significantly increase I/O speeds.
<p>
When working with hyperslab selections, it is possible to
significantly speed up I/O operations by retrieving an
entire hyperslab from the file in one operation and
caching it in memory.
The <code>cache</code> parameter specifies whether to turn
caching on for hyperslab I/O operations.
If <code>cache</code> is set to <code>1</code>,
caching is turned on;
if set to <code>0</code>, caching is turned off.
<p>
The parameter <code>limit</code> sets the maximum size of the
hyperslab block to cache. If a block is smaller than that limit,
it may still not be cached if no memory is available.
Setting <code>limit</code> to <code>0</code> (zero) indicates
no limitation on the size of block to attempt to cache.
<p>
The default is to cache blocks with no limit on block size
for serial I/O and to not cache blocks for parallel I/O.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Dataset transfer property list identifier.
<dt><em>unsigned</em> <code>cache</code>
<dd>IN: A flag indicating whether caching is to be
set to on (<code>1</code>) or off (<code>0</code>).
<dt><em>unsigned</em> <code>limit</code>
<dd>IN: Maximum size of the hyperslab block to cache.
<code>0</code> (zero) indicates no limit.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_hyper_cache_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetHyperCache">H5Pget_hyper_cache</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_hyper_cache</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned</em> *<code>cache</code>,
<em>unsigned</em> *<code>limit</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information regarding the caching of hyperslab blocks during I/O.
<dt><strong>Description:</strong>
<dd>Given a dataset transfer property list, <code>H5Pget_hyper_cache</code>
returns instructions regarding the caching of hyperslab blocks during I/O.
These parameters are set with the <code>H5Pset_hyper_cache</code> function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Dataset transfer property list identifier.
<dt><em>unsigned</em> *<code>cache</code>
<dd>OUT: A flag indicating whether caching is
set to on (<code>1</code>) or off (<code>0</code>).
<dt><em>unsigned</em> *<code>limit</code>
<dd>OUT: Maximum size of the hyperslab block to cache.
<code>0</code> (zero) indicates no limit.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_hyper_cache_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetBTreeRatios">H5Pset_btree_ratios</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_btree_ratios</code>(<em>hid_t</em> <code>plist</code>,
<em>double</em> <code>left</code>,
<em>double</em> <code>middle</code>,
<em>double</em> <code>right</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets B-tree split ratios for a dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pset_btree_ratios</code> sets the B-tree split ratios
for a dataset transfer property list. The split ratios determine
what percent of children go in the first node when a node splits.
<p>
The ratio <code>left</code> is used when the splitting node is
the left-most node at its level in the tree;
the ratio <code>right</code> is used when the splitting node is
the right-most node at its level;
and the ratio <code>middle</code> is used for all other cases.
<p>
A node which is the only node at its level in the tree uses
the ratio <code>right</code> when it splits.
<p>
All ratios are real numbers between 0 and 1, inclusive.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: The dataset transfer property list identifier.
<dt><em>double</em> <code>left</code>
<dd>IN: The B-tree split ratio for left-most nodes.
<dt><em>double</em> <code>right</code>
<dd>IN: The B-tree split ratio for right-most nodes and lone nodes.
<dt><em>double</em> <code>middle</code>
<dd>IN: The B-tree split ratio for all other nodes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_btree_ratios_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetBTreeRatios">H5Pget_btree_ratios</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_btree_ratios</code>(<em>hid_t</em> <code>plist</code>,
<em>double</em> *<code>left</code>,
<em>double</em> *<code>middle</code>,
<em>double</em> *<code>right</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets B-tree split ratios for a dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_btree_ratios</code> returns the B-tree split ratios
for a dataset transfer property list.
<p>
The B-tree split ratios are returned through the non-<code>NULL</code>
arguments <code>left</code>, <code>middle</code>, and <code>right</code>,
as set by the <a href="#Property-SetBTreeRatios">H5Pset_btree_ratios</a> function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: The dataset transfer property list identifier.
<dt><em>double</em> <code>left</code>
<dd>OUT: The B-tree split ratio for left-most nodes.
<dt><em>double</em> <code>right</code>
<dd>OUT: The B-tree split ratio for right-most nodes and lone nodes.
<dt><em>double</em> <code>middle</code>
<dd>OUT: The B-tree split ratio for all other nodes.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pget_btree_ratios_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetBuffer">H5Pset_buffer</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_buffer</code>(<em>hid_t</em> <code>plist</code>,
<em>hsize_t</em> <code>size</code>,
<em>void</em> <code>*tconv</code>,
<em>void</em> <code>*bkg</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets type conversion and background buffers.
<dt><strong>Description:</strong>
<dd> Given a dataset transfer property list, <code>H5Pset_buffer</code>
sets the maximum size
for the type conversion buffer and background buffer and
optionally supplies pointers to application-allocated buffers.
If the buffer size is smaller than the entire amount of data
being transferred between the application and the file, and a type
conversion buffer or background buffer is required, then
strip mining will be used.
<p>
Note that there are minimum size requirements for the buffer.
Strip mining can only break the data up along the first dimension,
so the buffer must be large enough to accommodate a complete slice
that encompasses all of the remaining dimensions.
For example, when strip mining a 100x200x300 hyperslab
of a simple data space, the buffer must be large enough to
hold 1x200x300 data elements.
When strip mining a 100x200x300x150 hyperslab of a simple data space,
the buffer must be large enough to hold 1x200x300x150 data elements.
<p>
If <code>tconv</code> and/or <code>bkg</code> are null pointers,
then buffers will be allocated and freed during the data transfer.
<p>
The default value for the maximum buffer is 1 Mb.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>hsize_t</em> <code>size</code>
<dd>IN: Size, in bytes, of the type conversion and background buffers.
<dt><em>void</em> <code>tconv</code>
<dd>IN: Pointer to application-allocated type conversion buffer.
<dt><em>void</em> <code>bkg</code>
<dd>IN: Pointer to application-allocated background buffer.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetBuffer">H5Pget_buffer</a>
<dt><strong>Signature:</strong>
<dd><em>hsize_t</em> <code>H5Pget_buffer</code>(<em>hid_t</em> <code>plist</code>,
<em>void</em> <code>**tconv</code>,
<em>void</em> <code>**bkg</code>
)
<dt><strong>Purpose:</strong>
<dd>Reads buffer settings.
<dt><strong>Description:</strong>
<dd><code>H5Pget_buffer</code> reads values previously set
with H5Pset_buffer().
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>void</em> <code>**tconv</code>
<dd>OUT: Address of the pointer to application-allocated
type conversion buffer.
<dt><em>void</em> <code>**bkg</code>
<dd>OUT: Address of the pointer to application-allocated
background buffer.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns buffer size, in bytes, if successful;
otherwise 0 on failure.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetPreserve">H5Pset_preserve</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_preserve</code>(<em>hid_t</em> <code>plist</code>,
<em>hbool_t</em> <code>status</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the dataset transfer property list status to TRUE or FALSE.
<dt><strong>Description:</strong>
<dd><code>H5Pset_preserve</code> sets the
dataset transfer property list status to TRUE or FALSE.
<p>
When reading or writing compound data types and the
destination is partially initialized and the read/write is
intended to initialize the other members, one must set this
property to TRUE. Otherwise the I/O pipeline treats the
destination datapoints as completely uninitialized.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>hbool_t</em> <code>status</code>
<dd>IN: Status of for the dataset transfer property list
(TRUE/FALSE).
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetPreserve">H5Pget_preserve</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_preserve</code>(<em>hid_t</em> <code>plist</code>)
<dt><strong>Purpose:</strong>
<dd>Checks status of the dataset transfer property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_preserve</code> checks the status of the
dataset transfer property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns TRUE or FALSE if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!--
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetCompression">H5Pset_compression</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_compression</code>(<em>hid_t</em> <code>plist</code>,
<em>H5Z_method_t</em> <code>method</code>,
<em>unsigned int</em> <code>flags</code>,
<em>size_t</em> <code>cd_size</code>,
<em>const void</em> <code>*client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets compression method.
<dt><strong>Description:</strong>
<dd><code>H5Pset_compression</code> sets the compression method
in a dataset creation property list. This is a catch-all
function for defining compression methods
and is intended to be called from a wrapper such as
<code>H5Pset_deflate()</code>. The dataset creation property
list <em>plist</em> is adjusted to use the specified
compression method. The <em>flags</em> is an 8-bit vector
which is stored in the file as part of the compression message
and passed to the compress and uncompress functions. The
<em>client_data</em> is a byte array of length
<em>cd_size</em> which is copied to the file and passed to the
compress and uncompress methods.
<p>
The FLAGS, CD_SIZE, and CLIENT_DATA are copied to the
property list and eventually to the file and passed to the
compression functions.
<p>
See <a href="Datasets.html"><cite>The Dataset Interface (H5D)</cite></a>
in the <cite>HDF5 User's Guide</cite> for further information
regarding data compression.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>H5Z_method_t</em> <code>method</code>
<dd>IN: Compression method, an integer from 16 to 225.
<dt><em>unsigned int</em> <code>flags</code>
<dd>IN: Compression flags.
<dt><em>size_t</em> <code>cd_size</code>
<dd>IN: Size of the byte array <code>client_data</code>.
<dt><em>const void</em> <code>*client_data</code>
<dd>IN: Client data byte array passed to the compression method.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
</dl>
-->
<!--
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetCompression">H5Pget_compression</a>
<dt><strong>Signature:</strong>
<dd><em>H5Z_method_t</em> <code>H5Pget_compression</code>(<em>hid_t</em> <code>plist</code>,
<em>unsigned int</em> <code>*flags</code>,
<em>size_t</em> <code>*cd_size</code>,
<em>void</em> <code>*client_data</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets compression method.
<dt><strong>Description:</strong>
<dd><code>H5Pget_compression</code> gets the compression method
information from a dataset creation property list.
The <code>client_data</code> buffer is initially
<code>cd_size</code> bytes. On return, <code>client_data</code>
will be initialized with at most that many bytes, and
<code>cd_size</code> will contain the actual size of the
client data, which might be larger than its original value.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>unsigned int</em> <code>*flags</code>
<dd>OUT: Compression flags.
<dt><em>size_t</em> <code>*cd_size</code>
<dd>IN/OUT: Size of the <code>client_data</code> array.
<dt><em>void</em> <code>*client_data</code>
<dd>OUT: Byte array for the client data.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns compression method if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
</dl>
-->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetDeflate">H5Pset_deflate</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_deflate</code>(<em>hid_t</em> <code>plist</code>,
<em>int</em> <code>level</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets compression method and compression level.
<dt><strong>Description:</strong>
<dd><code>H5Pset_deflate</code> sets the compression method for a
dataset creation property list to <code>H5D_COMPRESS_DEFLATE</code>
and the compression level to <code>level</code>, which should
be a value from zero to nine, inclusive.
Lower compression levels are faster but result in less compression.
This is the same algorithm as used by the GNU gzip program.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
<dt><em>int</em> <code>level</code>
<dd>IN: Compression level.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pset_deflate_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!--
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDeflate">H5Pget_deflate</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Pget_deflate</code>(<em>hid_t</em> <code>plist</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the deflate compression level from a dataset creation
property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_deflate</code> returns the deflate compression level
from a dataset creation property list that uses that method.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset creation property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns compression level, a value between 0 and 9, if successful.
Otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
</dl>
-->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetVLMemManager">H5Pset_vlen_mem_manager</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>,
<em>H5MM_allocate_t</em> <code>alloc</code>,
<em>void</em> *<code>alloc_info</code>,
<em>H5MM_free_t</em> <code>free</code>,
<em>void</em> *<code>free_info</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the memory manager for variable-length datatype allocation in
<code>H5Dread</code> and <code>H5Dvlen_reclaim</code>.
<dt><strong>Description:</strong>
<dd><code>H5Pset_vlen_mem_manager</code> sets the memory manager for
variable-length datatype allocation in <code>H5Dread</code>
and free in <code>H5Dvlen_reclaim</code>.
<p>
The <code>alloc</code> and <code>free</code> parameters
identify the memory management routines to be used.
If the user has defined custom memory management routines,
<code>alloc</code> and/or <code>free</code> should be set to make
those routine calls (i.e., the name of the routine is used as
the value of the parameter);
if the user prefers to use the system's <code> malloc</code>
and/or <code>free</code>, the <code>alloc</code> and
<code>free</code> parameters, respectively, should be set to
<code> NULL</code>
<p>
The prototypes for these user-defined functions would appear as follows:
<br>
<em>typedef void</em> *(*<code>H5MM_allocate_t</code>)(<em>size_t</em> <code>size</code>,
<em>void</em> *<code>alloc_info</code>) ;
<br>
<em>typedef void</em> (*<code>H5MM_free_t</code>)(<em>void</em> *<code>mem</code>,
<em>void</em> *<code>free_info</code>) ;
<br>
The <code>alloc_info</code> and <code>free_info</code> parameters
can be used to pass along any required information to
the user's memory management routines.
<p>
In summary, if the user has defined custom memory management
routines, the name(s) of the routines are passed in the
<code>alloc</code> and <code>free</code> parameters and the
custom routines' parameters are passed in the
<code>alloc_info</code> and <code>free_info</code> parameters.
If the user wishes to use the system <code> malloc</code> and
<code>free</code> functions, the <code>alloc</code> and/or
<code>free</code> parameters are set to <code> NULL</code>
and the <code>alloc_info</code> and <code>free_info</code>
parameters are ignored.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>H5MM_allocate_t</em> <code>alloc</code>
<dd>IN: User's allocate routine, or <code> NULL</code>
for system <code> malloc</code>.
<dt><em>void</em> *<code>alloc_info</code>
<dd>IN: Extra parameter for user's allocation routine.
<br>
Contents are ignored if preceding parameter is
<code> NULL</code>.
<dt><em>H5MM_free_t</em> <code>free</code>
<dd>IN: User's free routine, or <code> NULL</code>
for system <code>free</code>.
<dt><em>void</em> *<code>free_info</code>
<dd>IN: Extra parameter for user's free routine.
<br>
Contents are ignored if preceding parameter is
<code> NULL</code>.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetVLMemManager">H5Pget_vlen_mem_manager</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_vlen_mem_manager</code>(<em>hid_t</em> <code>plist</code>,
<em>H5MM_allocate_t</em> *<code>alloc</code>,
<em>void</em> **<code>alloc_info</code>,
<em>H5MM_free_t</em> *<code>free</code>,
<em>void</em> **<code>free_info</code>
)
<dt><strong>Purpose:</strong>
<dd>Gets the memory manager for variable-length datatype allocation in
<code>H5Dread</code> and <code>H5Dvlen_reclaim</code>.
<dt><strong>Description:</strong>
<dd><code>H5Pget_vlen_mem_manager</code> is the companion function to
<code>H5Pset_vlen_mem_manager</code>, returning the parameters
set by that function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist</code>
<dd>IN: Identifier for the dataset transfer property list.
<dt><em>H5MM_allocate_t</em> <code>alloc</code>
<dd>OUT: User's allocate routine, or <code> NULL</code>
for system <code> malloc</code>.
<dt><em>void</em> *<code>alloc_info</code>
<dd>OUT: Extra parameter for user's allocation routine.
<br>
Contents are ignored if preceding parameter is
<code> NULL</code>.
<dt><em>H5MM_free_t</em> <code>free</code>
<dd>OUT: User's free routine, or <code> NULL</code> for
system <code>free</code>.
<dt><em>void</em> *<code>free_info</code>
<dd>OUT: Extra parameter for user's free routine.
<br>
Contents are ignored if preceding parameter is
<code> NULL</code>.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful;
otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
--> <!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- -->
<!-- The new *fapl* functions with R1.4 -->
<!-- -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplFamily">H5Pset_fapl_family</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_family</code> (
<em>hid_t</em> <code>fapl_id</code>,
<em> hsize_t</em> <code>memb_size</code>,
<em>hid_t</em> <code>memb_fapl_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the file access property list to use the family driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_family</code> sets the file access property list
identifier, <code>fapl_id</code>, to use the family driver.
<p>
<code>memb_size</code> is the size in bytes of each file member
and is used only when creating a new file.
<p>
<code>memb_fapl_id</code> is the identifier of the
file access property list to be used for each family member.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em> hsize_t</em> <code>memb_size</code>
<dd>IN: Size in bytes of each file member.
<dt><em>hid_t</em> <code>memb_fapl_id</code>
<dd>IN: Identifier of file access property list for each
family member.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplFamily">H5Pget_fapl_family</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_family</code> (
<em>hid_t</em> <code>fapl_id</code>,
<em>hsize_t *</em><code>memb_size</code>,
<em>hid_t *</em><code>memb_fapl_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns file access property list information.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fapl_family</code> returns file access property list
for use with the family driver.
This information is returned through the output parameters.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em> hsize_t *</em><code>memb_size</code>
<dd>OUT: Size in bytes of each file member.
<dt><em>hid_t *</em><code>memb_fapl_id</code>
<dd>OUT: Identifier of file access property list for each
family member.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplLog">H5Pset_fapl_log</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_log</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>char *</em><code>logfile</code>,
<em>int</em> <code>verbosity</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets up the use of the logging driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_log</code> modifies the
file access property list to use the logging driver
<code>H5FD_LOG</code>.
There are no driver-specific properties.
<p>
<code>logfile</code> is the name of the file in which the
logging entries are to be recorded.
<p>
<code>verbosity</code> indicates the extent of the logging
activity intended. Valid values are as follows:
<center>
<table width=75%>
<tr valign=top align=left><td>
<code>0</code>
</td><td>
Performs no logging.
</td></tr>
<tr valign=top align=left><td>
<code>1</code>
</td><td>
Records where writes and reads occur in the file.
</td></tr>
<tr valign=top align=left><td>
<code>2</code>
</td><td>
Records where writes and reads occur in the file and what
kind of data is written at each location: raw data or any of
several types of metadata (object headers, superblock,
B-tree data, local headers, or global headers).
</td></tr>
</table>
</center>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>char *</em><code>logfile</code>
<dd>IN: Name of the log file.
<dt><em>int</em> <code>verbosity</code>
<dd>IN: The extent of logging activity intended.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns non-negative if successful.
Otherwise returns negative.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplMpio">H5Pset_fapl_mpio</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_mpio</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm</em> <code>comm</code>,
<em>MPI_Info</em> <code>info</code>
)
<dt><strong>Purpose:</strong>
<dd>Stores MPI IO communicator information to the file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_mpio</code> stores the user-supplied
MPI IO parameters <code>comm</code>, for communicator, and
<code>info</code>, for information, in
the file access property list <code>fapl_id</code>.
That property list can then be used to create and/or open the file.
<p>
<code>H5Pset_fapl_mpio</code> is available only in the
parallel HDF5 library and is not a collective function.
<p>
<code>comm</code> is the MPI communicator to be used for
file open as defined in <code>MPI_FILE_OPEN</code> of MPI-2.
This function does not create a duplicated communicator.
Modifications to <code>comm</code> after this function call
returns may have an undetermined effect on the access property list.
Users should not modify the communicator while it is defined
in a property list.
<p>
<code>info</code> is the MPI info object to be used for
file open as defined in <code>MPI_FILE_OPEN</code> of MPI-2.
This function does not create a duplicated info object.
Any modification to the info object after this function call
returns may have an undetermined effect on the access property list.
Users should not modify the info while it is defined
in a property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>MPI_Comm</em> <code>comm</code>
<dd>IN: MPI-2 communicator.
<dt><em>MPI_Info</em> <code>info</code>
<dd>IN: MPI-2 info object.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplMpio">H5Pget_fapl_mpio</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_mpio</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>MPI_Comm *</em><code>comm</code>,
<em>MPI_Info *</em><code>info</code>
)
<dt><strong>Purpose:</strong>
<dd> Returns MPI communicator information.
<dt><strong>Description:</strong>
<dd>If the file access property list is set to the <code>H5FD_MPIO</code>
driver, <code>H5Pget_fapl_mpio</code> returns the MPI communicator and
information through the <code>comm</code> and <code>info</code>
pointers, if those values are non-null.
<p>
Neither <code>comm</code> nor <code>info</code> is copied,
so they are valid only until the file access property list
is either modified or closed.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>MPI_Comm *</em><code>comm</code>
<dd>OUT: MPI-2 communicator.
<dt><em>MPI_Info *</em><code>info</code>
<dd>OUT: MPI-2 info object.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetDxplMpio">H5Pset_dxpl_mpio</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_dxpl_mpio</code>(
<em>hid_t</em> <code>dxpl_id</code>,
<em>H5FD_mpio_xfer_t</em> <code>xfer_mode</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets data transfer mode.
<dt><strong>Description:</strong>
<dd><code>H5Pset_dxpl_mpio</code> sets the data transfer property list
<code>dxpl_id</code> to use transfer mode <code>xfer_mode</code>.
The property list can then be used to control the I/O transfer mode
during data I/O operations.
<p>
Valid transfer modes are as follows:
<dir>
<dl>
<dt><code>H5FD_MPIO_INDEPENDENT</code>
<dd>Use independent I/O access (default).
<dt><code>H5FD_MPIO_COLLECTIVE</code>
<dd>Use collective I/O access.
</dl>
</dir>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dxpl_id</code>
<dd>IN: Data transfer property list identifier.
<dt><em>H5FD_mpio_xfer_t</em> <code>xfer_mode</code>
<dd>IN: Transfer mode.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDxplMpio">H5Pget_dxpl_mpio</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_dxpl_mpio</code>(
<em>hid_t</em> <code>dxpl_id</code>,
<em>H5FD_mpio_xfer_t *</em><code>xfer_mode</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the data transfer mode.
<dt><strong>Description:</strong>
<dd><code>H5Pget_dxpl_mpio</code> queries the data transfer mode
currently set in the data transfer property list <code>dxpl_id</code>.
<p>
Upon return, <code>xfer_mode</code> contains the data transfer mode,
if it is non-null.
<p>
<code>H5Pget_dxpl_mpio</code> is not a collective function.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dxpl_id</code>
<dd>IN: Data transfer property list identifier.
<dt><em>H5FD_mpio_xfer_t *</em><code>xfer_mode</code>
<dd>OUT: Data transfer mode.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplMulti">H5Pset_fapl_multi</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_multi</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>const H5FD_mem_t *</em><code>memb_map</code>,
<em>const hid_t *</em><code>memb_fapl</code>,
<em>const char **</em><code>memb_name</code>,
<em>const haddr_t *</em><code>memb_addr</code>,
<em>hbool_t</em> <code>relax</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets up use of the multi-file driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_multi</code> sets the file access property list
<code>fapl_id</code> to use the multi-file driver.
<p>
The multi-file driver enables different types of HDF5 data and
metadata to be written to separate files. These files are viewed
by the HDF5 library and the application as a single virtual HDF5 file
with a single HDF5 file address space.
The types of data that can be broken out into separate file include
raw data, the superblock, B-tree data, global heap data,
local heap data, and object headers.
At the programmer's discretion, two or more types of data can be
written the same file while other types of data are written to
separate files.
<p>
The array <code>memb_map</code> maps memory usage types to other
memory usage types and is the mechanism that allows the caller
to specify how many files are created.
The array contains <code>H5FD_MEM_NTYPES</code> entries,
which are either the value <code>H5FD_MEM_DEFAULT</code>
or a memory usage type.
The number of unique values determines the number of files
that are opened.
<p>
The array <code>memb_fapl</code> contains a property list
for each memory usage type that will be associated with a file.
<p>
The array <code>memb_name</code> should be a name generator
(a printf-style format with a %s which will be replaced with the
name passed to <code>H5FDopen()</code>, usually from
<code>H5Fcreate()</code> or <code>H5Fopen()</code>).
<p>
The array <code>memb_addr</code> specifies the offsets within the
virtual address space, from <code>0</code> (zero) to
<code>HADDR_MAX</code>, at wihch each type of data storage begins.
<p>
If <code>relax</code> is set to <code>TRUE</code> (or <code>1</code>),
then opening an existing file for read-only access will not fail
if some file members are missing.
This allows a file to be accessed in a limited sense if just the
meta data is available.
<p>
Default values for each of the optional arguments are as follows:
<dir>
<dl>
<dt><code>memb_map</code>
<dd>The default member map contains the value
<code>H5FD_MEM_DEFAULT</code> for each element.
<dt><code>memb_fapl</code>
<dd>The default value is <code>H5P_DEFAULT</code> for each element.
<dt><code>memb_name</code>
<dd>The default string is <code>%s-<i>X</i>.h5</code>
where <code><i>X</i></code> is one of the
following letters:
<dir>
<code>s</code> for <code>H5FD_MEM_SUPER</code>
<br>
<code>b</code> for <code>H5FD_MEM_BTREE</code>
<br>
<code>r</code> for <code>H5FD_MEM_DRAW</code>
<br>
<code>g</code> for <code>H5FD_MEM_GHEAP</code>
<br>
<code>l</code> for <code>H5FD_MEM_LHEAP</code>
<br>
<code>o</code> for <code>H5FD_MEM_OHDR</code>
</dir>
<dt><code>memb_addr</code>
<dd>The default value is <code>HADDR_UNDEF</code> for each element.
</dl>
</dir>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>const H5FD_mem_t *</em><code>memb_map</code>
<dd>IN: Maps memory usage types to other memory usage types.
<dt><em>const hid_t *</em><code>memb_fapl</code>
<dd>IN: Property list for each memory usage type.
<dt><em>const char **</em><code>memb_name</code>
<dd>IN: Name generator for names of member files.
<dt><em>const haddr_t *</em><code>memb_addr</code>
<dd>IN: The offsets within the virtual address space,
from <code>0</code> (zero) to <code>HADDR_MAX</code>,
at wihch each type of data storage begins.
<dt><em>hbool_t</em> <code>relax</code>
<dd>IN: Allows read-only access to incomplete file sets
when <code>TRUE</code>.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<dt><strong>Example:</strong>
<dd>The following code sample sets up a multi-file access property list
that partitions data into meta and raw files, each being
one-half of the address:
<pre>
H5FD_mem_t mt, memb_map[H5FD_MEM_NTYPES];
hid_t memb_fapl[H5FD_MEM_NTYPES];
const char *memb[H5FD_MEM_NTYPES];
haddr_t memb_addr[H5FD_MEM_NTYPES];
// The mapping...
for (mt=0; mt<H5FD_MEM_NTYPES; mt++) {
memb_map[mt] = H5FD_MEM_SUPER;
}
memb_map[H5FD_MEM_DRAW] = H5FD_MEM_DRAW;
// Member information
memb_fapl[H5FD_MEM_SUPER] = H5P_DEFAULT;
memb_name[H5FD_MEM_SUPER] = "%s.meta";
memb_addr[H5FD_MEM_SUPER] = 0;
memb_fapl[H5FD_MEM_DRAW] = H5P_DEFAULT;
memb_name[H5FD_MEM_DRAW] = "%s.raw";
memb_addr[H5FD_MEM_DRAW] = HADDR_MAX/2;
hid_t fapl = H5Pcreate(H5P_FILE_ACCESS);
H5Pset_fapl_multi(fapl, memb_map, memb_fapl,
memb_name, memb_addr, TRUE);
</pre>
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplMulti">H5Pget_fapl_multi</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_multi</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>const H5FD_mem_t *</em><code>memb_map</code>,
<em>const hid_t *</em><code>memb_fapl</code>,
<em>const char **</em><code>memb_name</code>,
<em>const haddr_t *</em><code>memb_addr</code>,
<em>hbool_t *</em><code>relax</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns information about the multi-file access property list.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fapl_multi</code> returns information about the
multi-file access property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>const H5FD_mem_t *</em><code>memb_map</code>
<dd>OUT: Maps memory usage types to other memory usage types.
<dt><em>const hid_t *</em><code>memb_fapl</code>
<dd>OUT: Property list for each memory usage type.
<dt><em>const char **</em><code>memb_name</code>
<dd>OUT: Name generator for names of member files.
<dt><em>const haddr_t *</em><code>memb_addr</code>
<dd>OUT:
<dt><em>hbool_t *</em><code>relax</code>
<dd>OUT: Allows read-only access to incomplete file sets
when <code>TRUE</code>.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetDxplMulti">H5Pset_dxpl_multi</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_dxpl_multi</code>(
<em>hid_t</em> <code>dxpl_id</code>,
<em>const hid_t *</em><code>memb_dxpl</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the data transfer property list for the multi-file driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_dxpl_multi</code> sets the data transfer property list
<code>dxpl_id</code> to use the multi-file driver for each
memory usage type <code>memb_dxpl[]</code>.
<p>
<code>H5Pset_dxpl_multi</code> can only be used after
the member map has been set with <code>H5Pset_fapl_multi</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dxpl_id</code>,
<dd>IN: Data transfer property list identifier.
<dt><em>const hid_t *</em><code>memb_dxpl</code>
<dd>IN: Array of data access property lists.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDxplMulti">H5Pget_dxpl_multi</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_dxpl_multi</code>(
<em>hid_t</em> <code>dxpl_id</code>,
<em>const hid_t *</em><code>memb_dxpl</code>
)
<br>
<br>
<dt><strong>Purpose:</strong>
<dd>Returns multi-file data transfer property list information.
<dt><strong>Description:</strong>
<dd><code>H5Pget_dxpl_multi</code> returns the data transfer property list
information for the multi-file driver.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>dxpl_id</code>,
<dd>IN: Data transfer property list identifier.
<dt><em>const hid_t *</em><code>memb_dxpl</code>
<dd>OUT: Array of data access property lists.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplSplit">H5Pset_fapl_split</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_split</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>const char *</em><code>meta_ext</code>,
<em>hid_t</em> <code>meta_plist_id</code>,
<em>const char *</em><code>raw_ext</code>,
<em>hid_t</em> <code>raw_plist_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Emulates the old split file driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_split</code> is a compatability function that
enables the multi-file driver to emulate the split driver from
HDF5 Releases 1.0 and 1.2.
The split file driver stored metadata and raw data in separate files
but provide no mechanism for separating types of metadata.
<p>
<code>fapl_id</code> is a file access property list identifier.
<p>
<code>meta_ext</code> is the filename extension for the metadata file.
<p>
<code>meta_plist_id</code> is the file access property list identifier
for the metadata file.
<p>
<code>raw_ext</code> is the filename extension for the raw data file.
<p>
<code>raw_plist_id</code> is the file access property list identifier
for the raw data file.
<dt><strong>Parameters:</strong>
<dl>
<dt>
<dt><em>hid_t</em> <code>fapl_id</code>,
<dd>IN: File access property list identifier.
<dt><em>const char *</em><code>meta_ext</code>,
<dd>IN: Metadata filename extension.
<dt><em>hid_t</em> <code>meta_plist_id</code>,
<dd>IN: File access property list identifier for the metadata file.
<dt><em>const char *</em><code>raw_ext</code>,
<dd>IN: Raw data filename extension.
<dt><em>hid_t</em> <code>raw_plist_id</code>
<dd>IN: File access property list identifier for the raw data file.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplSec2">H5Pset_fapl_sec2</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_sec2</code>(
<em>hid_t</em> <code>fapl_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the sec2 driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_sec2</code> modifies the file access property list
to use the <code>H5FD_SEC2</code> driver.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplStdio">H5Pset_fapl_stdio</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_stdio</code>(
<em>hid_t</em> <code>fapl_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the standard I/O driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_stdio</code> modifies the file access property list
to use the standard I/O driver, <code>H5FD_STDIO</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplStream">H5Pset_fapl_stream</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_stream</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_stream_fapl_t *</em><code>fapl</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets up the use of the streaming I/O driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_stream</code> sets up the use of the
streaming I/O driver.
<p>
<code>fapl_id</code> is the identifier for the
file access property list currently in use.
<p>
<code>fapl</code> is ...
<p>
The <code>H5FD_stream_fapl_t</code> struct contains the following
elements:
<dir>
<table border=0>
<tr align=left>
<td><em>size_t</em></td>
<td><code>increment</code></td></tr>
<tr align=left>
<td><em><font size=-1>H5FD_STREAM_SOCKET_TYPE</font></em></td>
<td><code>socket</code></td></tr>
<tr align=left>
<td><em>hbool_t</em></td>
<td><code>do_socket_io</code></td></tr>
<tr align=left>
<td><em>unsigned int</em></td>
<td><code>backlog</code></td></tr>
<tr align=left>
<td><em><font size=-1>H5FD</font>_stream_broadcast_t</em></td>
<td><code>broadcast_fn</code></td></tr>
<tr align=left>
<td><em>void *</em></td>
<td><code>broadcast_arg</code></td></tr>
</table>
<ul>
<li><code>increment</code> specifies how much memory to allocate
each time additional memory is required.
<li><code>socket</code> is an external socket descriptor;
if a valid socket argument is provided, that socket will be used.
<li><code>do_socket_io</code> is a boolean value specifying whether
to perform I/O on <code>socket</code>.
<li><code>backlog</code> is the argument for the
<code>listen</code> call.
<li><code>broadcast_fn</code> is the broadcast callback function.
<li><code>broadcast_arg</code> is the user argument to
the broadcast callback function.
</ul>
</dir>
<p>
<code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code>
are not intended for use in a parallel environment.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>H5FD_stream_fapl_t *</em><code>fapl</code>
<dd>IN: The streaming I/O file access property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplStream">H5Pget_fapl_stream</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_stream</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>H5FD_stream_fapl_t *</em><code>fapl</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns the streaming I/O driver settings.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fapl_stream</code> returns the file access properties
set for the use of the streaming I/O driver.
<p>
<code>H5Pset_fapl_stream</code> and <code>H5Pget_fapl_stream</code>
are not intended for use in a parallel environment.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>H5FD_stream_fapl_t *</em><code>fapl</code>
<dd>OUT: The streaming I/O file access property list.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- ********** MOVED TO TechNotes/VFLfunc.html **********
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetDriver">H5Pset_driver</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_driver</code>(
<em>hid_t</em> <code>plist_id</code>,
<em>hid_t</em> <code>driver_id</code>,
<em>const void *</em> <code>driver_info</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets the file driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_driver</code> sets the file driver,
<code>driver_id</code>, for a file access or data transfer
property list, <code>plist_id</code>, and supplies an
optional struct containing the driver-specific properites,
<code>driver_info</code>.
<p>
<font color=red><b><i>Need <code>driver_info</code> struct definition.</i></b></font>
<p>
The driver properties will be copied into the property list
and the reference count on the driver will be incremented,
allowing the caller to close the driver identifier but still use
the property list.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: File access or data transfer property list identifier.
<dt><em>hid_t</em> <code>driver_id</code>
<dd>IN: Driver indentifier.
<dt><em>const void *</em> <code>driver_info</code>
<dd>IN: Optional struct containing driver properties.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
</dl>
-->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDriver">H5Pget_driver</a>
<dt><strong>Signature:</strong>
<dd><em>hid_t</em> <code>H5Pget_driver</code>(
<em>hid_t</em> <code>plist_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns low-lever driver identifier.
<dt><strong>Description:</strong>
<dd><code>H5Pget_driver</code> returns the identifier of the
low-level file driver associated with the file access property list
or data transfer propert list <code>plist_id</code>.
<p>
The returned driver identifier is only valid as long as the
file driver remains registered.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: File access or data transfer property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a vaild low-level driver identifier if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- ********** MOVED TO TechNotes/VFLfunc.html **********
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetDriverInfo">H5Pget_driver_info</a>
<dt><strong>Signature:</strong>
<dd><em>void *</em><code>H5Pget_driver_info</code>(
<em>hid_t</em> <code>plist_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Returns a pointer to file driver information.
<dt><strong>Description:</strong>
<dd><code>H5Pget_driver_info</code> returns a pointer to
file driver-specific information for the low-level driver
associated with the file access or data transfer property list
<code>plist_id</code>.
<p>
<font color=red><b><i>Need more on "a pointer" or on what
is "pointed to." Might this be the <code>driver_info</code>
struct definition in <code>H5Pset_driver</code>?</i></b></font>
<p>
If no driver-specific properties have been registered,
<code>H5Pget_driver_info</code> returns <code>NULL</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>plist_id</code>
<dd>IN: File access or data transfer property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a pointer to the struct containing
low-level driver information.
Otherwise returns <code>NULL</code>.
<p>
<code>NULL</code> is also returned if no driver-specific properties
have been registered.
No error is pushed on the stack in this case.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
</dl>
-->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplGass">H5Pset_fapl_gass</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_gass</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>GASS_Info</em> <code>info</code>
)
<dt><strong>Purpose:</strong>
<dd>Stores user-supplied GASS information.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_gass</code> stores user-supplied GASS information,
the <em>GASS_Info</em> struct data as passed in <code>info</code>,
to the file access property list <code>fapl_id</code>.
<code>fapl_id</code> can then be used to create and/or open the file.
<p>
The <em>GASS_Info</em> object, <code>info</code>, is used for
file open operations when using GASS in the Globus environment.
<p>
Any modification to <code>info</code> after this function call
returns may have undetermined effect to the access property list.
Users must call <code>H5Pset_fapl_gass</code> again to setup
the property list.
<dt><strong>Note:</strong>
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
It is designed for use only when accessing files via the
GASS facility of the Globus environment.
For further information, see
<a href="http://www.globus.org/">http//www.globus.org/</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>,
<dd>IN: File access property list identifier.
<dt><em>GASS_Info</em> <code>info</code>
<dd>IN: Pointer to the GASS information structure.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplGass">H5Pget_fapl_gass</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_gass</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>GASS_Info *</em><code>info</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves GASS information.
<dt><strong>Description:</strong>
<dd>If the file access property list <code>fapl_id</code> is set
for use of the <code>H5FD_GASS</code> driver,
<code>H5Pget_fapl_gass</code> returns the <em>GASS_Info</em>
object through the <code>info</code> pointer.
<p>
The <em>GASS_Info</em> information is copied, so it is valid
only until the file access property list is modified or closed.
<dt><strong>Note:</strong>
<dd><code>H5Pget_fapl_gass</code> is an experimental function.
It is designed for use only when accessing files via the
GASS facility of the Globus environment.
For further information, see
<a href="http://www.globus.org/">http//www.globus.org/</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>,
<dd>IN: File access property list identifier.
<dt><em>GASS_Info *</em><code>info</code>
<dd>OUT: Pointer to the GASS information structure.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplDpss">H5Pset_fapl_dpss</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_dpss</code>(
<em>hid_t</em> <code>fapl_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Sets use of the DPSS I/O driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_dpss</code> modifies the file access property list
<code>fapl_id</code> to use the DPSS I/O driver in a
Globus evnvironment.
<dt><strong>Note:</strong>
<dd><code>H5Pget_fapl_dpss</code> is an experimental function.
It is designed for use only when accessing files via the
DPSS facility of the Globus environment.
For further information, see
<a href="http://www.globus.org/">http//www.globus.org/</a>.
<p>
As of HDF5 Release 1.4 Beta, the Globus project has deprecated
the DPSS facility in favor of an FTP-based facility that is still
under development.
While the DPSS functionality is still available,
users must be aware that it was implemented purely for research purposes
and may be unavailable in future Globus releases.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplSrb">H5Pset_fapl_srb</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_srb</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>SRB_Info</em> <code>info</code>
)
<dt><strong>Purpose:</strong>
<dd>Saves SRB connection handler and sets SRB settings.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_srb</code> stores the SRB client-to-server
connection handler <code>SRB_CONN</code> after the connection
is established and other user-supplied SRB information.
<p>
The user-supplied SRB information is contained in the
<em>SRB_Info</em> struct pointed to by <code>info</code>
and is stored in the file access property list <code>fapl_id</code>.
This information can then be used to create or open a file.
<dt><strong>Note:</strong>
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
It is designed for use only when accessing files via the
Storage Resource Broker (SRB). For further information, see
<a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>SRB_Info</em> <code>info</code>
<dd>IN: Pointer to the SRB information structure.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplSrb">H5Pget_fapl_srb</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_srb</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>SRB_Info *</em><code>info</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves SRB information.
<dt><strong>Description:</strong>
<dd>If the file access property list <code>fapl_id</code> is set
for use of the <code>H5FD_SRB</code> driver,
<code>H5Pget_fapl_srb</code> returns the <em>SRB_Info</em>
object through the <code>info</code> pointer.
<p>
The <em>SRB_Info</em> information is copied, so it is valid
only until the file access property list is modified or closed.
<dt><strong>Note:</strong>
<dd><code>H5Pset_fapl_gass</code> is an experimental function.
It is designed for use only when accessing files via the
Storage Resource Broker (SRB). For further information, see
<a href="http://www.npaci.edu/Research/DI/srb/">http//www.npaci.edu/Research/DI/srb/</a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>SRB_Info *</em><code>info</code>
<dd>OUT: Pointer to the SRB information structure.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SetFaplCore">H5Pset_fapl_core</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pset_fapl_core</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>size_t</em> <code>increment</code>,
<em>hbool_t</em> <code>backing_store</code>
)
<dt><strong>Purpose:</strong>
<dd>Modifies the file access property list to use the
<code>H5FD_CORE</code> driver.
<dt><strong>Description:</strong>
<dd><code>H5Pset_fapl_core</code> modifies the file access property list
to use the <code>H5FD_CORE</code> driver.
<p>
The <code>H5FD_CORE</code> driver enables an application to work
with a file in memory, speeding reads and writes as no disk access
is made. File contents are stored only in memory until the file
is closed. The <code>backing_store</code> parameter determines
whether file contents are ever written to disk.
<p>
<code>increment</code> specifies the increment by which allocated
memory is to be increased each time more memory is required.
<p>
If <code>backing_store</code> is set to <code>1</code>
(<code>TRUE</code>), the file contents are flushed to a file
with the same name as this core file when the file is closed
or access to the file is terminated in memory.
<dt><strong>Note:</strong>
<dd>There is currently no means for reading a file from disk then
using the <code>H5FD_CORE</code> driver to manipulate the file.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>size_t</em> <code>increment</code>
<dd>IN: Size, in bytes, of memory increments.
<dt><em>hbool_t</em> <code>backing_store</code>
<dd>IN: Boolean flag indicating whether to write the file
contents to disk when the file is closed.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-GetFaplCore">H5Pget_fapl_core</a>
<dt><strong>Signature:</strong>
<dd><em>herr_t</em> <code>H5Pget_fapl_core</code>(
<em>hid_t</em> <code>fapl_id</code>,
<em>size_t</em> *<code>increment</code>,
<em>hbool_t</em> *<code>backing_store</code>
)
<dt><strong>Purpose:</strong>
<dd>Queries core file driver properties.
<dt><strong>Description:</strong>
<dd><code>H5Pget_fapl_core</code> queries the <code>H5FD_CORE</code>
driver properties as set by <code>H5Pset_fapl_core</code>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>fapl_id</code>
<dd>IN: File access property list identifier.
<dt><em>size_t</em> *<code>increment</code>
<dd>OUT: Size, in bytes, of memory increments.
<dt><em>hbool_t</em> *<code>backing_store</code>
<dd>OUT: Boolean flag indicating whether to write the file
contents to disk when the file is closed.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
</dl>
<!-- ***** TEMPLATE *****
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-SGetFaplxxx">H5Psget_fapl_xxx</a>
<dt><strong>Signature:</strong>
<dd><em>xxx</em> <code>H5Psget_fapl_xxx</code>(
<em>xxx</em> <code>xxx</code>,
<em>xxx</em> <code>xxx</code>,
<em>xxx</em> <code>xxx</code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Psget_fapl_xxx</code>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>xxx</em> <code>xxx</code>
<dd>IN:
<dd>OUT:
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a non-negative value if successful.
Otherwise returns a negative value.
-->
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
<!--
</dl>
-->
<!-- ***** TEMPLATE *****
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Property-xxx">xxx</a>
<dt><strong>Signature:</strong>
<dd><em>xxx</em> <code>xxx</code>(
<em>xxx</em> <code>xxx</code>,
<em>xxx</em> <code>xxx</code>,
<em>xxx</em> <code>xxx</code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>xxx</code>
<dt><strong>Parameters:</strong>
<dl>
<dt><em>xxx</em> <code>xxx</code>
<dd>IN:
<dd>OUT:
</dl>
<dt><strong>Returns:</strong>
<dd>Returns xxx if successful.
Otherwise returns xxx.
-->
<!--
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5p_FORTRAN.html#h5pxxx_f"
target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
-->
<!--
<img src="Graphics/Java.gif">
<img src="Graphics/C++.gif">
-->
<!--
</dl>
-->
<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="H5.intro.html">Introduction to HDF5</a> <br>
<a href="H5.user.html">HDF5 User Guide</a> <br>
<a href="index.html">Other HDF5 documents and links</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>
H5P
<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>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 9 January 2001
<br>
Describes HDF5 Release 1.4 Beta, December 2000
</body>
</html>
|
