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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Dataset Creation Properties</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.68e8c0e</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___d_c_p_l.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Dataset Creation Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a> » <a class="el" href="group___o_c_p_l.html">Object Creation Properties</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use dataset creation properties to control aspects of dataset creation such as fill time, storage layout, compression methods, etc. Unlike dataset access and transfer properties, creation properties <em>are</em> stored with the dataset, and cannot be changed once a dataset has been created. </p><div></div><div> <a class="anchor" id="table_dcpl_id"></a>
<table class="doxtable">
<caption border="1" style="background-color:whitesmoke;">Dataset creation property list functions (H5P)</caption>
<tr>
<th>Function </th><th>Purpose </th></tr>
<tr>
<td><a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout</a> </td><td>Sets the type of storage used to store the raw data for a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout</a> </td><td>Returns the layout of the raw data for a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga3584d592e377da3604b7604e266dcf5b" title="Sets the size of the chunks used to store a chunked layout dataset.">H5Pset_chunk</a> </td><td>Sets the size of the chunks used to store a chunked layout dataset. </td></tr>
<tr>
<td><a class="el" href="#ga4ef814034f601f48ab1ed6db79b4354c" title="Retrieves the size of chunks for the raw data of a chunked layout dataset.">H5Pget_chunk</a> </td><td>Retrieves the size of chunks for the raw data of a chunked layout dataset. </td></tr>
<tr>
<td><a class="el" href="#ga8e60618d9030dc1b99ad9c8ff7867873" title="Sets the edge chunk option in a dataset creation property list.">H5Pset_chunk_opts</a>/<a class="el" href="#ga6e8d8f6a14b79bd110e27666d95031cf" title="Retrieves the edge chunk option setting from a dataset creation property list.">H5Pget_chunk_opts</a> </td><td>Sets/gets the edge chunk option setting from a dataset creation property list. </td></tr>
<tr>
<td><a class="el" href="#gaf1f569bfc54552bdb9317d2b63318a0d" title="Sets deflate (GNU gzip) compression method and compression level.">H5Pset_deflate</a> </td><td>Sets compression method and compression level. </td></tr>
<tr>
<td><a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value</a> </td><td>Sets the fill value for a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value</a> </td><td>Retrieves a dataset fill value. </td></tr>
<tr>
<td><a class="el" href="#ga14f9bc2a0d6f9e62ab95661fc1045ad6" title="Determines whether fill value is defined.">H5Pfill_value_defined</a> </td><td>Determines whether the fill value is defined. </td></tr>
<tr>
<td><a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time</a> </td><td>Sets the time when fill values are written to a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c" title="Retrieves the time when fill values are written to a dataset.">H5Pget_fill_time</a> </td><td>Retrieves the time when fill value are written to a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time</a> </td><td>Sets the timing for storage space allocation. </td></tr>
<tr>
<td><a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8" title="Retrieves the timing for storage space allocation.">H5Pget_alloc_time</a> </td><td>Retrieves the timing for storage space allocation. </td></tr>
<tr>
<td><a class="el" href="group___o_c_p_l.html#ga191c567ee50b2063979cdef156a768c5" title="Adds a filter to the filter pipeline.">H5Pset_filter</a> </td><td>Adds a filter to the filter pipeline. </td></tr>
<tr>
<td><a class="el" href="#ga70f5346250698afc950532e9593c3988" title="Verifies that all required filters are available.">H5Pall_filters_avail</a> </td><td>Verifies that all required filters are available. </td></tr>
<tr>
<td><a class="el" href="group___o_c_p_l.html#gacbad1ca36a61246b439a25f28e7575fb" title="Returns the number of filters in the pipeline.">H5Pget_nfilters</a> </td><td>Returns the number of filters in the pipeline. </td></tr>
<tr>
<td><a class="el" href="_h5version_8h.html#a7e070dfec9cb3a3aaf9c188a987e6a15">H5Pget_filter</a> </td><td>Returns information about a filter in a pipeline. The C function is a macro: <dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a>. </dd></dl>
</td></tr>
<tr>
<td><a class="el" href="_h5version_8h.html#ac7aa336e7b1b9033cea2448ba623951f">H5Pget_filter_by_id</a> </td><td>Returns information about the specified filter. The C function is a macro: <dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a>. </dd></dl>
</td></tr>
<tr>
<td><a class="el" href="group___o_c_p_l.html#ga12a358b3725a889c1768bbd2b5f541d8" title="Modifies a filter in the filter pipeline.">H5Pmodify_filter</a> </td><td>Modifies a filter in the filter pipeline. </td></tr>
<tr>
<td><a class="el" href="group___o_c_p_l.html#gabffbf6d013c090fa052ac4bafce8e532" title="Delete one or more filters in the filter pipeline.">H5Premove_filter</a> </td><td>Deletes one or more filters in the filter pipeline. </td></tr>
<tr>
<td><a class="el" href="group___o_c_p_l.html#ga8bc81abfbd0393b0a46e121f817a3f81" title="Sets up use of the Fletcher32 checksum filter.">H5Pset_fletcher32</a> </td><td>Sets up use of the Fletcher32 checksum filter. </td></tr>
<tr>
<td><a class="el" href="#gad58a9c0e766ef71d4075b2c2a755e91c" title="Sets up the use of the N-Bit filter.">H5Pset_nbit</a> </td><td>Sets up use of the n-bit filter. </td></tr>
<tr>
<td><a class="el" href="#ga5c10165b670e0e984db431aee818cc7e" title="Sets up the use of the scale-offset filter.">H5Pset_scaleoffset</a> </td><td>Sets up use of the scale-offset filter. </td></tr>
<tr>
<td><a class="el" href="#ga31e09cb0bf2da2893eed8a72220e6521" title="Sets up use of the shuffle filter.">H5Pset_shuffle</a> </td><td>Sets up use of the shuffle filter. </td></tr>
<tr>
<td><a class="el" href="#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip</a> </td><td>Sets up use of the Szip compression filter. </td></tr>
<tr>
<td><a class="el" href="#ga85ff7c9c827fa524041cd58c199b77b8" title="Adds an external file to the list of external files.">H5Pset_external</a> </td><td>Adds an external file to the list of external files. </td></tr>
<tr>
<td><a class="el" href="#ga4c45d90845ea7627b6238f95168c41ce" title="Returns the number of external files for a dataset.">H5Pget_external_count</a> </td><td>Returns the number of external files for a dataset. </td></tr>
<tr>
<td><a class="el" href="#ga78253b80b6c86faf7ff0db135146521d" title="Returns information about an external file.">H5Pget_external</a> </td><td>Returns information about an external file. </td></tr>
<tr>
<td><a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a> </td><td>Sets the character encoding used to encode a string. Use to set ASCII or UTF-8 character encoding for object names. </td></tr>
<tr>
<td><a class="el" href="group___a_c_p_l.html#ga9b35ef9add6463997330e9b4b606603d" title="Retrieves the character encoding used to create a link or attribute name.">H5Pget_char_encoding</a> </td><td>Retrieves the character encoding used to create a string. </td></tr>
<tr>
<td><a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual</a> </td><td>Sets the mapping between virtual and source datasets. </td></tr>
<tr>
<td><a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count</a> </td><td>Gets the number of mappings for the virtual dataset. </td></tr>
<tr>
<td><a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname</a> </td><td>Gets the name of a source dataset used in the mapping. </td></tr>
<tr>
<td><a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename</a> </td><td>Gets the filename of a source dataset used in the mapping. </td></tr>
<tr>
<td><a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace</a> </td><td>Gets a dataspace identifier for the selection within the source dataset used in the mapping. </td></tr>
<tr>
<td><a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace</a> </td><td>Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. </td></tr>
<tr>
<td><a class="el" href="#gaf5ae8c0257c02e3fbe50bde70b1eb8be" title="Sets the flag to create minimized dataset object headers.">H5Pset_dset_no_attrs_hint</a>/<a class="el" href="#ga2fd4f0446a38186db8256cef4c97a970" title="Retrieves the setting for whether or not to create minimized dataset object headers.">H5Pget_dset_no_attrs_hint</a> </td><td>Sets/gets the flag to create minimized dataset object headers. </td></tr>
</table>
</div><div> </div> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga70f5346250698afc950532e9593c3988" id="r_ga70f5346250698afc950532e9593c3988"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga70f5346250698afc950532e9593c3988">H5Pall_filters_avail</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:ga70f5346250698afc950532e9593c3988"><td class="mdescLeft"> </td><td class="mdescRight">Verifies that all required filters are available. <br /></td></tr>
<tr class="separator:ga70f5346250698afc950532e9593c3988"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf1f569bfc54552bdb9317d2b63318a0d" id="r_gaf1f569bfc54552bdb9317d2b63318a0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf1f569bfc54552bdb9317d2b63318a0d">H5Pset_deflate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned level)</td></tr>
<tr class="memdesc:gaf1f569bfc54552bdb9317d2b63318a0d"><td class="mdescLeft"> </td><td class="mdescRight">Sets deflate (GNU gzip) compression method and compression level. <br /></td></tr>
<tr class="separator:gaf1f569bfc54552bdb9317d2b63318a0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga14f9bc2a0d6f9e62ab95661fc1045ad6" id="r_ga14f9bc2a0d6f9e62ab95661fc1045ad6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga14f9bc2a0d6f9e62ab95661fc1045ad6">H5Pfill_value_defined</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist, <a class="el" href="_h5_dpublic_8h.html#a322c8263bd76fa5af8ff7636de5dfa23">H5D_fill_value_t</a> *status)</td></tr>
<tr class="memdesc:ga14f9bc2a0d6f9e62ab95661fc1045ad6"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether fill value is defined. <br /></td></tr>
<tr class="separator:ga14f9bc2a0d6f9e62ab95661fc1045ad6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf507a3efa5d1f37448baea089fc053d8" id="r_gaf507a3efa5d1f37448baea089fc053d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8">H5Pget_alloc_time</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2">H5D_alloc_time_t</a> *alloc_time)</td></tr>
<tr class="memdesc:gaf507a3efa5d1f37448baea089fc053d8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the timing for storage space allocation. <br /></td></tr>
<tr class="separator:gaf507a3efa5d1f37448baea089fc053d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ef814034f601f48ab1ed6db79b4354c" id="r_ga4ef814034f601f48ab1ed6db79b4354c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4ef814034f601f48ab1ed6db79b4354c">H5Pget_chunk</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, int max_ndims, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> dim[])</td></tr>
<tr class="memdesc:ga4ef814034f601f48ab1ed6db79b4354c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the size of chunks for the raw data of a chunked layout dataset. <br /></td></tr>
<tr class="separator:ga4ef814034f601f48ab1ed6db79b4354c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6e8d8f6a14b79bd110e27666d95031cf" id="r_ga6e8d8f6a14b79bd110e27666d95031cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6e8d8f6a14b79bd110e27666d95031cf">H5Pget_chunk_opts</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned *opts)</td></tr>
<tr class="memdesc:ga6e8d8f6a14b79bd110e27666d95031cf"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the edge chunk option setting from a dataset creation property list. <br /></td></tr>
<tr class="separator:ga6e8d8f6a14b79bd110e27666d95031cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2fd4f0446a38186db8256cef4c97a970" id="r_ga2fd4f0446a38186db8256cef4c97a970"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2fd4f0446a38186db8256cef4c97a970">H5Pget_dset_no_attrs_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *minimize)</td></tr>
<tr class="memdesc:ga2fd4f0446a38186db8256cef4c97a970"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the setting for whether or not to create minimized dataset object headers. <br /></td></tr>
<tr class="separator:ga2fd4f0446a38186db8256cef4c97a970"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga78253b80b6c86faf7ff0db135146521d" id="r_ga78253b80b6c86faf7ff0db135146521d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga78253b80b6c86faf7ff0db135146521d">H5Pget_external</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned idx, size_t name_size, char *name, off_t *offset, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *size)</td></tr>
<tr class="memdesc:ga78253b80b6c86faf7ff0db135146521d"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about an external file. <br /></td></tr>
<tr class="separator:ga78253b80b6c86faf7ff0db135146521d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c45d90845ea7627b6238f95168c41ce" id="r_ga4c45d90845ea7627b6238f95168c41ce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4c45d90845ea7627b6238f95168c41ce">H5Pget_external_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:ga4c45d90845ea7627b6238f95168c41ce"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of external files for a dataset. <br /></td></tr>
<tr class="separator:ga4c45d90845ea7627b6238f95168c41ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga92c5eb5ee19bfd4a9184cf0428d1b00c" id="r_ga92c5eb5ee19bfd4a9184cf0428d1b00c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c">H5Pget_fill_time</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4a">H5D_fill_time_t</a> *fill_time)</td></tr>
<tr class="memdesc:ga92c5eb5ee19bfd4a9184cf0428d1b00c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the time when fill values are written to a dataset. <br /></td></tr>
<tr class="separator:ga92c5eb5ee19bfd4a9184cf0428d1b00c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga82bbe8c77c7eb9c460bfd1eb26881355" id="r_ga82bbe8c77c7eb9c460bfd1eb26881355"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355">H5Pget_fill_value</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, void *value)</td></tr>
<tr class="memdesc:ga82bbe8c77c7eb9c460bfd1eb26881355"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a dataset fill value. <br /></td></tr>
<tr class="separator:ga82bbe8c77c7eb9c460bfd1eb26881355"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga655530b0f40990507fedeef6b3068db3" id="r_ga655530b0f40990507fedeef6b3068db3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06e">H5D_layout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga655530b0f40990507fedeef6b3068db3">H5Pget_layout</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:ga655530b0f40990507fedeef6b3068db3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the layout of the raw data for a dataset. <br /></td></tr>
<tr class="separator:ga655530b0f40990507fedeef6b3068db3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga83dcce1ce110d1ff6eae0fb77d4a7c85" id="r_ga83dcce1ce110d1ff6eae0fb77d4a7c85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85">H5Pget_virtual_count</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, size_t *count)</td></tr>
<tr class="memdesc:ga83dcce1ce110d1ff6eae0fb77d4a7c85"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of mappings for the virtual dataset. <br /></td></tr>
<tr class="separator:ga83dcce1ce110d1ff6eae0fb77d4a7c85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf50620fd5d83dc9ca1e5c3f374c5a952" id="r_gaf50620fd5d83dc9ca1e5c3f374c5a952"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952">H5Pget_virtual_dsetname</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, size_t index, char *name, size_t size)</td></tr>
<tr class="memdesc:gaf50620fd5d83dc9ca1e5c3f374c5a952"><td class="mdescLeft"> </td><td class="mdescRight">Gets the name of a source dataset used in the mapping. <br /></td></tr>
<tr class="separator:gaf50620fd5d83dc9ca1e5c3f374c5a952"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c17780cc9a72a0f62d70f6138510afa" id="r_ga5c17780cc9a72a0f62d70f6138510afa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa">H5Pget_virtual_filename</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, size_t index, char *name, size_t size)</td></tr>
<tr class="memdesc:ga5c17780cc9a72a0f62d70f6138510afa"><td class="mdescLeft"> </td><td class="mdescRight">Gets the filename of a source dataset used in the mapping. <br /></td></tr>
<tr class="separator:ga5c17780cc9a72a0f62d70f6138510afa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8319e9386cdb9b3881a8b698edfc78fc" id="r_ga8319e9386cdb9b3881a8b698edfc78fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc">H5Pget_virtual_srcspace</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, size_t index)</td></tr>
<tr class="memdesc:ga8319e9386cdb9b3881a8b698edfc78fc"><td class="mdescLeft"> </td><td class="mdescRight">Gets a dataspace identifier for the selection within the source dataset used in the mapping. <br /></td></tr>
<tr class="separator:ga8319e9386cdb9b3881a8b698edfc78fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6425cabbc055b66e218b4728d6eb911d" id="r_ga6425cabbc055b66e218b4728d6eb911d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d">H5Pget_virtual_vspace</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, size_t index)</td></tr>
<tr class="memdesc:ga6425cabbc055b66e218b4728d6eb911d"><td class="mdescLeft"> </td><td class="mdescRight">Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. <br /></td></tr>
<tr class="separator:ga6425cabbc055b66e218b4728d6eb911d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85faefca58387bba409b65c470d7d851" id="r_ga85faefca58387bba409b65c470d7d851"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga85faefca58387bba409b65c470d7d851">H5Pset_alloc_time</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2">H5D_alloc_time_t</a> alloc_time)</td></tr>
<tr class="memdesc:ga85faefca58387bba409b65c470d7d851"><td class="mdescLeft"> </td><td class="mdescRight">Sets the timing for storage space allocation. <br /></td></tr>
<tr class="separator:ga85faefca58387bba409b65c470d7d851"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3584d592e377da3604b7604e266dcf5b" id="r_ga3584d592e377da3604b7604e266dcf5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3584d592e377da3604b7604e266dcf5b">H5Pset_chunk</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, int ndims, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> dim[])</td></tr>
<tr class="memdesc:ga3584d592e377da3604b7604e266dcf5b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the size of the chunks used to store a chunked layout dataset. <br /></td></tr>
<tr class="separator:ga3584d592e377da3604b7604e266dcf5b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8e60618d9030dc1b99ad9c8ff7867873" id="r_ga8e60618d9030dc1b99ad9c8ff7867873"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8e60618d9030dc1b99ad9c8ff7867873">H5Pset_chunk_opts</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned opts)</td></tr>
<tr class="memdesc:ga8e60618d9030dc1b99ad9c8ff7867873"><td class="mdescLeft"> </td><td class="mdescRight">Sets the edge chunk option in a dataset creation property list. <br /></td></tr>
<tr class="separator:ga8e60618d9030dc1b99ad9c8ff7867873"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf5ae8c0257c02e3fbe50bde70b1eb8be" id="r_gaf5ae8c0257c02e3fbe50bde70b1eb8be"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf5ae8c0257c02e3fbe50bde70b1eb8be">H5Pset_dset_no_attrs_hint</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> minimize)</td></tr>
<tr class="memdesc:gaf5ae8c0257c02e3fbe50bde70b1eb8be"><td class="mdescLeft"> </td><td class="mdescRight">Sets the flag to create minimized dataset object headers. <br /></td></tr>
<tr class="separator:gaf5ae8c0257c02e3fbe50bde70b1eb8be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85ff7c9c827fa524041cd58c199b77b8" id="r_ga85ff7c9c827fa524041cd58c199b77b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga85ff7c9c827fa524041cd58c199b77b8">H5Pset_external</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name, off_t offset, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> size)</td></tr>
<tr class="memdesc:ga85ff7c9c827fa524041cd58c199b77b8"><td class="mdescLeft"> </td><td class="mdescRight">Adds an external file to the list of external files. <br /></td></tr>
<tr class="separator:ga85ff7c9c827fa524041cd58c199b77b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6bd822266b31f86551a9a1d79601b6a2" id="r_ga6bd822266b31f86551a9a1d79601b6a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2">H5Pset_fill_time</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4a">H5D_fill_time_t</a> fill_time)</td></tr>
<tr class="memdesc:ga6bd822266b31f86551a9a1d79601b6a2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the time when fill values are written to a dataset. <br /></td></tr>
<tr class="separator:ga6bd822266b31f86551a9a1d79601b6a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4335bb45b35386daa837b4ff1b9cd4a4" id="r_ga4335bb45b35386daa837b4ff1b9cd4a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4">H5Pset_fill_value</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> type_id, const void *value)</td></tr>
<tr class="memdesc:ga4335bb45b35386daa837b4ff1b9cd4a4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the fill value for a dataset. <br /></td></tr>
<tr class="separator:ga4335bb45b35386daa837b4ff1b9cd4a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga31e09cb0bf2da2893eed8a72220e6521" id="r_ga31e09cb0bf2da2893eed8a72220e6521"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga31e09cb0bf2da2893eed8a72220e6521">H5Pset_shuffle</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:ga31e09cb0bf2da2893eed8a72220e6521"><td class="mdescLeft"> </td><td class="mdescRight">Sets up use of the shuffle filter. <br /></td></tr>
<tr class="separator:ga31e09cb0bf2da2893eed8a72220e6521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75d80991a8f467e0d454c53a383ae7f9" id="r_ga75d80991a8f467e0d454c53a383ae7f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9">H5Pset_layout</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06e">H5D_layout_t</a> layout)</td></tr>
<tr class="memdesc:ga75d80991a8f467e0d454c53a383ae7f9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of storage used to store the raw data for a dataset. <br /></td></tr>
<tr class="separator:ga75d80991a8f467e0d454c53a383ae7f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad58a9c0e766ef71d4075b2c2a755e91c" id="r_gad58a9c0e766ef71d4075b2c2a755e91c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gad58a9c0e766ef71d4075b2c2a755e91c">H5Pset_nbit</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:gad58a9c0e766ef71d4075b2c2a755e91c"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the use of the N-Bit filter. <br /></td></tr>
<tr class="separator:gad58a9c0e766ef71d4075b2c2a755e91c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5c10165b670e0e984db431aee818cc7e" id="r_ga5c10165b670e0e984db431aee818cc7e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5c10165b670e0e984db431aee818cc7e">H5Pset_scaleoffset</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#ga53d85c0570e17f6e1ddbf569462b1516">H5Z_SO_scale_type_t</a> scale_type, int scale_factor)</td></tr>
<tr class="memdesc:ga5c10165b670e0e984db431aee818cc7e"><td class="mdescLeft"> </td><td class="mdescRight">Sets up the use of the scale-offset filter. <br /></td></tr>
<tr class="separator:ga5c10165b670e0e984db431aee818cc7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga37de4b6071a94574cfab5cd6de9c3fc6" id="r_ga37de4b6071a94574cfab5cd6de9c3fc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga37de4b6071a94574cfab5cd6de9c3fc6">H5Pset_szip</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned options_mask, unsigned pixels_per_block)</td></tr>
<tr class="memdesc:ga37de4b6071a94574cfab5cd6de9c3fc6"><td class="mdescLeft"> </td><td class="mdescRight">Sets up use of the SZIP compression filter. <br /></td></tr>
<tr class="separator:ga37de4b6071a94574cfab5cd6de9c3fc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadec895092dbbedb94f85d9cacf8924f5" id="r_gadec895092dbbedb94f85d9cacf8924f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5">H5Pset_virtual</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> vspace_id, const char *src_file_name, const char *src_dset_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_space_id)</td></tr>
<tr class="memdesc:gadec895092dbbedb94f85d9cacf8924f5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the mapping between virtual and source datasets. <br /></td></tr>
<tr class="separator:gadec895092dbbedb94f85d9cacf8924f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacbd4f93aa7cd270668385440fb5873a1" id="r_gacbd4f93aa7cd270668385440fb5873a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacbd4f93aa7cd270668385440fb5873a1">H5Pget_filter1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned filter, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])</td></tr>
<tr class="memdesc:gacbd4f93aa7cd270668385440fb5873a1"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about a filter in a pipeline (DEPRECATED) <br /></td></tr>
<tr class="separator:gacbd4f93aa7cd270668385440fb5873a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga351bb4dc44dae41344f18aab177f4cf1" id="r_ga351bb4dc44dae41344f18aab177f4cf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga351bb4dc44dae41344f18aab177f4cf1">H5Pget_filter_by_id1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> id, unsigned int *flags, size_t *cd_nelmts, unsigned cd_values[], size_t namelen, char name[])</td></tr>
<tr class="memdesc:ga351bb4dc44dae41344f18aab177f4cf1"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about the specified filter. <br /></td></tr>
<tr class="separator:ga351bb4dc44dae41344f18aab177f4cf1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga70f5346250698afc950532e9593c3988" name="ga70f5346250698afc950532e9593c3988"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70f5346250698afc950532e9593c3988">◆ </a></span>H5Pall_filters_avail()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Pall_filters_avail </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Verifies that all required filters are available. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#ga70f5346250698afc950532e9593c3988" title="Verifies that all required filters are available.">H5Pall_filters_avail()</a> verifies that all of the filters set in the dataset or group creation property list <code>plist_id</code> are currently available.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.5 Function extended to work with group creation property lists. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga14f9bc2a0d6f9e62ab95661fc1045ad6" name="ga14f9bc2a0d6f9e62ab95661fc1045ad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga14f9bc2a0d6f9e62ab95661fc1045ad6">◆ </a></span>H5Pfill_value_defined()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pfill_value_defined </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#a322c8263bd76fa5af8ff7636de5dfa23">H5D_fill_value_t</a> *</td> <td class="paramname"><span class="paramname"><em>status</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether fill value is defined. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>Status of fill value in property list</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga14f9bc2a0d6f9e62ab95661fc1045ad6" title="Determines whether fill value is defined.">H5Pfill_value_defined()</a> determines whether a fill value is defined in the dataset creation property list <code>plist</code>. Valid values returned in status are as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#a322c8263bd76fa5af8ff7636de5dfa23aadc673e3e3dd7ff5685a2d9dab24fb3f">H5D_FILL_VALUE_UNDEFINED</a> </td><td>Fill value is undefined. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#a322c8263bd76fa5af8ff7636de5dfa23aa117582dd3ab4b104ce04029f0c7756a">H5D_FILL_VALUE_DEFAULT</a> </td><td>Fill value is the library default. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#a322c8263bd76fa5af8ff7636de5dfa23af1c5d380a1c5e48dabf4c0fea52a8bfe">H5D_FILL_VALUE_USER_DEFINED</a> </td><td>Fill value is defined by the application. </td></tr>
</table>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="gaf507a3efa5d1f37448baea089fc053d8" name="gaf507a3efa5d1f37448baea089fc053d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf507a3efa5d1f37448baea089fc053d8">◆ </a></span>H5Pget_alloc_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_alloc_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2">H5D_alloc_time_t</a> *</td> <td class="paramname"><span class="paramname"><em>alloc_time</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the timing for storage space allocation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">alloc_time</td><td>The timing setting for allocating dataset storage space</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8" title="Retrieves the timing for storage space allocation.">H5Pget_alloc_time()</a> retrieves the timing for allocating storage space for a dataset's raw data. This property is set in the dataset creation property list <code>plist_id</code>. The timing setting is returned in <code>alloc_time</code> as one of the following values:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a1eb65ed3b5c64ab8cb783492b28b6903">H5D_ALLOC_TIME_DEFAULT</a><br />
  </td><td>Uses the default allocation time, based on the dataset storage method. <br />
See the <code>alloc_time</code> description in <a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> for default allocation times for various storage methods. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a> </td><td>All space is allocated when the dataset is created. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2ac898a96931fd3402d9e5646690c77636">H5D_ALLOC_TIME_INCR</a> </td><td>Space is allocated incrementally as data is written to the dataset. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a7c5fcb6f9c8adecf455939c3d625b7e8">H5D_ALLOC_TIME_LATE</a> </td><td>All space is allocated when data is first written to the dataset. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8" title="Retrieves the timing for storage space allocation.">H5Pget_alloc_time()</a> is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions <a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> and <a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c" title="Retrieves the time when fill values are written to a dataset.">H5Pget_fill_time()</a>.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga4ef814034f601f48ab1ed6db79b4354c" name="ga4ef814034f601f48ab1ed6db79b4354c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ef814034f601f48ab1ed6db79b4354c">◆ </a></span>H5Pget_chunk()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int H5Pget_chunk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>max_ndims</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>dim</em>[]</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the size of chunks for the raw data of a chunked layout dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_ndims</td><td>Size of the <code>dims</code> array </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dim</td><td>Array to store the chunk dimensions</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns chunk dimensionality if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga4ef814034f601f48ab1ed6db79b4354c" title="Retrieves the size of chunks for the raw data of a chunked layout dataset.">H5Pget_chunk()</a> 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>dim</code> will be initialized.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga6e8d8f6a14b79bd110e27666d95031cf" name="ga6e8d8f6a14b79bd110e27666d95031cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e8d8f6a14b79bd110e27666d95031cf">◆ </a></span>H5Pget_chunk_opts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_chunk_opts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>opts</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the edge chunk option setting from a dataset creation property list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">opts</td><td>Edge chunk option flag. Valid values are described in <a class="el" href="#ga8e60618d9030dc1b99ad9c8ff7867873" title="Sets the edge chunk option in a dataset creation property list.">H5Pset_chunk_opts()</a>. The option status can be retrieved using the bitwise AND operator ( & ). For example, the expression (opts&<a class="el" href="_h5_dpublic_8h.html#a9721f293efbd6b03ce91865a0e2ca74e">H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS</a>) will evaluate to <a class="el" href="_h5_dpublic_8h.html#a9721f293efbd6b03ce91865a0e2ca74e">H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS</a> if that option has been enabled. Otherwise, it will evaluate to 0 (zero).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga6e8d8f6a14b79bd110e27666d95031cf" title="Retrieves the edge chunk option setting from a dataset creation property list.">H5Pget_chunk_opts()</a> retrieves the edge chunk option setting stored in the dataset creation property list <code>plist_id</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga2fd4f0446a38186db8256cef4c97a970" name="ga2fd4f0446a38186db8256cef4c97a970"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2fd4f0446a38186db8256cef4c97a970">◆ </a></span>H5Pget_dset_no_attrs_hint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_dset_no_attrs_hint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *</td> <td class="paramname"><span class="paramname"><em>minimize</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the setting for whether or not to create minimized dataset object headers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">minimize</td><td>Flag indicating whether the library will or will not create minimized dataset object headers</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga2fd4f0446a38186db8256cef4c97a970" title="Retrieves the setting for whether or not to create minimized dataset object headers.">H5Pget_dset_no_attrs_hint()</a> retrieves the <em>no dataset attributes</em> hint setting for the dataset creation property list <code>dcpl_id</code>. This setting is used to inform the library to create minimized dataset object headers when true. The setting value is returned in the boolean pointer <code>minimize</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.5 </dd></dl>
</div>
</div>
<a id="ga78253b80b6c86faf7ff0db135146521d" name="ga78253b80b6c86faf7ff0db135146521d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78253b80b6c86faf7ff0db135146521d">◆ </a></span>H5Pget_external()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_external </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>idx</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>name_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t *</td> <td class="paramname"><span class="paramname"><em>offset</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> *</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about an external file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>External file index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name_size</td><td>Maximum length of <code>name</code> array </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Name of the external file </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">offset</td><td>Pointer to a location to return an offset value </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Pointer to a location to return the size of the external file data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga78253b80b6c86faf7ff0db135146521d" title="Returns information about an external file.">H5Pget_external()</a> 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 <a class="el" href="#ga4c45d90845ea7627b6238f95168c41ce" title="Returns the number of external files for a dataset.">H5Pget_external_count()</a>. 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 strncpy()).</p>
<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.</p>
<dl class="section note"><dt>Note</dt><dd>On Windows, off_t is typically a 32-bit signed long value, which limits the valid offset that can be returned to 2 GiB.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.6.4 <code>idx</code> parameter type changed to unsigned. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga4c45d90845ea7627b6238f95168c41ce" name="ga4c45d90845ea7627b6238f95168c41ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c45d90845ea7627b6238f95168c41ce">◆ </a></span>H5Pget_external_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int H5Pget_external_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of external files for a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of external files if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga4c45d90845ea7627b6238f95168c41ce" title="Returns the number of external files for a dataset.">H5Pget_external_count()</a> returns the number of external files for the specified dataset.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga92c5eb5ee19bfd4a9184cf0428d1b00c" name="ga92c5eb5ee19bfd4a9184cf0428d1b00c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c">◆ </a></span>H5Pget_fill_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_fill_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4a">H5D_fill_time_t</a> *</td> <td class="paramname"><span class="paramname"><em>fill_time</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the time when fill values are written to a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">fill_time</td><td>Setting for the timing of writing fill values to the dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c" title="Retrieves the time when fill values are written to a dataset.">H5Pget_fill_time()</a> examines the dataset creation property list <code>plist_id</code> to determine when fill values are to be written to a dataset. Valid values returned in <code>fill_time</code> are as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> </td><td>Fill values are written to the dataset when storage space is allocated only if there is a user-defined fill value, i.e., one set with <a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a>. (Default) </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a> </td><td>Fill values are written to the dataset when storage space is allocated. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aaa87fbf4f3ebf96f2f3effe7bf46c1528">H5D_FILL_TIME_NEVER</a> </td><td>Fill values are never written to the dataset. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c" title="Retrieves the time when fill values are written to a dataset.">H5Pget_fill_time()</a> is designed to work in coordination with the dataset fill value and dataset storage allocation time properties, retrieved with the functions <a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> and <a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8" title="Retrieves the timing for storage space allocation.">H5Pget_alloc_time()</a>.type == H5FD_MEM_DRAW</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga82bbe8c77c7eb9c460bfd1eb26881355" name="ga82bbe8c77c7eb9c460bfd1eb26881355"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82bbe8c77c7eb9c460bfd1eb26881355">◆ </a></span>H5Pget_fill_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_fill_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a dataset fill value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype identifier for the value passed via <code>value</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>Pointer to buffer to contain the returned fill value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> returns the dataset fill value defined in the dataset creation property list <code>plist_id</code>. The fill value is returned through the <code>value</code> pointer and will be converted to the datatype specified by <code>type_id</code>. This datatype may differ from the fill value datatype in the property list, but the HDF5 library must be able to convert between the two datatypes.</p>
<p>If the fill value is undefined, i.e., set to NULL in the property list, <a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> will return an error. <a class="el" href="#ga14f9bc2a0d6f9e62ab95661fc1045ad6" title="Determines whether fill value is defined.">H5Pfill_value_defined()</a> should be used to check for this condition before <a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> is called.</p>
<p>Memory must be allocated by the calling application.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#ga82bbe8c77c7eb9c460bfd1eb26881355" title="Retrieves a dataset fill value.">H5Pget_fill_value()</a> is designed to coordinate with the dataset storage allocation time and fill value write time properties, which can be retrieved with the functions <a class="el" href="#gaf507a3efa5d1f37448baea089fc053d8" title="Retrieves the timing for storage space allocation.">H5Pget_alloc_time()</a> and <a class="el" href="#ga92c5eb5ee19bfd4a9184cf0428d1b00c" title="Retrieves the time when fill values are written to a dataset.">H5Pget_fill_time()</a>, respectively.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gacbd4f93aa7cd270668385440fb5873a1" name="gacbd4f93aa7cd270668385440fb5873a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbd4f93aa7cd270668385440fb5873a1">◆ </a></span>H5Pget_filter1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> H5Pget_filter1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>filter</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>flags</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>cd_nelmts</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>cd_values</em>[], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>namelen</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>name</em>[]</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about a filter in a pipeline (DEPRECATED) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filter</td><td>Sequence number within the filter pipeline of the filter for which information is sought </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>Bit vector specifying certain general properties of the filter </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">cd_nelmts</td><td>Number of elements in <code>cd_values</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cd_values</td><td>Auxiliary data for the filter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">namelen</td><td>Anticipated number of characters in <code>name</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Name of the filter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the filter identifier if successful; Otherwise returns a negative value. See: <a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237" title="Filter identifiers.">H5Z_filter_t</a></dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000073">Deprecated</a></b></dt><dd>When was this function deprecated?</dd></dl>
<p><a class="el" href="#gacbd4f93aa7cd270668385440fb5873a1" title="Returns information about a filter in a pipeline (DEPRECATED)">H5Pget_filter1()</a> 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>
<p><code>plist_id</code> must be a dataset or group creation property list.</p>
<p><code>filter</code> is a value between zero and N-1, as described in <a class="el" href="group___o_c_p_l.html#gacbad1ca36a61246b439a25f28e7575fb" title="Returns the number of filters in the pipeline.">H5Pget_nfilters()</a>. The function will return a negative value if the filter number is out of range.</p>
<p>The structure of the <code>flags</code> argument is discussed in <a class="el" href="group___o_c_p_l.html#ga191c567ee50b2063979cdef156a768c5" title="Adds a filter to the filter pipeline.">H5Pset_filter()</a>.</p>
<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>
<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>
<dl class="section version"><dt>Version</dt><dd>1.8.5 Function extended to work with group creation property lists. </dd>
<dd>
1.8.0 N-bit and scale-offset filters added. </dd>
<dd>
1.8.0 Function <a class="el" href="_h5version_8h.html#a7e070dfec9cb3a3aaf9c188a987e6a15">H5Pget_filter()</a> renamed to <a class="el" href="#gacbd4f93aa7cd270668385440fb5873a1" title="Returns information about a filter in a pipeline (DEPRECATED)">H5Pget_filter1()</a> and deprecated in this release. </dd>
<dd>
1.6.4 <code>filter</code> parameter type changed to unsigned.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga351bb4dc44dae41344f18aab177f4cf1" name="ga351bb4dc44dae41344f18aab177f4cf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga351bb4dc44dae41344f18aab177f4cf1">◆ </a></span>H5Pget_filter_by_id1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_filter_by_id1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a></td> <td class="paramname"><span class="paramname"><em>id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int *</td> <td class="paramname"><span class="paramname"><em>flags</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>cd_nelmts</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>cd_values</em>[], </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>namelen</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char</td> <td class="paramname"><span class="paramname"><em>name</em>[]</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about the specified filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Filter identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>Bit vector specifying certain general properties of the filter </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">cd_nelmts</td><td>Number of elements in <code>cd_values</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cd_values</td><td>Auxiliary data for the filter </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">namelen</td><td>Anticipated number of characters in <code>name</code> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Name of the filter</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; Otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000074">Deprecated</a></b></dt><dd>As of HDF5-1.8 this function was deprecated in favor of <a class="el" href="group___o_c_p_l.html#ga2d5e9df5f0e93abae11ee5edd82fcec3" title="Returns information about the specified filter.">H5Pget_filter_by_id2()</a> or the macro <a class="el" href="_h5version_8h.html#ac7aa336e7b1b9033cea2448ba623951f">H5Pget_filter_by_id()</a>.</dd></dl>
<p><a class="el" href="#ga351bb4dc44dae41344f18aab177f4cf1" title="Returns information about the specified filter.">H5Pget_filter_by_id1()</a> returns information about a filter, specified in <code>id</code>, a filter identifier.</p>
<p><code>plist_id</code> must be a dataset or group creation property list and <code>id</code> must be in the associated filter pipeline.</p>
<p>The <code>id</code> and <code>flags</code> parameters are used in the same manner as described in the discussion of <a class="el" href="group___o_c_p_l.html#ga191c567ee50b2063979cdef156a768c5" title="Adds a filter to the filter pipeline.">H5Pset_filter()</a>.</p>
<p>Aside from the fact that they are used for output, the parameters <code>cd_nelmts</code> and <code>cd_values</code>[] are used in the same manner as described in the discussion of <a class="el" href="group___o_c_p_l.html#ga191c567ee50b2063979cdef156a768c5" title="Adds a filter to the filter pipeline.">H5Pset_filter()</a>. On input, the <code>cd_nelmts</code> parameter indicates the number of entries in the <code>cd_values</code>[] array allocated by the calling program; on exit it contains the number of values defined by the filter.</p>
<p>On input, the <code>namelen</code> parameter indicates the number of characters allocated for the filter name by the calling program in the array <code>name</code>[]. On exit <code>name</code>[] contains the name of the filter with one character of the name in each element of the array.</p>
<p>If the filter specified in <code>id</code> is not set for the property list, an error will be returned and this function will fail.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.5 Function extended to work with group creation property lists. </dd>
<dd>
1.8.0 Function <a class="el" href="_h5version_8h.html#ac7aa336e7b1b9033cea2448ba623951f">H5Pget_filter_by_id()</a> renamed to <a class="el" href="#ga351bb4dc44dae41344f18aab177f4cf1" title="Returns information about the specified filter.">H5Pget_filter_by_id1()</a> and deprecated in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga655530b0f40990507fedeef6b3068db3" name="ga655530b0f40990507fedeef6b3068db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga655530b0f40990507fedeef6b3068db3">◆ </a></span>H5Pget_layout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06e">H5D_layout_t</a> H5Pget_layout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the layout of the raw data for a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the layout type (a non-negative value) of a dataset creation property list if successful. Valid return values are:<ul>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea922bab7d90bea9d3a0bb9082e0ca334d">H5D_COMPACT</a>: Raw data is stored in the object header in the file.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea6161acec1a11680d488b5bb8694c79f1">H5D_CONTIGUOUS</a>: Raw data is stored separately from the object header in one contiguous chunk in the file.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06eadc846667d1f23d573964d22549e5f262">H5D_CHUNKED</a>: Raw data is stored separately from the object header in chunks in separate locations in the file.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea5c213e4ca5ea394669873ce66f558ad4">H5D_VIRTUAL</a>: Raw data is drawn from multiple datasets in different files. </li>
</ul>
</dd>
<dd>
Otherwise, returns a negative value indicating failure.</dd></dl>
<p><a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a> returns the layout of the raw data for a dataset. This function is only valid for dataset creation property lists.</p>
<p>Note that a compact storage layout may affect writing data to the dataset with parallel applications. See the <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> documentation for details.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.0 <a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea5c213e4ca5ea394669873ce66f558ad4">H5D_VIRTUAL</a> added in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga83dcce1ce110d1ff6eae0fb77d4a7c85" name="ga83dcce1ce110d1ff6eae0fb77d4a7c85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85">◆ </a></span>H5Pget_virtual_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_virtual_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>count</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the number of mappings for the virtual dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">count</td><td>The number of mappings</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a> gets the number of mappings for a virtual dataset that has the creation property list specified by <code>dcpl_id</code>.</p>
<dl class="section see"><dt>See also</dt><dd>Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="gaf50620fd5d83dc9ca1e5c3f374c5a952" name="gaf50620fd5d83dc9ca1e5c3f374c5a952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf50620fd5d83dc9ca1e5c3f374c5a952">◆ </a></span>H5Pget_virtual_dsetname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Pget_virtual_dsetname </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the name of a source dataset used in the mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Mapping index. The value of <code>index</code> is 0 (zero) or greater and less than <code>count</code> (0 ≤ <code>index</code> < <code>count</code>), where <code>count</code> is the number of mappings returned by <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>A buffer containing the name of the source dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size, in bytes, of the name buffer. Must be the size of the dataset name in bytes plus 1 for a NULL terminator</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the dataset name if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a> takes the dataset creation property list for the virtual dataset, <code>dcpl_id</code>, the mapping index, <code>index</code>, the size of the dataset name for a source dataset, <code>size</code>, and retrieves the name of the source dataset used in the mapping.</p>
<p>Up to <code>size</code> characters of the dataset name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.</p>
<p>If the length of the dataset name, which determines the required value of <code>size</code>, is unknown, a preliminary call to <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a> with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the dataset name. That value, plus 1 for a NULL terminator, must then be assigned to <code>size</code> for a second <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a> call, which will retrieve the actual dataset name.</p>
<dl class="section see"><dt>See also</dt><dd>Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga5c17780cc9a72a0f62d70f6138510afa" name="ga5c17780cc9a72a0f62d70f6138510afa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c17780cc9a72a0f62d70f6138510afa">◆ </a></span>H5Pget_virtual_filename()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Pget_virtual_filename </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the filename of a source dataset used in the mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Mapping index. The value of <code>index</code> is 0 (zero) or greater and less than <code>count</code> (0 ≤ <code>index</code> < <code>count</code>), where <code>count</code> is the number of mappings returned by <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>A buffer containing the name of the file containing the source dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size, in bytes, of the name buffer. Must be the size of the filename in bytes plus 1 for a NULL terminator</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the filename if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a> takes the dataset creation property list for the virtual dataset, <code>dcpl_id</code>, the mapping index, <code>index</code>, the size of the filename for a source dataset, <code>size</code>, and retrieves the name of the file for a source dataset used in the mapping.</p>
<p>Up to <code>size</code> characters of the filename are returned in <code>name</code>; additional characters, if any, are not returned to the user application.</p>
<p>If the length of the filename, which determines the required value of <code>size</code>, is unknown, a preliminary call to <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a> with the last two parameters set to NULL and zero respectively can be made. The return value of this call will be the size in bytes of the filename. That value, plus 1 for a NULL terminator, must then be assigned to <code>size</code> for a second <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a> call, which will retrieve the actual filename.</p>
<dl class="section see"><dt>See also</dt><dd>Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga8319e9386cdb9b3881a8b698edfc78fc" name="ga8319e9386cdb9b3881a8b698edfc78fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8319e9386cdb9b3881a8b698edfc78fc">◆ </a></span>H5Pget_virtual_srcspace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Pget_virtual_srcspace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a dataspace identifier for the selection within the source dataset used in the mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Mapping index. The value of <code>index</code> is 0 (zero) or greater and less than <code>count</code> (0 ≤ <code>index</code> < <code>count</code>), where <code>count</code> is the number of mappings returned by <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a valid dataspace identifier identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a> takes the dataset creation property list for the virtual dataset, <code>dcpl_id</code>, and the mapping index, <code>index</code>, and returns a dataspace identifier for the selection within the source dataset used in the mapping.</p>
<dl class="section see"><dt>See also</dt><dd>Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga6425cabbc055b66e218b4728d6eb911d" name="ga6425cabbc055b66e218b4728d6eb911d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6425cabbc055b66e218b4728d6eb911d">◆ </a></span>H5Pget_virtual_vspace()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Pget_virtual_vspace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a dataspace identifier for the selection within the virtual dataset used in the mapping. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>Mapping index. The value of <code>index</code> is 0 (zero) or greater and less than <code>count</code> (0 ≤ <code>index</code> < <code>count</code>), where <code>count</code> is the number of mappings returned by <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a valid dataspace identifier identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a> takes the dataset creation property list for the virtual dataset, <code>dcpl_id</code>, and the mapping index, <code>index</code>, and returns a dataspace identifier for the selection within the virtual dataset used in the mapping.</p>
<dl class="section see"><dt>See also</dt><dd>Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga85faefca58387bba409b65c470d7d851" name="ga85faefca58387bba409b65c470d7d851"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85faefca58387bba409b65c470d7d851">◆ </a></span>H5Pset_alloc_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_alloc_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2">H5D_alloc_time_t</a></td> <td class="paramname"><span class="paramname"><em>alloc_time</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the timing for storage space allocation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alloc_time</td><td>When to allocate dataset storage space</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> sets up the timing for the allocation of storage space for a dataset's raw data. This property is set in the dataset creation property list <code>plist_id</code>. Timing is specified in <code>alloc_time</code> with one of the following values:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a1eb65ed3b5c64ab8cb783492b28b6903">H5D_ALLOC_TIME_DEFAULT</a> </td><td>Allocate dataset storage space at the default time<br />
(Defaults differ by storage method.) </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a3c461ed83e0af151ef8c44ec232368b6">H5D_ALLOC_TIME_EARLY</a> </td><td>Allocate all space when the dataset is created<br />
(Default for compact datasets.) </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2ac898a96931fd3402d9e5646690c77636">H5D_ALLOC_TIME_INCR</a> </td><td><p class="starttd">Allocate space incrementally, as data is written to the dataset<br />
(Default for chunked storage datasets.)</p>
<ul>
<li>Chunked datasets: Storage space allocation for each chunk is deferred until data is written to the chunk. </li>
<li>Contiguous datasets: Incremental storage space allocation for contiguous data is treated as late allocation. </li>
<li>Compact datasets: Incremental allocation is not allowed with compact datasets; <a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> will return an error. </li>
</ul>
</td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aab70b464cf3c5fc931dce0c4fe98b3d2a7c5fcb6f9c8adecf455939c3d625b7e8">H5D_ALLOC_TIME_LATE</a> </td><td>Allocate all space when data is first written to the dataset<br />
(Default for contiguous datasets.) </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> is designed to work in concert with the dataset fill value and fill value write time properties, set with the functions <a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a> and <a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a>.</dd>
<dd>
See <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> for further cross-references.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga3584d592e377da3604b7604e266dcf5b" name="ga3584d592e377da3604b7604e266dcf5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3584d592e377da3604b7604e266dcf5b">◆ </a></span>H5Pset_chunk()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_chunk </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>ndims</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>dim</em>[]</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the size of the chunks used to store a chunked layout dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ndims</td><td>The number of dimensions of each chunk </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dim</td><td>An array defining the size, in dataset elements, of each chunk</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga3584d592e377da3604b7604e266dcf5b" title="Sets the size of the chunks used to store a chunked layout dataset.">H5Pset_chunk()</a> sets the size of the chunks used to store a chunked layout dataset. This function is only valid for dataset creation property lists.</p>
<p>The <code>ndims</code> parameter currently must be the same size as the rank of the dataset.</p>
<p>The values of the <code>dim</code> array define the size of the chunks to store the dataset's raw data. The unit of measure for <code>dim</code> values is dataset elements.</p>
<p>As a side-effect of this function, the layout of the dataset is changed to <a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06eadc846667d1f23d573964d22549e5f262">H5D_CHUNKED</a>, if it is not already so set.</p>
<dl class="section note"><dt>Note</dt><dd>Chunk size cannot exceed the size of a fixed-size dataset. For example, a dataset consisting of a 5x4 fixed-size array cannot be defined with 10x10 chunks. Chunk maximums:<ul>
<li>The maximum number of elements in a chunk is 2<sup>32</sup>-1 which is equal to 4,294,967,295. If the number of elements in a chunk is set via <a class="el" href="#ga3584d592e377da3604b7604e266dcf5b" title="Sets the size of the chunks used to store a chunked layout dataset.">H5Pset_chunk()</a> to a value greater than 2<sup>32</sup>-1, then <a class="el" href="#ga3584d592e377da3604b7604e266dcf5b" title="Sets the size of the chunks used to store a chunked layout dataset.">H5Pset_chunk()</a> will fail.</li>
<li>The maximum size for any chunk is 4GB. If a chunk that is larger than 4GB attempts to be written with <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a>, then <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> will fail.</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga8e60618d9030dc1b99ad9c8ff7867873" name="ga8e60618d9030dc1b99ad9c8ff7867873"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e60618d9030dc1b99ad9c8ff7867873">◆ </a></span>H5Pset_chunk_opts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_chunk_opts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>opts</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the edge chunk option in a dataset creation property list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">opts</td><td>Edge chunk option flag. Valid values are: <ul>
<li><a class="el" href="_h5_dpublic_8h.html#a9721f293efbd6b03ce91865a0e2ca74e">H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS</a> When enabled, filters are not applied to partial edge chunks. When disabled, partial edge chunks are filtered. Enabling this option will improve performance when appending to the dataset and, when compression filters are used, prevent reallocation of these chunks. Datasets created with this option enabled will be inaccessible with HDF5 library versions before Release 1.10. Default: <em>Disabled</em> </li>
<li>0 (zero) Disables option; partial edge chunks will be compressed.</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga8e60618d9030dc1b99ad9c8ff7867873" title="Sets the edge chunk option in a dataset creation property list.">H5Pset_chunk_opts()</a> sets the edge chunk option in the dataset creation property list <code>dcpl_id</code>.</p>
<p>The available option is detailed in the parameters section. Only chunks that are not completely filled by the dataset's dataspace are affected by this option. Such chunks are referred to as partial edge chunks.</p>
<p><b>Motivation:</b> <a class="el" href="#ga8e60618d9030dc1b99ad9c8ff7867873" title="Sets the edge chunk option in a dataset creation property list.">H5Pset_chunk_opts()</a> is used to specify storage options for chunks on the edge of a dataset's dataspace. This capability allows the user to tune performance in cases where the dataset size may not be a multiple of the chunk size and the handling of partial edge chunks can impact performance.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="gaf1f569bfc54552bdb9317d2b63318a0d" name="gaf1f569bfc54552bdb9317d2b63318a0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf1f569bfc54552bdb9317d2b63318a0d">◆ </a></span>H5Pset_deflate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_deflate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>level</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets deflate (GNU gzip) compression method and compression level. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Object creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>Compression level</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>If you are planning to use compression with parallel HDF5, ensure that calls to <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> and pass a dataset transfer property list with the MPI-IO collective option property set to <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a>.<br />
Note that data transformations are currently <b>not</b> supported when writing to datasets in parallel and with compression enabled.</dd></dl>
<p><a class="el" href="#gaf1f569bfc54552bdb9317d2b63318a0d" title="Sets deflate (GNU gzip) compression method and compression level.">H5Pset_deflate()</a> sets the deflate compression method and the compression level, <code>level</code>, for a dataset or group creation property list, <code>plist_id</code>.</p>
<p>The filter identifier set in the property list is <a class="el" href="_h5_zpublic_8h.html#a9e802e9612b3647e7d3ffe4ce3b8dcce">H5Z_FILTER_DEFLATE</a>.</p>
<p>The compression level, <code>level</code>, is a value from zero to nine, inclusive. A compression level of 0 (zero) indicates no compression; compression improves but speed slows progressively from levels 1 through 9:</p>
<table class="doxtable">
<tr>
<th>Compression Level </th><th>Gzip Action </th></tr>
<tr>
<td>0 </td><td>No compression </td></tr>
<tr>
<td>1 </td><td>Best compression speed; least compression </td></tr>
<tr>
<td>2 through 8 </td><td>Compression improves; speed degrades </td></tr>
<tr>
<td>9 </td><td>Best compression ratio; slowest speed </td></tr>
</table>
<p>Note that setting the compression level to 0 (zero) does not turn off use of the gzip filter; it simply sets the filter to perform no compression as it processes the data.</p>
<p>HDF5 relies on GNU gzip for this compression.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.5 Function extended to work with group creation property lists. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gaf5ae8c0257c02e3fbe50bde70b1eb8be" name="gaf5ae8c0257c02e3fbe50bde70b1eb8be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf5ae8c0257c02e3fbe50bde70b1eb8be">◆ </a></span>H5Pset_dset_no_attrs_hint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dset_no_attrs_hint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></td> <td class="paramname"><span class="paramname"><em>minimize</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the flag to create minimized dataset object headers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">minimize</td><td>Flag for indicating whether or not a dataset's object header will be minimized</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaf5ae8c0257c02e3fbe50bde70b1eb8be" title="Sets the flag to create minimized dataset object headers.">H5Pset_dset_no_attrs_hint()</a> sets the no dataset attributes hint setting for the dataset creation property list <code>dcpl_id</code>. Datasets created with the dataset creation property list <code>dcpl_id</code> will have their object headers minimized if the boolean flag <code>minimize</code> is set to true. By setting <code>minimize</code> to true, the library expects that no attributes will be added to the dataset. Attributes can be added, but they are appended with a continuation message, which can reduce performance.</p>
<p>This setting interacts with <a class="el" href="group___h5_f.html#gafc0166070f920f037e6b1a5c66e5464c" title="Sets the flag to create minimized dataset object headers.">H5Fset_dset_no_attrs_hint()</a>: if either is set to true, then the created dataset's object header will be minimized.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.5 </dd></dl>
</div>
</div>
<a id="ga85ff7c9c827fa524041cd58c199b77b8" name="ga85ff7c9c827fa524041cd58c199b77b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85ff7c9c827fa524041cd58c199b77b8">◆ </a></span>H5Pset_external()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_external </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">off_t</td> <td class="paramname"><span class="paramname"><em>offset</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an external file to the list of external files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of an external file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Offset, in bytes, from the beginning of the file to the location in the file where the data starts </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes reserved in the file for the data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p>The first call to <a class="el" href="#ga85ff7c9c827fa524041cd58c199b77b8" title="Adds an external file to the list of external files.">H5Pset_external()</a> sets the external storage property in the property list, thus designating that the dataset will be stored in one or more non-HDF5 file(s) external to the HDF5 file. This call also adds the file <code>name</code> as the first file in the list of external files. Subsequent calls to the function add the named file as the next file in the list.</p>
<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>
<p>The <code>size</code> argument specifies the number of bytes reserved for data in the external file. If <code>size</code> is set to <a class="el" href="_h5_fpublic_8h.html#a2a667df33694861e41d1b9eb3a55b373">H5F_UNLIMITED</a>, the external file can be of unlimited size and no more files can be added to the external files list. If <code>size</code> is set to 0 (zero), no external file will actually be created.</p>
<p>All of the external files for a given dataset must be specified with <a class="el" href="#ga85ff7c9c827fa524041cd58c199b77b8" title="Adds an external file to the list of external files.">H5Pset_external()</a> before <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> is called to create the dataset. If one these files does not exist on the system when <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> is called to write data to it, the library will create the file.</p>
<dl class="section note"><dt>Note</dt><dd>On Windows, off_t is typically a 32-bit signed long value, which limits the valid offset that can be set to 2 GiB.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga6bd822266b31f86551a9a1d79601b6a2" name="ga6bd822266b31f86551a9a1d79601b6a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6bd822266b31f86551a9a1d79601b6a2">◆ </a></span>H5Pset_fill_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_fill_time </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4a">H5D_fill_time_t</a></td> <td class="paramname"><span class="paramname"><em>fill_time</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the time when fill values are written to a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fill_time</td><td>When to write fill values to a dataset</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> sets up the timing for writing fill values to a dataset. This property is set in the dataset creation property list <code>plist_id</code>. Timing is specified in <code>fill_time</code> with one of the following values:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aa85b225308b0a277c4dd6fed7ee465a72">H5D_FILL_TIME_IFSET</a> </td><td>Write fill values to the dataset when storage space is allocated only if there is a user-defined fill value, i.e.,one set with <a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a>. (Default) </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aadd7bb84666434f7d1dc642e94c68eb28">H5D_FILL_TIME_ALLOC</a> </td><td>Write fill values to the dataset when storage space is allocated. </td></tr>
<tr>
<td><a class="el" href="_h5_dpublic_8h.html#aa39293626c4e68dd28b06c0dc84bde4aaa87fbf4f3ebf96f2f3effe7bf46c1528">H5D_FILL_TIME_NEVER</a> </td><td>Never write fill values to the dataset. </td></tr>
</table>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> is designed for coordination with the dataset fill value and dataset storage allocation time properties, set with the functions <a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a> and <a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a>. See <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> for further cross-references.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga4335bb45b35386daa837b4ff1b9cd4a4" name="ga4335bb45b35386daa837b4ff1b9cd4a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4335bb45b35386daa837b4ff1b9cd4a4">◆ </a></span>H5Pset_fill_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_fill_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>type_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the fill value for a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type_id</td><td>Datatype of <code>value</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Pointer to buffer containing value to use as fill value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a> sets the fill value for a dataset in the dataset creation property list. <code>value</code> is interpreted as being of datatype <code>type_id</code>. This datatype may differ from that of the dataset, but the HDF5 library must be able to convert <code>value</code> to the dataset datatype when the dataset is created.</p>
<p>The default fill value is 0 (zero), which is interpreted according to the actual dataset datatype.</p>
<p>Setting <code>value</code> to NULL indicates that the fill value is to be undefined.</p>
<dl class="section note"><dt>Note</dt><dd>Applications sometimes write data only to portions of an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. This function allows the user application to set that fill value; the functions <a class="el" href="group___h5_d.html#ga8d4a57e2b2b8c95cfecf6f75bdaa8343" title="Fills dataspace elements with a fill value in a memory buffer.">H5Dfill()</a> and <a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a>, respectively, provide the ability to apply the fill value on demand or to set up its automatic application.</dd>
<dd>
A fill value should be defined so that it is appropriate for the application. While the HDF5 default fill value is 0 (zero), it is often appropriate to use another value. It might be useful, for example, to use a value that is known to be impossible for the application to legitimately generate.</dd>
<dd>
<a class="el" href="#ga4335bb45b35386daa837b4ff1b9cd4a4" title="Sets the fill value for a dataset.">H5Pset_fill_value()</a> is designed to work in concert with <a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> and <a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a>. <a class="el" href="#ga85faefca58387bba409b65c470d7d851" title="Sets the timing for storage space allocation.">H5Pset_alloc_time()</a> and <a class="el" href="#ga6bd822266b31f86551a9a1d79601b6a2" title="Sets the time when fill values are written to a dataset.">H5Pset_fill_time()</a> govern the timing of dataset storage allocation and fill value write operations and can be important in tuning application performance.</dd>
<dd>
See <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> for further cross-references.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga75d80991a8f467e0d454c53a383ae7f9" name="ga75d80991a8f467e0d454c53a383ae7f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75d80991a8f467e0d454c53a383ae7f9">◆ </a></span>H5Pset_layout()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_layout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06e">H5D_layout_t</a></td> <td class="paramname"><span class="paramname"><em>layout</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the type of storage used to store the raw data for a dataset. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">layout</td><td>Type of storage layout for raw data</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a> sets the type of storage used to store the raw data for a dataset. This function is only valid for dataset creation property lists.</p>
<p>Valid values for <code>layout</code> are:</p><ul>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea922bab7d90bea9d3a0bb9082e0ca334d">H5D_COMPACT</a>: Store raw data in the dataset object header in file. This should only be used for datasets with small amounts of raw data. The raw data size limit is 64K (65520 bytes). Attempting to create a dataset with raw data larger than this limit will cause the <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> call to fail.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea6161acec1a11680d488b5bb8694c79f1">H5D_CONTIGUOUS</a>: Store raw data separately from the object header in one large chunk in the file.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06eadc846667d1f23d573964d22549e5f262">H5D_CHUNKED</a>: Store raw data separately from the object header as chunks of data in separate locations in the file.</li>
<li><a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea5c213e4ca5ea394669873ce66f558ad4">H5D_VIRTUAL</a>: Draw raw data from multiple datasets in different files.</li>
</ul>
<p>Note that a compact storage layout may affect writing data to the dataset with parallel applications. See the note in <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> documentation for details. </p><dl class="section version"><dt>Version</dt><dd>1.10.0 <a class="el" href="_h5_dpublic_8h.html#a57e163d4c263b585ca2d904996f5e06ea5c213e4ca5ea394669873ce66f558ad4">H5D_VIRTUAL</a> added in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gad58a9c0e766ef71d4075b2c2a755e91c" name="gad58a9c0e766ef71d4075b2c2a755e91c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad58a9c0e766ef71d4075b2c2a755e91c">◆ </a></span>H5Pset_nbit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_nbit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up the use of the N-Bit filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>If you are planning to use compression with parallel HDF5, ensure that calls to <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> and pass a dataset transfer property list with the MPI-IO collective option property set to <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a>.<br />
Note that data transformations are currently <b>not</b> supported when writing to datasets in parallel and with compression enabled.</dd></dl>
<p><a class="el" href="#gad58a9c0e766ef71d4075b2c2a755e91c" title="Sets up the use of the N-Bit filter.">H5Pset_nbit()</a> sets the N-Bit filter, <a class="el" href="_h5_zpublic_8h.html#a8cc463fa1979bd4bfa0dd9aa6a41e49d">H5Z_FILTER_NBIT</a>, in the dataset creation property list <code>plist_id</code>.</p>
<p>The HDF5 user can create an N-Bit datatype with the following code: </p><pre>
hid_t nbit_datatype = H5Tcopy(H5T_STD_I32LE);
H5Tset_precision(nbit_datatype, 16);
H5Tset_offset(nbit_datatype, 4);
</pre><p>In memory, one value of the N-Bit datatype in the above example will be stored on a little-endian machine as follows:</p>
<table class="doxtable">
<tr>
<td>byte 3 </td><td>byte 2 </td><td>byte 1 </td><td>byte 0 </td></tr>
<tr>
<td>???????? </td><td>????SPPP </td><td>PPPPPPPP </td><td>PPPP???? </td></tr>
</table>
<p>Note: S - sign bit, P - significant bit, ? - padding bit; For signed integer, the sign bit is included in the precision.</p>
<p>When data of the above datatype is stored on disk using the N-bit filter, all padding bits are chopped off and only significant bits are stored. The values on disk will be something like:</p>
<table class="doxtable">
<tr>
<td>1st value </td><td>2nd value </td><td>... </td></tr>
<tr>
<td>SPPPPPPPPPPPPPPP </td><td>SPPPPPPPPPPPPPPP </td><td>... </td></tr>
</table>
<p>The N-Bit filter is used effectively for compressing data of an N-Bit datatype as well as a compound and an array datatype with N-Bit fields. However, the datatype classes of the N-Bit datatype or the N-Bit field of the compound datatype or the array datatype are limited to integer or floating-point.</p>
<p>The N-Bit filter supports complex situations where a compound datatype contains member(s) of a compound datatype or an array datatype that has a compound datatype as the base type. However, it does not support the situation where an array datatype has a variable-length or variable-length string as its base datatype. The filter does support the situation where a variable-length or variable-length string is a member of a compound datatype.</p>
<p>The N-Bit filter allows all other HDF5 datatypes (such as time, string, bitfield, opaque, reference, enum, and variable length) to pass through as a no-op.</p>
<p>Like other I/O filters supported by the HDF5 library, application using the N-Bit filter must store data with chunked storage.</p>
<p>By nature, the N-Bit filter should not be used together with other I/O filters.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.8 Fortran subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga5c10165b670e0e984db431aee818cc7e" name="ga5c10165b670e0e984db431aee818cc7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c10165b670e0e984db431aee818cc7e">◆ </a></span>H5Pset_scaleoffset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_scaleoffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#ga53d85c0570e17f6e1ddbf569462b1516">H5Z_SO_scale_type_t</a></td> <td class="paramname"><span class="paramname"><em>scale_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>scale_factor</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up the use of the scale-offset filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">scale_type</td><td>Flag indicating compression method </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">scale_factor</td><td>Parameter related to scale. Must be non-negative</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>If you are planning to use compression with parallel HDF5, ensure that calls to <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> and pass a dataset transfer property list with the MPI-IO collective option property set to <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a>.<br />
Note that data transformations are currently <b>not</b> supported when writing to datasets in parallel and with compression enabled.</dd></dl>
<p><a class="el" href="#ga5c10165b670e0e984db431aee818cc7e" title="Sets up the use of the scale-offset filter.">H5Pset_scaleoffset()</a> sets the scale-offset filter, <a class="el" href="_h5_zpublic_8h.html#a745d2ccb4f7712ed78ef5e562e27d2ca">H5Z_FILTER_SCALEOFFSET</a>, for a dataset.</p>
<p>Generally speaking, scale-offset compression performs a scale and/or offset operation on each data value and truncates the resulting value to a minimum number of bits (MinBits) before storing it. The current scale-offset filter supports integer and floating-point datatypes.</p>
<p>For an integer datatype, the parameter <code>scale_type</code> should be set to <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516a9fc45fdf1844739c145130e8c324a3a3">H5Z_SO_INT</a> (2). The parameter <code>scale_factor</code> denotes MinBits. If the user sets it to H5Z_SO_INT_MINBITS_DEFAULT (0), the filter will calculate MinBits. If <code>scale_factor</code> is set to a positive integer, the filter does not do any calculation and just uses the number as MinBits. However, if the user gives a MinBits that is less than what would be generated by the filter, the compression will be lossy. Also, the MinBits supplied by the user cannot exceed the number of bits to store one value of the dataset datatype.</p>
<p>For a floating-point datatype, the filter adopts the GRiB data packing mechanism, which offers two alternate methods: E-scaling and D-scaling. Both methods are lossy compression. If the parameter <code>scale_type</code> is set to <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aa3d402f72492b3f34929fb2b99805adb">H5Z_SO_FLOAT_DSCALE</a> (0), the filter will use the D-scaling method; if it is set to <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aae52c95d077fdced352846e4f01bd826">H5Z_SO_FLOAT_ESCALE</a> (1), the filter will use the E-scaling method. Since only the D-scaling method is implemented, <code>scale_type</code> should be set to <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aa3d402f72492b3f34929fb2b99805adb">H5Z_SO_FLOAT_DSCALE</a> or 0.</p>
<p>When the D-scaling method is used, the original data is "D" scaled — multiplied by 10 to the power of <code>scale_factor</code>, and the "significant" part of the value is moved to the left of the decimal point. Care should be taken in setting the decimal <code>scale_factor</code> so that the integer part will have enough precision to contain the appropriate information of the data value. For example, if <code>scale_factor</code> is set to 2, the number 104.561 will be 10456.1 after "D" scaling. The last digit 1 is not "significant" and is thrown off in the process of rounding. The user should make sure that after "D" scaling and rounding, the data values are within the range that can be represented by the integer (same size as the floating-point type).</p>
<p>Valid values for scale_type are as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aa3d402f72492b3f34929fb2b99805adb">H5Z_SO_FLOAT_DSCALE</a> (0) </td><td>Floating-point type, using variable MinBits method </td></tr>
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aae52c95d077fdced352846e4f01bd826">H5Z_SO_FLOAT_ESCALE</a> (1) </td><td>Floating-point type, using fixed MinBits method </td></tr>
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516a9fc45fdf1844739c145130e8c324a3a3">H5Z_SO_INT</a> (2) </td><td>Integer type </td></tr>
</table>
<p>The meaning of <code>scale_factor</code> varies according to the value assigned to <code>scale_type:</code> </p>
<table class="doxtable">
<tr>
<th><code>scale_type</code> value </th><th><code>scale_factor</code> description </th></tr>
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aa3d402f72492b3f34929fb2b99805adb">H5Z_SO_FLOAT_DSCALE</a> </td><td>Denotes the decimal scale factor for D-scaling and can be positive, negative or zero. This is the current implementation of the library. </td></tr>
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516aae52c95d077fdced352846e4f01bd826">H5Z_SO_FLOAT_ESCALE</a> </td><td>Denotes MinBits for E-scaling and must be a positive integer. This is not currently implemented by the library. </td></tr>
<tr>
<td><a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gga53d85c0570e17f6e1ddbf569462b1516a9fc45fdf1844739c145130e8c324a3a3">H5Z_SO_INT</a> </td><td>Denotes MinBits and it should be a positive integer or <a class="el" href="group___s_c_a_l_e_o_f_f_s_e_t.html#gaac7e88f7af9f1c4a13420bf66cfc6b4d">H5Z_SO_INT_MINBITS_DEFAULT</a> (0). If it is less than 0, the library will reset it to 0 since it is not implemented. </td></tr>
</table>
<p>Like other I/O filters supported by the HDF5 library, an application using the scale-offset filter must store data with chunked storage.</p>
<dl class="section version"><dt>Version</dt><dd>1.8.8 Fortran90 subroutine introduced in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga31e09cb0bf2da2893eed8a72220e6521" name="ga31e09cb0bf2da2893eed8a72220e6521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga31e09cb0bf2da2893eed8a72220e6521">◆ </a></span>H5Pset_shuffle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_shuffle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up use of the shuffle filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>If you are planning to use compression with parallel HDF5, ensure that calls to <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> and pass a dataset transfer property list with the MPI-IO collective option property set to <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a>.<br />
Note that data transformations are currently <b>not</b> supported when writing to datasets in parallel and with compression enabled.</dd></dl>
<p><a class="el" href="#ga31e09cb0bf2da2893eed8a72220e6521" title="Sets up use of the shuffle filter.">H5Pset_shuffle()</a> sets the shuffle filter, <a class="el" href="_h5_zpublic_8h.html#aa723f1a71601bf22c95620a490ecf1af">H5Z_FILTER_SHUFFLE</a>, in the dataset creation property list <code>plist_id</code>. The shuffle filter de-interlaces a block of data by reordering the bytes. All the bytes from one consistent byte position of each data element are placed together in one block; all bytes from a second consistent byte position of each data element are placed together a second block; etc. For example, given three data elements of a 4-byte datatype stored as 012301230123, shuffling will re-order data as 000111222333. This can be a valuable step in an effective compression algorithm because the bytes in each byte position are often closely related to each other and putting them together can increase the compression ratio.</p>
<p>As implied above, the primary value of the shuffle filter lies in its coordinated use with a compression filter; it does not provide data compression when used alone. When the shuffle filter is applied to a dataset immediately prior to the use of a compression filter, the compression ratio achieved is often superior to that achieved by the use of a compression filter without the shuffle filter.</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga37de4b6071a94574cfab5cd6de9c3fc6" name="ga37de4b6071a94574cfab5cd6de9c3fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga37de4b6071a94574cfab5cd6de9c3fc6">◆ </a></span>H5Pset_szip()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_szip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>options_mask</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>pixels_per_block</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up use of the SZIP compression filter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">options_mask</td><td>A bit-mask conveying the desired SZIP options; Valid values are <a class="el" href="group___s_z_i_p.html#gaf55e168a1f7aaf8a94d820a2210fccb9">H5_SZIP_EC_OPTION_MASK</a> and <a class="el" href="group___s_z_i_p.html#ga688fde8106225adf9e6ccd2a168dec74">H5_SZIP_NN_OPTION_MASK</a>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">pixels_per_block</td><td>The number of pixels or data elements in each data block (max <a class="el" href="group___s_z_i_p.html#ga80441e433f29ebfbdae7c39ed6acad14">H5_SZIP_MAX_PIXELS_PER_BLOCK</a>)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>If you are planning to use compression with parallel HDF5, ensure that calls to <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> occur in collective mode. In other words, all MPI ranks (in the relevant communicator) call <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a> and pass a dataset transfer property list with the MPI-IO collective option property set to <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a>.<br />
Note that data transformations are currently <b>not</b> supported when writing to datasets in parallel and with compression enabled.</dd></dl>
<p><a class="el" href="#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip()</a> sets an SZIP compression filter, <a class="el" href="_h5_zpublic_8h.html#a421d9941c68ebb776573baeb9aa77cd2">H5Z_FILTER_SZIP</a>, for a dataset. SZIP is a compression method designed for use with scientific data.</p>
<p>Before proceeding, all users should review the “Limitations” section below.</p>
<p>Users familiar with SZIP outside the HDF5 context may benefit from reviewing the Note “For Users Familiar with SZIP in Other Contexts” below.</p>
<p>In the text below, the term pixel refers to an HDF5 data element. This terminology derives from SZIP compression's use with image data, where pixel referred to an image pixel.</p>
<p>The SZIP <code>bits_per_pixel</code> value (see Note, below) is automatically set, based on the HDF5 datatype. SZIP can be used with atomic datatypes that may have size of 8, 16, 32, or 64 bits. Specifically, a dataset with a datatype that is 8-, 16-, 32-, or 64-bit signed or unsigned integer; char; or 32- or 64-bit float can be compressed with SZIP. See Note, below, for further discussion of the SZIP <code>bits_per_pixel</code> setting.</p>
<p>SZIP options are passed in an options mask, <code>options_mask</code>, as follows.</p>
<table class="doxtable">
<tr>
<th>Option </th><th>Description (Mutually exclusive; select one) </th></tr>
<tr>
<td><a class="el" href="group___s_z_i_p.html#gaf55e168a1f7aaf8a94d820a2210fccb9">H5_SZIP_EC_OPTION_MASK</a> </td><td>Selects entropy coding method </td></tr>
<tr>
<td><a class="el" href="group___s_z_i_p.html#ga688fde8106225adf9e6ccd2a168dec74">H5_SZIP_NN_OPTION_MASK</a> </td><td>Selects nearest neighbor preprocessing followed by entropy coding </td></tr>
</table>
<p>The following guidelines can be used in determining which option to select:</p>
<ul>
<li>The entropy coding method, the EC option specified by <a class="el" href="group___s_z_i_p.html#gaf55e168a1f7aaf8a94d820a2210fccb9">H5_SZIP_EC_OPTION_MASK</a>, is best suited for data that has been processed. The EC method works best for small numbers.</li>
<li>The nearest neighbor coding method, the NN option specified by <a class="el" href="group___s_z_i_p.html#ga688fde8106225adf9e6ccd2a168dec74">H5_SZIP_NN_OPTION_MASK</a>, preprocesses the data then the applies EC method as above.</li>
</ul>
<p>Other factors may affect results, but the above criteria provides a good starting point for optimizing data compression.</p>
<p>SZIP compresses data block by block, with a user-tunable block size. This block size is passed in the parameter <code>pixels_per_block</code> and must be even and not greater than 32, with typical values being 8, 10, 16, or 32. This parameter affects compression ratio; the more pixel values vary, the smaller this number should be to achieve better performance.</p>
<p>In HDF5, compression can be applied only to chunked datasets. If <code>pixels_per_block</code> is bigger than the total number of elements in a dataset chunk, <a class="el" href="#ga37de4b6071a94574cfab5cd6de9c3fc6" title="Sets up use of the SZIP compression filter.">H5Pset_szip()</a> will succeed but the subsequent call to <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> will fail; the conflict can be detected only when the property list is used.</p>
<p>To achieve optimal performance for SZIP compression, it is recommended that a chunk's fastest-changing dimension be equal to N times <code>pixels_per_block</code> where N is the maximum number of blocks per scan line allowed by the SZIP library. In the current version of SZIP, N is set to 128.</p>
<p>SZIP compression is an optional HDF5 filter.</p>
<p><b>Limitations:</b> </p>
<ul>
<li>SZIP compression cannot be applied to compound, array, variable-length, enumeration, or any other user-defined datatypes. If an SZIP filter is set in a dataset creation property list used to create a dataset containing a non-allowed datatype, the call to <a class="el" href="group___h5_d.html#ga0647ba4bbd26d5230cc07f3a5685b2cf">H5Dcreate()</a> will fail; the conflict can be detected only when the property list is used.</li>
<li>Users should be aware that there are factors that affect one's rights and ability to use SZIP compression by reviewing the SZIP copyright notice. (This limitation does not apply to the libaec library).</li>
</ul>
<dl class="section note"><dt>Note</dt><dd><b> For Users Familiar with SZIP in Other Contexts: </b></dd>
<dd>
The following notes are of interest primarily to those who have used SZIP compression outside of the HDF5 context. In non-HDF5 applications, SZIP typically requires that the user application supply additional parameters:<ul>
<li><code>pixels_in_object</code>, the number of pixels in the object to be compressed</li>
<li><code>bits_per_pixel</code>, the number of bits per pixel</li>
<li><code>pixels_per_scanline</code>, the number of pixels per scan line</li>
</ul>
</dd>
<dd>
These values need not be independently supplied in the HDF5 environment as they are derived from the datatype and dataspace, which are already known. In particular, HDF5 sets <code>pixels_in_object</code> to the number of elements in a chunk and <code>bits_per_pixel</code> to the size of the element or pixel datatype.</dd>
<dd>
The following algorithm is used to set <code>pixels_per_scanline:</code> <ul>
<li>If the size of a chunk's fastest-changing dimension, size, is greater than 4K, set <code>pixels_per_scanline</code> to 128 times <code>pixels_per_block</code>.</li>
<li>If size is less than 4K but greater than <code>pixels_per_block</code>, set <code>pixels_per_scanline</code> to the minimum of size and 128 times <code>pixels_per_block</code>.</li>
<li>If size is less than <code>pixels_per_block</code> but greater than the number elements in the chunk, set <code>pixels_per_scanline</code> to the minimum of the number elements in the chunk and 128 times <code>pixels_per_block</code>.</li>
</ul>
</dd>
<dd>
The HDF5 datatype may have precision that is less than the full size of the data element, e.g., an 11-bit integer can be defined using <a class="el" href="group___a_t_o_m.html#gab0f4dccfc2fb47bf2c7e06c9bf84c1f7" title="Sets the precision of an atomic datatype.">H5Tset_precision()</a>. To a certain extent, SZIP can take advantage of the precision of the datatype to improve compression:<ul>
<li>If the HDF5 datatype size is 24-bit or less and the offset of the bits in the HDF5 datatype is zero (see <a class="el" href="group___a_t_o_m.html#gafd22e4b0aecbe6dad9a899c5bf567e2f" title="Sets the bit offset of the first significant bit.">H5Tset_offset()</a> or <a class="el" href="group___a_t_o_m.html#ga225f0b6d173f90d3696bb68b88ae07c1" title="Retrieves the bit offset of the first significant bit.">H5Tget_offset()</a>), the data is the in lowest N bits of the data element. In this case, the SZIP <code>bits_per_pixel</code> is set to the precision of the HDF5 datatype.</li>
<li>If the offset is not zero, the SZIP <code>bits_per_pixel</code> will be set to the number of bits in the full size of the data element.</li>
<li>If the HDF5 datatype precision is 25-bit to 32-bit, the SZIP <code>bits_per_pixel</code> will be set to 32.</li>
<li>If the HDF5 datatype precision is 33-bit to 64-bit, the SZIP <code>bits_per_pixel</code> will be set to 64.</li>
</ul>
</dd>
<dd>
HDF5 always modifies the options mask provided by the user to set up usage of RAW_OPTION_MASK, ALLOW_K13_OPTION_MASK, and one of LSB_OPTION_MASK or MSB_OPTION_MASK, depending on endianness of the datatype.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="gadec895092dbbedb94f85d9cacf8924f5" name="gadec895092dbbedb94f85d9cacf8924f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadec895092dbbedb94f85d9cacf8924f5">◆ </a></span>H5Pset_virtual()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_virtual </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>vspace_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>src_file_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>src_dset_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_space_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the mapping between virtual and source datasets. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dcpl_id</td><td>Dataset creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">vspace_id</td><td>The dataspace identifier with the selection within the virtual dataset applied, possibly an unlimited selection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_file_name</td><td>The name of the HDF5 file where the source dataset is located or a <code>"."</code> (period) for a source dataset in the same file. The file might not exist yet. The name can be specified using a C-style <code>printf</code> statement as described below. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_dset_name</td><td>The path to the HDF5 dataset in the file specified by <code>src_file_name</code>. The dataset might not exist yet. The dataset name can be specified using a C-style <code>printf</code> statement as described below. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_space_id</td><td>The source dataset's dataspace identifier with a selection applied, possibly an unlimited selection </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a> maps elements of the virtual dataset (VDS) described by the virtual dataspace identifier <code>vspace_id</code> to the elements of the source dataset described by the source dataset dataspace identifier <code>src_space_id</code>. The source dataset is identified by the name of the file where it is located, <code>src_file_name</code>, and the name of the dataset, <code>src_dset_name</code>.</p>
<dl class="section user"><dt>C-style <code>printf</code> Formatting Statements:</dt><dd>C-style <code>printf</code> formatting allows a pattern to be specified in the name of a source file or dataset. Strings for the file and dataset names are treated as literals except for the following substitutions: <table class="doxtable">
<tr>
<td><code>"%%"</code> </td><td>Replaced with a single <code>"%"</code> (percent) character. </td></tr>
<tr>
<td><code>"%<d>b"</code> </td><td>Where <code>"<d>"</code> is the virtual dataset dimension axis (0-based) and <code>"b"</code> indicates that the block count of the selection in that dimension should be used. The full expression (for example, <code>"%0b"</code>) is replaced with a single numeric value when the mapping is evaluated at VDS access time. Example code for many source and virtual dataset mappings is available in the "Examples of Source to Virtual Dataset Mapping" chapter in the <a href="https://portal.hdfgroup.org/display/HDF5/RFC+HDF5+Virtual+Dataset">RFC: HDF5 Virtual Dataset</a>. </td></tr>
</table>
If the printf form is used for the source file or dataset names, the selection in the source dataset's dataspace must be fixed-size.</dd></dl>
<dl class="section user"><dt>Source File Resolutions:</dt><dd>When a source dataset residing in a different file is accessed, the library will search for the source file <code>src_file_name</code> as described below: <ul>
<li>If <code>src_file_name</code> is a <code>"."</code> (period) then it refers to the file containing the virtual dataset. </li>
<li>If <code>src_file_name</code> is a relative pathname, the following steps are performed:<ul>
<li>The library will get the prefix(es) set in the environment variable <code>HDF5_VDS_PREFIX</code> and will try to prepend each prefix to <code>src_file_name</code> to form a new <code>src_file_name</code>. If the new <code>src_file_name</code> does not exist or if <code>HDF5_VDS_PREFIX</code> is not set, the library will get the prefix set via <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a> and prepend it to <code>src_file_name</code> to form a new <code>src_file_name</code>. If the new <code>src_file_name</code> does not exist or no prefix is being set by <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a> then the path of the file containing the virtual dataset is obtained. This path can be the absolute path or the current working directory plus the relative path of that file when it is created/opened. The library will prepend this path to <code>src_file_name</code> to form a new <code>src_file_name</code>.</li>
<li>If the new <code>src_file_name</code> does not exist, then the library will look for <code>src_file_name</code> and will return failure/success accordingly. </li>
</ul>
</li>
<li>If <code>src_file_name</code> is an absolute pathname, the library will first try to find <code>src_file_name</code>. If <code>src_file_name</code> does not exist, <code>src_file_name</code> is stripped of directory paths to form a new <code>src_file_name</code>. The search for the new <code>src_file_name</code> then follows the same steps as described above for a relative pathname. See examples below illustrating how <code>src_file_name</code> is stripped to form a new <code>src_file_name</code>. </li>
</ul>
</dd></dl>
<dl class="section user"><dt></dt><dd>Note that <code>src_file_name</code> is considered to be an absolute pathname when the following condition is true: <ul>
<li>For Unix, the first character of <code>src_file_name</code> is a slash (<code>/</code>).<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code>. </li>
<li>For Windows, there are 6 cases:<ol type="1">
<li><code>src_file_name</code> is an absolute drive with absolute pathname.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>src_file_name</code> is an absolute pathname without specifying drive name.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>src_file_name</code> is an absolute drive with relative pathname.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>tmp/A.h5</code>.</li>
<li><code>src_file_name</code> is in UNC (Uniform Naming Convention) format with server name, share name, and pathname.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>src_file_name</code> is in Long UNC (Uniform Naming Convention) format with server name, share name, and pathname.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>src_file_name</code> is in Long UNC (Uniform Naming Convention) format with an absolute drive and an absolute pathname.<br />
For example, consider a <code>src_file_name</code> of <code>/tmp/A.h5</code>. If that source file does not exist, the new <code>src_file_name</code> after stripping will be <code>A.h5</code></li>
</ol>
</li>
</ul>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a href="https://portal.hdfgroup.org/display/HDF5/Virtual+Dataset++-+VDS">Virtual Dataset Overview</a></dd>
<dd>
Supporting Functions: <a class="el" href="#ga655530b0f40990507fedeef6b3068db3" title="Returns the layout of the raw data for a dataset.">H5Pget_layout()</a>, <a class="el" href="#ga75d80991a8f467e0d454c53a383ae7f9" title="Sets the type of storage used to store the raw data for a dataset.">H5Pset_layout()</a>, <a class="el" href="group___h5_s.html#gabc974bbc041538a1d3032729df2ddfc0" title="Retrieves a regular hyperslab selection.">H5Sget_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga8a5bc33fae4be442093329f2cfec3f49" title="Determines if a hyperslab selection is regular.">H5Sis_regular_hyperslab()</a>, <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a> </dd>
<dd>
VDS Functions: <a class="el" href="#ga83dcce1ce110d1ff6eae0fb77d4a7c85" title="Gets the number of mappings for the virtual dataset.">H5Pget_virtual_count()</a>, <a class="el" href="#gaf50620fd5d83dc9ca1e5c3f374c5a952" title="Gets the name of a source dataset used in the mapping.">H5Pget_virtual_dsetname()</a>, <a class="el" href="#ga5c17780cc9a72a0f62d70f6138510afa" title="Gets the filename of a source dataset used in the mapping.">H5Pget_virtual_filename()</a>, <a class="el" href="group___d_a_p_l.html#ga9a48c80955877c20d53e8fd3f49a2995" title="Retrieves prefix applied to VDS source file paths.">H5Pget_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga833dfc6d9c87738c9d94b610e70a818f" title="Returns the maximum number of missing source files and/or datasets with the printf-style names when g...">H5Pget_virtual_printf_gap()</a>, <a class="el" href="#ga8319e9386cdb9b3881a8b698edfc78fc" title="Gets a dataspace identifier for the selection within the source dataset used in the mapping.">H5Pget_virtual_srcspace()</a>, <a class="el" href="group___d_a_p_l.html#ga7173663654b085e8583ab609c988b47c" title="Retrieves the view of a virtual dataset accessed with dapl_id.">H5Pget_virtual_view()</a>, <a class="el" href="#ga6425cabbc055b66e218b4728d6eb911d" title="Gets a dataspace identifier for the selection within the virtual dataset used in the mapping.">H5Pget_virtual_vspace()</a>, <a class="el" href="#gadec895092dbbedb94f85d9cacf8924f5" title="Sets the mapping between virtual and source datasets.">H5Pset_virtual()</a>, <a class="el" href="group___d_a_p_l.html#ga6816e0de35a335f636922c3cd5569819" title="Sets prefix to be applied to VDS source file paths.">H5Pset_virtual_prefix()</a>, <a class="el" href="group___d_a_p_l.html#ga8bb25e402e860133b8af3715e429bacf" title="Sets the maximum number of missing source files and/or datasets with the printf-style names when gett...">H5Pset_virtual_printf_gap()</a>, <a class="el" href="group___d_a_p_l.html#gac65520e7cd7748f93d94c4a42abd01b4" title="Sets the view of the virtual dataset (VDS) to include or exclude missing mapped elements.">H5Pset_virtual_view()</a></dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.10.2 A change was made to the method of searching for VDS source files. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
