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
|
<!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 Transfer 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.02a5732</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_x_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 Transfer Properties<div class="ingroups"><a class="el" href="group___h5_p.html">Property Lists (H5P)</a></div></div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use dataset transfer properties to customize certain aspects of reading and writing datasets such as transformations, MPI-IO I/O mode, error detection, etc. These properties are <em>not</em> persisted with datasets, and can be adjusted at runtime before a dataset is read or written. </p><div></div><div> <a class="anchor" id="table_dxpl_id"></a>
<table class="doxtable">
<caption border="1" style="background-color:whitesmoke;">Data transfer property list functions (H5P)</caption>
<tr>
<th>C Function </th><th>Purpose </th></tr>
<tr>
<td><a class="el" href="#ga51d126d64fa766d44160a95057a2c733" title="Sets B-tree split ratios for a dataset transfer property list.">H5Pset_btree_ratios</a>/<a class="el" href="#ga3f3df48ce44b6af7517654b23a37fa02" title="Gets B-tree split ratios for a dataset transfer property list.">H5Pget_btree_ratios</a> </td><td>Sets/gets B-tree split ratios for a dataset transfer property list. </td></tr>
<tr>
<td><a class="el" href="#ga777e8c171c9e462230a9fa40874b38ce" title="Sets type conversion and background buffers.">H5Pset_buffer</a> </td><td>Maximum size for the type conversion buffer and the background buffer. May also supply pointers to application-allocated buffers. </td></tr>
<tr>
<td><a class="el" href="#gaa8c317b6164ae22a6ddae4131bbbcd22" title="Sets a data transform expression.">H5Pset_data_transform</a>/<a class="el" href="#ga865b05218e704578fe8db0c9dec07b25" title="Retrieves a data transform expression.">H5Pget_data_transform</a> </td><td>Sets/gets a data transform expression. </td></tr>
<tr>
<td><a class="el" href="#gadd73dca2b824491cbe768028d7377b2f" title="Sets a hyperslab file selection for a dataset I/O operation.">H5Pset_dataset_io_hyperslab_selection</a> </td><td>Sets a hyperslab file selection for a dataset I/O operation. </td></tr>
<tr>
<td><a class="el" href="#ga0d95dfa506784acc9aed850c99713609" title="Sets the dataset transfer property list to enable or disable error detection when reading data.">H5Pset_edc_check</a>/<a class="el" href="#gabc2b1e2af542ac15ee1613f4f89117e1" title="Determines whether error-detection is enabled for dataset reads.">H5Pget_edc_check</a> </td><td>Sets/gets whether to enable error-detection when reading a dataset. </td></tr>
<tr>
<td><a class="el" href="#gad8c1582c86e3316c70b0658b3b8e2071" title="Sets number of I/O vectors to be read/written in hyperslab I/O.">H5Pset_hyper_vector_size</a> </td><td>set the number of "I/O vectors" (offset and length pairs) which are to be accumulated in memory before being issued to the lower levels of the library for reading or writing the actual data. </td></tr>
<tr>
<td><a class="el" href="#ga1890e730c34efa20cd6a5d1d2a0e8caa" title="Sets user-defined filter callback function.">H5Pset_filter_callback</a> </td><td>Sets user-defined filter callback function. </td></tr>
<tr>
<td><a class="el" href="#gad8c1582c86e3316c70b0658b3b8e2071" title="Sets number of I/O vectors to be read/written in hyperslab I/O.">H5Pset_hyper_vector_size</a>/<a class="el" href="#gaa55e7a6dd26a8df51b331febfeeb376b" title="Retrieves number of I/O vectors to be read/written in hyperslab I/O.">H5Pget_hyper_vector_size</a> </td><td>Sets/gets number of I/O vectors to be read/written in hyperslab I/O. </td></tr>
<tr>
<td><a class="el" href="#ga10a80b29444d933da1aa2003f46cf003" title="Sets user-defined datatype conversion callback function.">H5Pset_type_conv_cb</a>/<a class="el" href="#gae8c8557d303fa914b569da0182284e89" title="Gets user-defined datatype conversion callback function.">H5Pget_type_conv_cb</a> </td><td>Sets/gets user-defined datatype conversion callback function. </td></tr>
<tr>
<td><a class="el" href="#ga2220ab75de470b6a6d5b1173d12aa0cf" title="Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()">H5Pset_vlen_mem_manager</a>/<a class="el" href="#ga9de8cad8b5664a956d965fd9414c376e" title="Gets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()">H5Pget_vlen_mem_manager</a> </td><td>Sets/gets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread</a> and <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim</a>. </td></tr>
<tr>
<td><a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio</a>/<a class="el" href="#gab66eca0259c33d575b4050eebfb6f2cd" title="Returns the data transfer mode.">H5Pget_dxpl_mpio</a> </td><td>Sets/gets data transfer mode. </td></tr>
<tr>
<td><a class="el" href="#gadc911ad42f580ce2df327383188ed4ba" title="Sets a flag specifying linked-chunk I/O or multi-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt</a> </td><td>Sets a flag specifying linked-chunk I/O or multi-chunk I/O. </td></tr>
<tr>
<td><a class="el" href="#gaaf5f3432a7d1a1c3f8e3eee6a3dc9810" title="Sets a numeric threshold for linked-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt_num</a> </td><td>Sets a numeric threshold for linked-chunk I/O. </td></tr>
<tr>
<td><a class="el" href="#ga0b53b19c37bda96d3578ce38b3858ea3" title="Sets a ratio threshold for collective I/O.">H5Pset_dxpl_mpio_chunk_opt_ratio</a> </td><td>Sets a ratio threshold for collective I/O. </td></tr>
<tr>
<td><a class="el" href="#gacb30d14d1791ec7ff9ee73aa148a51a3" title="Sets low-level data transfer mode.">H5Pset_dxpl_mpio_collective_opt</a> </td><td>Sets a flag governing the use of independent versus collective I/O. </td></tr>
<tr>
<td><a class="el" href="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" title="Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (...">H5Pget_mpio_actual_chunk_opt_mode</a> </td><td>Gets the type of chunk optimization that HDF5 actually performed on the last parallel I/O call. </td></tr>
<tr>
<td><a class="el" href="#ga20efee54f7e69f5ececa0d3c752d3344" title="Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily...">H5Pget_mpio_actual_io_mode</a> </td><td>Gets the type of I/O that HDF5 actually performed on the last parallel I/O call. </td></tr>
<tr>
<td><a class="el" href="#ga29707de7c06733295086daa3a2db4979" title="Retrieves local and global causes that broke collective I/O on the last parallel I/O call.">H5Pget_mpio_no_collective_cause</a> </td><td>Gets local and global causes that broke collective I/O on the last parallel I/O call. </td></tr>
<tr>
<td><a class="el" href="#ga7d4d11c9c273d5a5ce2d174d66e4fa10" title="Sets the selection I/O mode.">H5Pset_selection_io</a>/<a class="el" href="#ga324f2407a698f376c9970331dd8c8d16" title="Retrieves the selection I/O mode.">H5Pget_selection_io</a> </td><td>Sets/gets the selection I/O mode. </td></tr>
<tr>
<td><a class="el" href="#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause</a> </td><td>Gets the cause for not performing selection or vector I/O on the last parallel I/O call. </td></tr>
<tr>
<td><a class="el" href="#ga252fe801869970c14a5e800a1ea7ab84" title="Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.">H5Pget_actual_selection_io_mode</a> </td><td>Gets the type(s) (scalar, vector, selection) of raw data I/O performed on the last I/O call. </td></tr>
<tr>
<td><a class="el" href="#ga6f65ca81d8a10015513a69fe76c5d542" title="Allows the library to modify the contents of the write buffer.">H5Pset_modify_write_buf</a>/<a class="el" href="#ga7a3e4d3f7b5c276873d00af3f92cdc22" title="Retrieves the "modify write buffer" property.">H5Pget_modify_write_buf</a> </td><td>Sets/gets a flag allowing the library to modify the contents of the write buffer. </td></tr>
<tr>
<td>H5Pset_preserve/H5Pget_preserve </td><td>No longer available, deprecated as it no longer has any effect. </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:ga001a22b64f60b815abf5de8b4776f09e" id="r_ga001a22b64f60b815abf5de8b4776f09e"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e">H5Pset_dxpl_mpio</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16">H5FD_mpio_xfer_t</a> xfer_mode)</td></tr>
<tr class="memdesc:ga001a22b64f60b815abf5de8b4776f09e"><td class="mdescLeft"> </td><td class="mdescRight">Sets data transfer mode. <br /></td></tr>
<tr class="separator:ga001a22b64f60b815abf5de8b4776f09e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab66eca0259c33d575b4050eebfb6f2cd" id="r_gab66eca0259c33d575b4050eebfb6f2cd"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gab66eca0259c33d575b4050eebfb6f2cd">H5Pget_dxpl_mpio</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16">H5FD_mpio_xfer_t</a> *xfer_mode)</td></tr>
<tr class="memdesc:gab66eca0259c33d575b4050eebfb6f2cd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the data transfer mode. <br /></td></tr>
<tr class="separator:gab66eca0259c33d575b4050eebfb6f2cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacb30d14d1791ec7ff9ee73aa148a51a3" id="r_gacb30d14d1791ec7ff9ee73aa148a51a3"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacb30d14d1791ec7ff9ee73aa148a51a3">H5Pset_dxpl_mpio_collective_opt</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8">H5FD_mpio_collective_opt_t</a> opt_mode)</td></tr>
<tr class="memdesc:gacb30d14d1791ec7ff9ee73aa148a51a3"><td class="mdescLeft"> </td><td class="mdescRight">Sets low-level data transfer mode. <br /></td></tr>
<tr class="separator:gacb30d14d1791ec7ff9ee73aa148a51a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadc911ad42f580ce2df327383188ed4ba" id="r_gadc911ad42f580ce2df327383188ed4ba"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gadc911ad42f580ce2df327383188ed4ba">H5Pset_dxpl_mpio_chunk_opt</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_f_dmpi_8h.html#aad0ca234af678f0f0976d810ee2bf246">H5FD_mpio_chunk_opt_t</a> opt_mode)</td></tr>
<tr class="memdesc:gadc911ad42f580ce2df327383188ed4ba"><td class="mdescLeft"> </td><td class="mdescRight">Sets a flag specifying linked-chunk I/O or multi-chunk I/O. <br /></td></tr>
<tr class="separator:gadc911ad42f580ce2df327383188ed4ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf5f3432a7d1a1c3f8e3eee6a3dc9810" id="r_gaaf5f3432a7d1a1c3f8e3eee6a3dc9810"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaf5f3432a7d1a1c3f8e3eee6a3dc9810">H5Pset_dxpl_mpio_chunk_opt_num</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, unsigned num_chunk_per_proc)</td></tr>
<tr class="memdesc:gaaf5f3432a7d1a1c3f8e3eee6a3dc9810"><td class="mdescLeft"> </td><td class="mdescRight">Sets a numeric threshold for linked-chunk I/O. <br /></td></tr>
<tr class="separator:gaaf5f3432a7d1a1c3f8e3eee6a3dc9810"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0b53b19c37bda96d3578ce38b3858ea3" id="r_ga0b53b19c37bda96d3578ce38b3858ea3"><td class="memItemLeft" align="right" valign="top">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0b53b19c37bda96d3578ce38b3858ea3">H5Pset_dxpl_mpio_chunk_opt_ratio</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, unsigned percent_num_proc_per_chunk)</td></tr>
<tr class="memdesc:ga0b53b19c37bda96d3578ce38b3858ea3"><td class="mdescLeft"> </td><td class="mdescRight">Sets a ratio threshold for collective I/O. <br /></td></tr>
<tr class="separator:ga0b53b19c37bda96d3578ce38b3858ea3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3f3df48ce44b6af7517654b23a37fa02" id="r_ga3f3df48ce44b6af7517654b23a37fa02"><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="#ga3f3df48ce44b6af7517654b23a37fa02">H5Pget_btree_ratios</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, double *left, double *middle, double *right)</td></tr>
<tr class="memdesc:ga3f3df48ce44b6af7517654b23a37fa02"><td class="mdescLeft"> </td><td class="mdescRight">Gets B-tree split ratios for a dataset transfer property list. <br /></td></tr>
<tr class="separator:ga3f3df48ce44b6af7517654b23a37fa02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1278b9979cc833e77d699cc878c6dab4" id="r_ga1278b9979cc833e77d699cc878c6dab4"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1278b9979cc833e77d699cc878c6dab4">H5Pget_buffer</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, void **tconv, void **bkg)</td></tr>
<tr class="memdesc:ga1278b9979cc833e77d699cc878c6dab4"><td class="mdescLeft"> </td><td class="mdescRight">Reads buffer settings. <br /></td></tr>
<tr class="separator:ga1278b9979cc833e77d699cc878c6dab4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga865b05218e704578fe8db0c9dec07b25" id="r_ga865b05218e704578fe8db0c9dec07b25"><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="#ga865b05218e704578fe8db0c9dec07b25">H5Pget_data_transform</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, char *expression, size_t size)</td></tr>
<tr class="memdesc:ga865b05218e704578fe8db0c9dec07b25"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a data transform expression. <br /></td></tr>
<tr class="separator:ga865b05218e704578fe8db0c9dec07b25"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabc2b1e2af542ac15ee1613f4f89117e1" id="r_gabc2b1e2af542ac15ee1613f4f89117e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_l_e_t_c_h_e_r32.html#ga5217bb01cd38dbfc4c5c8cad39c01a08">H5Z_EDC_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gabc2b1e2af542ac15ee1613f4f89117e1">H5Pget_edc_check</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:gabc2b1e2af542ac15ee1613f4f89117e1"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether error-detection is enabled for dataset reads. <br /></td></tr>
<tr class="separator:gabc2b1e2af542ac15ee1613f4f89117e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa55e7a6dd26a8df51b331febfeeb376b" id="r_gaa55e7a6dd26a8df51b331febfeeb376b"><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="#gaa55e7a6dd26a8df51b331febfeeb376b">H5Pget_hyper_vector_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fapl_id, size_t *size)</td></tr>
<tr class="memdesc:gaa55e7a6dd26a8df51b331febfeeb376b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves number of I/O vectors to be read/written in hyperslab I/O. <br /></td></tr>
<tr class="separator:gaa55e7a6dd26a8df51b331febfeeb376b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacca1a094d70c3b2277175145142fda10" id="r_gacca1a094d70c3b2277175145142fda10"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gacca1a094d70c3b2277175145142fda10">H5Pget_preserve</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:gacca1a094d70c3b2277175145142fda10"><td class="mdescLeft"> </td><td class="mdescRight">Checks status of the dataset transfer property list (<b>DEPRECATED</b>) <br /></td></tr>
<tr class="separator:gacca1a094d70c3b2277175145142fda10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae8c8557d303fa914b569da0182284e89" id="r_gae8c8557d303fa914b569da0182284e89"><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="#gae8c8557d303fa914b569da0182284e89">H5Pget_type_conv_cb</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_tpublic_8h.html#a8825c3dcb04c35a26f8709791b1fdb5e">H5T_conv_except_func_t</a> *op, void **operate_data)</td></tr>
<tr class="memdesc:gae8c8557d303fa914b569da0182284e89"><td class="mdescLeft"> </td><td class="mdescRight">Gets user-defined datatype conversion callback function. <br /></td></tr>
<tr class="separator:gae8c8557d303fa914b569da0182284e89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9de8cad8b5664a956d965fd9414c376e" id="r_ga9de8cad8b5664a956d965fd9414c376e"><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="#ga9de8cad8b5664a956d965fd9414c376e">H5Pget_vlen_mem_manager</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_m_mpublic_8h.html#a5fd832e4b7f42f93364153cb823e7ffa">H5MM_allocate_t</a> *alloc_func, void **alloc_info, <a class="el" href="_h5_m_mpublic_8h.html#aa34c7616be59673cfc3d63fa7d960f25">H5MM_free_t</a> *free_func, void **free_info)</td></tr>
<tr class="memdesc:ga9de8cad8b5664a956d965fd9414c376e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> and <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim()</a> <br /></td></tr>
<tr class="separator:ga9de8cad8b5664a956d965fd9414c376e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga51d126d64fa766d44160a95057a2c733" id="r_ga51d126d64fa766d44160a95057a2c733"><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="#ga51d126d64fa766d44160a95057a2c733">H5Pset_btree_ratios</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, double left, double middle, double right)</td></tr>
<tr class="memdesc:ga51d126d64fa766d44160a95057a2c733"><td class="mdescLeft"> </td><td class="mdescRight">Sets B-tree split ratios for a dataset transfer property list. <br /></td></tr>
<tr class="separator:ga51d126d64fa766d44160a95057a2c733"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga777e8c171c9e462230a9fa40874b38ce" id="r_ga777e8c171c9e462230a9fa40874b38ce"><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="#ga777e8c171c9e462230a9fa40874b38ce">H5Pset_buffer</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t size, void *tconv, void *bkg)</td></tr>
<tr class="memdesc:ga777e8c171c9e462230a9fa40874b38ce"><td class="mdescLeft"> </td><td class="mdescRight">Sets type conversion and background buffers. <br /></td></tr>
<tr class="separator:ga777e8c171c9e462230a9fa40874b38ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa8c317b6164ae22a6ddae4131bbbcd22" id="r_gaa8c317b6164ae22a6ddae4131bbbcd22"><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="#gaa8c317b6164ae22a6ddae4131bbbcd22">H5Pset_data_transform</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *expression)</td></tr>
<tr class="memdesc:gaa8c317b6164ae22a6ddae4131bbbcd22"><td class="mdescLeft"> </td><td class="mdescRight">Sets a data transform expression. <br /></td></tr>
<tr class="separator:gaa8c317b6164ae22a6ddae4131bbbcd22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0d95dfa506784acc9aed850c99713609" id="r_ga0d95dfa506784acc9aed850c99713609"><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="#ga0d95dfa506784acc9aed850c99713609">H5Pset_edc_check</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="group___f_l_e_t_c_h_e_r32.html#ga5217bb01cd38dbfc4c5c8cad39c01a08">H5Z_EDC_t</a> check)</td></tr>
<tr class="memdesc:ga0d95dfa506784acc9aed850c99713609"><td class="mdescLeft"> </td><td class="mdescRight">Sets the dataset transfer property list to enable or disable error detection when reading data. <br /></td></tr>
<tr class="separator:ga0d95dfa506784acc9aed850c99713609"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1890e730c34efa20cd6a5d1d2a0e8caa" id="r_ga1890e730c34efa20cd6a5d1d2a0e8caa"><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="#ga1890e730c34efa20cd6a5d1d2a0e8caa">H5Pset_filter_callback</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_zpublic_8h.html#a3b2331dc3dab96f25a94b6dd7675507c">H5Z_filter_func_t</a> func, void *op_data)</td></tr>
<tr class="memdesc:ga1890e730c34efa20cd6a5d1d2a0e8caa"><td class="mdescLeft"> </td><td class="mdescRight">Sets user-defined filter callback function. <br /></td></tr>
<tr class="separator:ga1890e730c34efa20cd6a5d1d2a0e8caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad8c1582c86e3316c70b0658b3b8e2071" id="r_gad8c1582c86e3316c70b0658b3b8e2071"><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="#gad8c1582c86e3316c70b0658b3b8e2071">H5Pset_hyper_vector_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, size_t size)</td></tr>
<tr class="memdesc:gad8c1582c86e3316c70b0658b3b8e2071"><td class="mdescLeft"> </td><td class="mdescRight">Sets number of I/O vectors to be read/written in hyperslab I/O. <br /></td></tr>
<tr class="separator:gad8c1582c86e3316c70b0658b3b8e2071"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae8b87209ba6a3943eb614b6dfe55e588" id="r_gae8b87209ba6a3943eb614b6dfe55e588"><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="#gae8b87209ba6a3943eb614b6dfe55e588">H5Pset_preserve</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> status)</td></tr>
<tr class="memdesc:gae8b87209ba6a3943eb614b6dfe55e588"><td class="mdescLeft"> </td><td class="mdescRight">Sets the dataset transfer property list <code>status</code>. <br /></td></tr>
<tr class="separator:gae8b87209ba6a3943eb614b6dfe55e588"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga10a80b29444d933da1aa2003f46cf003" id="r_ga10a80b29444d933da1aa2003f46cf003"><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="#ga10a80b29444d933da1aa2003f46cf003">H5Pset_type_conv_cb</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dxpl_id, <a class="el" href="_h5_tpublic_8h.html#a8825c3dcb04c35a26f8709791b1fdb5e">H5T_conv_except_func_t</a> op, void *operate_data)</td></tr>
<tr class="memdesc:ga10a80b29444d933da1aa2003f46cf003"><td class="mdescLeft"> </td><td class="mdescRight">Sets user-defined datatype conversion callback function. <br /></td></tr>
<tr class="separator:ga10a80b29444d933da1aa2003f46cf003"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2220ab75de470b6a6d5b1173d12aa0cf" id="r_ga2220ab75de470b6a6d5b1173d12aa0cf"><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="#ga2220ab75de470b6a6d5b1173d12aa0cf">H5Pset_vlen_mem_manager</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_m_mpublic_8h.html#a5fd832e4b7f42f93364153cb823e7ffa">H5MM_allocate_t</a> alloc_func, void *alloc_info, <a class="el" href="_h5_m_mpublic_8h.html#aa34c7616be59673cfc3d63fa7d960f25">H5MM_free_t</a> free_func, void *free_info)</td></tr>
<tr class="memdesc:ga2220ab75de470b6a6d5b1173d12aa0cf"><td class="mdescLeft"> </td><td class="mdescRight">Sets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> and <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim()</a> <br /></td></tr>
<tr class="separator:ga2220ab75de470b6a6d5b1173d12aa0cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" id="r_ga37ec8c3b3f1880ed6e1b300bc4ee9ed5"><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="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5">H5Pget_mpio_actual_chunk_opt_mode</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956">H5D_mpio_actual_chunk_opt_mode_t</a> *actual_chunk_opt_mode)</td></tr>
<tr class="memdesc:ga37ec8c3b3f1880ed6e1b300bc4ee9ed5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) <br /></td></tr>
<tr class="separator:ga37ec8c3b3f1880ed6e1b300bc4ee9ed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20efee54f7e69f5ececa0d3c752d3344" id="r_ga20efee54f7e69f5ececa0d3c752d3344"><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="#ga20efee54f7e69f5ececa0d3c752d3344">H5Pget_mpio_actual_io_mode</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0">H5D_mpio_actual_io_mode_t</a> *actual_io_mode)</td></tr>
<tr class="memdesc:ga20efee54f7e69f5ececa0d3c752d3344"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) <br /></td></tr>
<tr class="separator:ga20efee54f7e69f5ececa0d3c752d3344"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga29707de7c06733295086daa3a2db4979" id="r_ga29707de7c06733295086daa3a2db4979"><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="#ga29707de7c06733295086daa3a2db4979">H5Pget_mpio_no_collective_cause</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, uint32_t *local_no_collective_cause, uint32_t *global_no_collective_cause)</td></tr>
<tr class="memdesc:ga29707de7c06733295086daa3a2db4979"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves local and global causes that broke collective I/O on the last parallel I/O call. <br /></td></tr>
<tr class="separator:ga29707de7c06733295086daa3a2db4979"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadd73dca2b824491cbe768028d7377b2f" id="r_gadd73dca2b824491cbe768028d7377b2f"><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="#gadd73dca2b824491cbe768028d7377b2f">H5Pset_dataset_io_hyperslab_selection</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, unsigned rank, <a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a> op, const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> start[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> stride[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> count[], const <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> block[])</td></tr>
<tr class="memdesc:gadd73dca2b824491cbe768028d7377b2f"><td class="mdescLeft"> </td><td class="mdescRight">Sets a hyperslab file selection for a dataset I/O operation. <br /></td></tr>
<tr class="separator:gadd73dca2b824491cbe768028d7377b2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7d4d11c9c273d5a5ce2d174d66e4fa10" id="r_ga7d4d11c9c273d5a5ce2d174d66e4fa10"><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="#ga7d4d11c9c273d5a5ce2d174d66e4fa10">H5Pset_selection_io</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a> selection_io_mode)</td></tr>
<tr class="memdesc:ga7d4d11c9c273d5a5ce2d174d66e4fa10"><td class="mdescLeft"> </td><td class="mdescRight">Sets the selection I/O mode. <br /></td></tr>
<tr class="separator:ga7d4d11c9c273d5a5ce2d174d66e4fa10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga324f2407a698f376c9970331dd8c8d16" id="r_ga324f2407a698f376c9970331dd8c8d16"><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="#ga324f2407a698f376c9970331dd8c8d16">H5Pget_selection_io</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a> *selection_io_mode)</td></tr>
<tr class="memdesc:ga324f2407a698f376c9970331dd8c8d16"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the selection I/O mode. <br /></td></tr>
<tr class="separator:ga324f2407a698f376c9970331dd8c8d16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad6fa6bfa5956e8c0bd69c22bde65f84c" id="r_gad6fa6bfa5956e8c0bd69c22bde65f84c"><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="#gad6fa6bfa5956e8c0bd69c22bde65f84c">H5Pget_no_selection_io_cause</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, uint32_t *no_selection_io_cause)</td></tr>
<tr class="memdesc:gad6fa6bfa5956e8c0bd69c22bde65f84c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call. <br /></td></tr>
<tr class="separator:gad6fa6bfa5956e8c0bd69c22bde65f84c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga252fe801869970c14a5e800a1ea7ab84" id="r_ga252fe801869970c14a5e800a1ea7ab84"><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="#ga252fe801869970c14a5e800a1ea7ab84">H5Pget_actual_selection_io_mode</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, uint32_t *actual_selection_io_mode)</td></tr>
<tr class="memdesc:ga252fe801869970c14a5e800a1ea7ab84"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call. <br /></td></tr>
<tr class="separator:ga252fe801869970c14a5e800a1ea7ab84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6f65ca81d8a10015513a69fe76c5d542" id="r_ga6f65ca81d8a10015513a69fe76c5d542"><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="#ga6f65ca81d8a10015513a69fe76c5d542">H5Pset_modify_write_buf</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> modify_write_buf)</td></tr>
<tr class="memdesc:ga6f65ca81d8a10015513a69fe76c5d542"><td class="mdescLeft"> </td><td class="mdescRight">Allows the library to modify the contents of the write buffer. <br /></td></tr>
<tr class="separator:ga6f65ca81d8a10015513a69fe76c5d542"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a3e4d3f7b5c276873d00af3f92cdc22" id="r_ga7a3e4d3f7b5c276873d00af3f92cdc22"><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="#ga7a3e4d3f7b5c276873d00af3f92cdc22">H5Pget_modify_write_buf</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *modify_write_buf)</td></tr>
<tr class="memdesc:ga7a3e4d3f7b5c276873d00af3f92cdc22"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the "modify write buffer" property. <br /></td></tr>
<tr class="separator:ga7a3e4d3f7b5c276873d00af3f92cdc22"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga252fe801869970c14a5e800a1ea7ab84" name="ga252fe801869970c14a5e800a1ea7ab84"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga252fe801869970c14a5e800a1ea7ab84">◆ </a></span>H5Pget_actual_selection_io_mode()</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_actual_selection_io_mode </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">uint32_t *</td> <td class="paramname"><span class="paramname"><em>actual_selection_io_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">actual_selection_io_mode</td><td>A bitwise set value indicating the type(s) of I/O performed </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 user"><dt>Motivation:</dt><dd>A user can request selection I/O to be performed via a data transfer property list (DXPL). This can be used to enable collective I/O with type conversion, or with custom VFDs that support vector or selection I/O. However, there are conditions that can cause HDF5 to forgo selection or vector I/O and perform legacy (scalar) I/O instead. This function allows the user to determine which type or types of I/O were actually performed.</dd></dl>
<p><a class="el" href="#ga252fe801869970c14a5e800a1ea7ab84" title="Retrieves the type(s) of I/O that HDF5 actually performed on raw data during the last I/O call.">H5Pget_actual_selection_io_mode()</a> allows the user to determine which type(s) of I/O were actually performed on raw data during the last I/O operation which used <code>plist_id</code>. This property is set after all I/O is completed; if I/O fails, it will not be set.</p>
<p><a class="el" href="#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause()</a> can be used to determine the reason why selection or vector I/O was not performed.</p>
<p>Valid bitflags returned in <code>actual_selection_io_mode</code> are listed as follows.</p>
<ul>
<li><a class="el" href="_h5_ppublic_8h.html#a33a8e40afb222e4c7854ad9aaee140cb">H5D_SCALAR_IO</a> Scalar (or legacy MPIO) I/O was performed</li>
<li><a class="el" href="_h5_ppublic_8h.html#acde6ec06c2ba407bffd67335a82835ae">H5D_VECTOR_IO</a> Vector I/O was performed</li>
<li><a class="el" href="_h5_ppublic_8h.html#ad0795b084ee2432646a985523ff60ed1">H5D_SELECTION_IO</a> Selection I/O was performed</li>
</ul>
<p>0 or more of these can be present in <code>actual_selection_io_mode</code> in a bitwise fashion, since a single operation can trigger multiple instances of I/O, possibly with different types. A value of <code>0</code> indicates no raw data I/O was performed during the operation.</p>
<p>Be aware that this function will only include raw data I/O performed to/from disk as part of the last I/O operation. Any metadata I/O, including attribute and compact dataset I/O, is disregarded. It is also possible that data was cached in the dataset chunk cache or sieve buffer, which may prevent I/O from hitting the disk, and thereby prevent it from being counted by this function.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.3 </dd></dl>
</div>
</div>
<a id="ga3f3df48ce44b6af7517654b23a37fa02" name="ga3f3df48ce44b6af7517654b23a37fa02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3f3df48ce44b6af7517654b23a37fa02">◆ </a></span>H5Pget_btree_ratios()</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_btree_ratios </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">double *</td> <td class="paramname"><span class="paramname"><em>left</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *</td> <td class="paramname"><span class="paramname"><em>middle</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double *</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets B-tree split ratios for a dataset transfer 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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">left</td><td>The B-tree split ratio for left-most nodes </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">middle</td><td>The B-tree split ratio for right-most nodes and lone nodes </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">right</td><td>The B-tree split ratio for all other nodes </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="#ga3f3df48ce44b6af7517654b23a37fa02" title="Gets B-tree split ratios for a dataset transfer property list.">H5Pget_btree_ratios()</a> returns the B-tree split ratios for a dataset transfer property list.</p>
<p>The B-tree split ratios are returned through the non-NULL arguments <code>left</code>, <code>middle</code>, and <code>right</code>, as set by the <a class="el" href="#ga51d126d64fa766d44160a95057a2c733" title="Sets B-tree split ratios for a dataset transfer property list.">H5Pset_btree_ratios()</a> function.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga1278b9979cc833e77d699cc878c6dab4" name="ga1278b9979cc833e77d699cc878c6dab4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1278b9979cc833e77d699cc878c6dab4">◆ </a></span>H5Pget_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t H5Pget_buffer </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">void **</td> <td class="paramname"><span class="paramname"><em>tconv</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>bkg</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads buffer settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Identifier for the dataset transfer property list </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">tconv</td><td>Address of the pointer to application-allocated type conversion buffer </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">bkg</td><td>Address of the pointer to application-allocated background buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns buffer size, in bytes, if successful; otherwise 0 on failure.</dd></dl>
<p><a class="el" href="#ga1278b9979cc833e77d699cc878c6dab4" title="Reads buffer settings.">H5Pget_buffer()</a> reads values previously set with <a class="el" href="#ga777e8c171c9e462230a9fa40874b38ce" title="Sets type conversion and background buffers.">H5Pset_buffer()</a>.</p>
<dl class="section version"><dt>Version</dt><dd>1.6.0 The return type changed from <code>hsize_t</code> to <code>size_t</code>. </dd>
<dd>
1.4.0 The return type changed to <code>hsize_t</code>.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga865b05218e704578fe8db0c9dec07b25" name="ga865b05218e704578fe8db0c9dec07b25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga865b05218e704578fe8db0c9dec07b25">◆ </a></span>H5Pget_data_transform()</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_data_transform </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">char *</td> <td class="paramname"><span class="paramname"><em>expression</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>Retrieves a data transform expression. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Identifier of the property list or class </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">expression</td><td>Pointer to memory where the transform expression will be copied </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of bytes of the transform expression to copy to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Success: the size of the transform expression. Failure: a negative value.</dd></dl>
<p><a class="el" href="#ga865b05218e704578fe8db0c9dec07b25" title="Retrieves a data transform expression.">H5Pget_data_transform()</a> retrieves the data transform expression previously set in the dataset transfer property list <code>plist_id</code> by <a class="el" href="#gaa8c317b6164ae22a6ddae4131bbbcd22" title="Sets a data transform expression.">H5Pset_data_transform()</a>.</p>
<p><a class="el" href="#ga865b05218e704578fe8db0c9dec07b25" title="Retrieves a data transform expression.">H5Pget_data_transform()</a> can be used to both retrieve the transform expression and query its size.</p>
<p>If <code>expression</code> is non-NULL, up to <code>size</code> bytes of the data transform expression are written to the buffer. If <code>expression</code> is NULL, <code>size</code> is ignored, and the function does not write anything to the buffer. The function always returns the size of the data transform expression.</p>
<p>If 0 is returned for the size of the expression, no data transform expression exists for the property list.</p>
<p>If an error occurs, the buffer pointed to by <code>expression</code> is unchanged, and the function returns a negative value.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gab66eca0259c33d575b4050eebfb6f2cd" name="gab66eca0259c33d575b4050eebfb6f2cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab66eca0259c33d575b4050eebfb6f2cd">◆ </a></span>H5Pget_dxpl_mpio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pget_dxpl_mpio </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16">H5FD_mpio_xfer_t</a> *</td> <td class="paramname"><span class="paramname"><em>xfer_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the data transfer mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">xfer_mode</td><td>Transfer mode </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="#gab66eca0259c33d575b4050eebfb6f2cd" title="Returns the data transfer mode.">H5Pget_dxpl_mpio()</a> queries the data transfer mode currently set in the data transfer property list <code>dxpl_id</code>.</p>
<p>Upon return, <code>xfer_mode</code> contains the data transfer mode, if it is non-null.</p>
<p><a class="el" href="#gab66eca0259c33d575b4050eebfb6f2cd" title="Returns the data transfer mode.">H5Pget_dxpl_mpio()</a> is not a collective function.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gabc2b1e2af542ac15ee1613f4f89117e1" name="gabc2b1e2af542ac15ee1613f4f89117e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabc2b1e2af542ac15ee1613f4f89117e1">◆ </a></span>H5Pget_edc_check()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_l_e_t_c_h_e_r32.html#ga5217bb01cd38dbfc4c5c8cad39c01a08">H5Z_EDC_t</a> H5Pget_edc_check </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>Determines whether error-detection is enabled for dataset reads. </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 transfer property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns <code>H5Z_ENABLE_EDC</code> or <code>H5Z_DISABLE_EDC</code> if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gabc2b1e2af542ac15ee1613f4f89117e1" title="Determines whether error-detection is enabled for dataset reads.">H5Pget_edc_check()</a> queries the dataset transfer property list <code>plist</code> to determine whether error detection is enabled for data read operations.</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="gaa55e7a6dd26a8df51b331febfeeb376b" name="gaa55e7a6dd26a8df51b331febfeeb376b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa55e7a6dd26a8df51b331febfeeb376b">◆ </a></span>H5Pget_hyper_vector_size()</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_hyper_vector_size </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>fapl_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>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves number of I/O vectors to be read/written in hyperslab I/O. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fapl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Number of I/O vectors to accumulate in memory for I/O operations</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="#gaa55e7a6dd26a8df51b331febfeeb376b" title="Retrieves number of I/O vectors to be read/written in hyperslab I/O.">H5Pget_hyper_vector_size()</a> retrieves the number of I/O vectors to be accumulated in memory before being issued to the lower levels of the HDF5 library for reading or writing the actual data.</p>
<p>The number of I/O vectors set in the dataset transfer property list <code>fapl_id</code> is returned in <code>size</code>. Unless the default value is in use, <code>size</code> was previously set with a call to <a class="el" href="#gad8c1582c86e3316c70b0658b3b8e2071" title="Sets number of I/O vectors to be read/written in hyperslab I/O.">H5Pset_hyper_vector_size()</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga7a3e4d3f7b5c276873d00af3f92cdc22" name="ga7a3e4d3f7b5c276873d00af3f92cdc22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a3e4d3f7b5c276873d00af3f92cdc22">◆ </a></span>H5Pget_modify_write_buf()</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_modify_write_buf </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="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> *</td> <td class="paramname"><span class="paramname"><em>modify_write_buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the "modify write buffer" property. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">modify_write_buf</td><td>Whether the library can modify the contents of the write buffer</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="#ga7a3e4d3f7b5c276873d00af3f92cdc22" title="Retrieves the "modify write buffer" property.">H5Pget_modify_write_buf()</a> gets the "modify write buffer" property from the dataset transfer property list <code>plist_id</code>. This property determines whether the library is allowed to modify the contents of write buffers passed to HDF5 API routines that are passed <code>plist_id</code>. The default value for modify_write_buf is false.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.1 </dd></dl>
</div>
</div>
<a id="ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" name="ga37ec8c3b3f1880ed6e1b300bc4ee9ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5">◆ </a></span>H5Pget_mpio_actual_chunk_opt_mode()</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_mpio_actual_chunk_opt_mode </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_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956">H5D_mpio_actual_chunk_opt_mode_t</a> *</td> <td class="paramname"><span class="paramname"><em>actual_chunk_opt_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">actual_chunk_opt_mode</td><td>The type of chunk optimization performed by HDF5 </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 user"><dt>Motivation:</dt><dd>A user can request collective I/O via a data transfer property list (DXPL) that has been suitably modified with <a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio()</a>. However, HDF5 will sometimes ignore this request and perform independent I/O instead. This property allows the user to see what kind of I/O HDF5 actually performed. Used in conjunction with <a class="el" href="#ga20efee54f7e69f5ececa0d3c752d3344" title="Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily...">H5Pget_mpio_actual_io_mode()</a>, this property allows the user to determine exactly what HDF5 did when attempting collective I/O.</dd></dl>
<p><a class="el" href="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" title="Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (...">H5Pget_mpio_actual_chunk_opt_mode()</a> retrieves the type of chunk optimization performed when collective I/O was requested. This property is set before I/O takes place, and will be set even if I/O fails.</p>
<p>Valid values returned in <code>actual_chunk_opt_mode:</code> </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956">H5D_mpio_actual_chunk_opt_mode_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956aadaa21a8cd9cf87f1f2402713860d292">H5D_MPIO_NO_CHUNK_OPTIMIZATION</a> = 0,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956aad6c2490e65e0471e215051a6c389d17">H5D_MPIO_LINK_CHUNK</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956af9b13cc1511b7c60e9cacbb208fae2bf">H5D_MPIO_MULTI_CHUNK</a></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a3d1f48e6c05b649980ddc5837e227956">H5D_mpio_actual_chunk_opt_mode_t</a>;</div>
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
<dl class="section since"><dt>Since</dt><dd>1.8.8 </dd></dl>
</div>
</div>
<a id="ga20efee54f7e69f5ececa0d3c752d3344" name="ga20efee54f7e69f5ececa0d3c752d3344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20efee54f7e69f5ececa0d3c752d3344">◆ </a></span>H5Pget_mpio_actual_io_mode()</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_mpio_actual_io_mode </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_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0">H5D_mpio_actual_io_mode_t</a> *</td> <td class="paramname"><span class="paramname"><em>actual_io_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily the type requested) </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">actual_io_mode</td><td>The type of I/O performed by this process </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 user"><dt>Motivation:</dt><dd>A user can request collective I/O via a data transfer property list (DXPL) that has been suitably modified with <a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio()</a>. However, HDF5 will sometimes ignore this request and perform independent I/O instead. This property allows the user to see what kind of I/O HDF5 actually performed. Used in conjunction with <a class="el" href="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" title="Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (...">H5Pget_mpio_actual_chunk_opt_mode()</a>, this property allows the user to determine exactly HDF5 did when attempting collective I/O.</dd></dl>
<p><a class="el" href="#ga20efee54f7e69f5ececa0d3c752d3344" title="Retrieves the type of I/O that HDF5 actually performed on the last parallel I/O call (not necessarily...">H5Pget_mpio_actual_io_mode()</a> retrieves the type of I/O performed on the selection of the current process. This property is set after all I/O is completed; if I/O fails, it will not be set.</p>
<p>Valid values returned in <code>actual_io_mode:</code> </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0">H5D_mpio_actual_io_mode_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0ac73c5dc05dabbb1f1180acbf8b05244d">H5D_MPIO_NO_COLLECTIVE</a> = 0x0,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0add50abb515a7fe1743a0afdd33381edf">H5D_MPIO_CHUNK_INDEPENDENT</a> = 0x1,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0a4fd05ee6bda93e2c84e26927e6db85d1">H5D_MPIO_CHUNK_COLLECTIVE</a> = 0x2,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0af0a554189ea82866198b190b81195163">H5D_MPIO_CHUNK_MIXED</a> = 0x1 | 0x2,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0ae597207e7aca6c346e3c10ae1efcb856">H5D_MPIO_CONTIGUOUS_COLLECTIVE</a> = 0x4</div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0">H5D_mpio_actual_io_mode_t</a>;</div>
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
<dl class="section attention"><dt>Attention</dt><dd>All processes do not need to have the same value. For example, if I/O is being performed using the multi chunk optimization scheme, one process's selection may include only chunks accessed collectively, while another may include chunks accessed independently. In this case, the first process will report <a class="el" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0a4fd05ee6bda93e2c84e26927e6db85d1">H5D_MPIO_CHUNK_COLLECTIVE</a> while the second will report <a class="el" href="_h5_ppublic_8h.html#ac8d48e1c028c095549922410dfd6ccd0add50abb515a7fe1743a0afdd33381edf">H5D_MPIO_CHUNK_INDEPENDENT</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga29707de7c06733295086daa3a2db4979" title="Retrieves local and global causes that broke collective I/O on the last parallel I/O call.">H5Pget_mpio_no_collective_cause()</a>, <a class="el" href="#ga37ec8c3b3f1880ed6e1b300bc4ee9ed5" title="Retrieves the type of chunk optimization that HDF5 actually performed on the last parallel I/O call (...">H5Pget_mpio_actual_chunk_opt_mode()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.8 </dd></dl>
</div>
</div>
<a id="ga29707de7c06733295086daa3a2db4979" name="ga29707de7c06733295086daa3a2db4979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga29707de7c06733295086daa3a2db4979">◆ </a></span>H5Pget_mpio_no_collective_cause()</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_mpio_no_collective_cause </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">uint32_t *</td> <td class="paramname"><span class="paramname"><em>local_no_collective_cause</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *</td> <td class="paramname"><span class="paramname"><em>global_no_collective_cause</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves local and global causes that broke collective I/O on the last parallel I/O call. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">local_no_collective_cause</td><td>An enumerated set value indicating the causes that prevented collective I/O in the local process </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">global_no_collective_cause</td><td>An enumerated set value indicating the causes across all processes that prevented collective I/O </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 user"><dt>Motivation:</dt><dd>A user can request collective I/O via a data transfer property list (DXPL) that has been suitably modified with H5P_SET_DXPL_MPIO. However, there are conditions that can cause HDF5 to forgo collective I/O and perform independent I/O. Such causes can be different across the processes of a parallel application. This function allows the user to determine what caused the HDF5 library to skip collective I/O locally, that is in the local process, and globally, across all processes.</dd></dl>
<p><a class="el" href="#ga29707de7c06733295086daa3a2db4979" title="Retrieves local and global causes that broke collective I/O on the last parallel I/O call.">H5Pget_mpio_no_collective_cause()</a> serves two purposes. It can be used to determine whether collective I/O was used for the last preceding parallel I/O call. If collective I/O was not used, the function retrieves the local and global causes that broke collective I/O on that parallel I/O call. The properties retrieved by this function are set before I/O takes place and are retained even when I/O fails.</p>
<p>Valid values returned in <code>local_no_collective_cause</code> and <code>global_no_collective_cause</code> are as follows or, if there are multiple causes, a bitwise OR of the relevant causes; the numbers in the center column are the bitmask values: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331a">H5D_mpio_no_collective_cause_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa0821dfeb60a8e6d73debaccc563d616a">H5D_MPIO_COLLECTIVE</a> = 0x00,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aaa079102c96a7e8bf9c7dcfcc21af3c6f">H5D_MPIO_SET_INDEPENDENT</a> = 0x01,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa00f738f0ec29f370a1831363f5410e7b">H5D_MPIO_DATATYPE_CONVERSION</a> = 0x02,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa901b05ea8d429a38b8bdb00210a3c265">H5D_MPIO_DATA_TRANSFORMS</a> = 0x04,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa9787b345b9cd5d6428e27a686a7ec76f">H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED</a> = 0x08,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa1aac491a2cb28a07176a1478a7cf5c5d">H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES</a> = 0x10,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa82ac7aecdc41065593069145abb6361e">H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET</a> = 0x20,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa98d31452d729795e643df58e2d4b6428">H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED</a> = 0x40,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aacc3ebc601d073db2450ff6d9ed16f04a">H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE</a> = 0x80,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa1ede0cf180b7772012dded55861d13fa">H5D_MPIO_NO_SELECTION_IO</a> = 0x100,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331aa52d9e6baa304ccf36d6793e7ca58880e">H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE</a> = 0x200</div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331a">H5D_mpio_no_collective_cause_t</a>;</div>
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
<dl class="section attention"><dt>Attention</dt><dd>Each process determines whether it can perform collective I/O and broadcasts the result. Those results are combined to make a collective decision; collective I/O will be performed only if all processes can perform collective I/O.<br />
If collective I/O was not used, the causes that prevented it are reported by individual process by means of an enumerated set. The causes may differ among processes, so <a class="el" href="#ga29707de7c06733295086daa3a2db4979" title="Retrieves local and global causes that broke collective I/O on the last parallel I/O call.">H5Pget_mpio_no_collective_cause()</a> returns two property values. The first value is the one produced by the local process to report local causes. This local information is encoded in an enumeration, the <a class="el" href="_h5_ppublic_8h.html#aa6e23240b9aeac32d1491610b03b331a">H5D_mpio_no_collective_cause_t</a> described above, with all individual causes combined into a single enumeration value by means of a bitwise OR operation. The second value reports global causes; this global value is the result of a bitwise-OR operation across the values returned by all the processes.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.10 </dd></dl>
</div>
</div>
<a id="gad6fa6bfa5956e8c0bd69c22bde65f84c" name="gad6fa6bfa5956e8c0bd69c22bde65f84c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6fa6bfa5956e8c0bd69c22bde65f84c">◆ </a></span>H5Pget_no_selection_io_cause()</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_no_selection_io_cause </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">uint32_t *</td> <td class="paramname"><span class="paramname"><em>no_selection_io_cause</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">no_selection_io_cause</td><td>A bitwise set value indicating the relevant causes that prevented selection I/O from being performed </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 user"><dt>Motivation:</dt><dd>A user can request selection I/O to be performed via a data transfer property list (DXPL). This can be used to enable collective I/O with type conversion, or with custom VFDs that support vector or selection I/O. However, there are conditions that can cause HDF5 to forgo selection or vector I/O and perform legacy (scalar) I/O instead.</dd></dl>
<p><a class="el" href="#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause()</a> can be used to determine whether selection or vector I/O was applied for the last preceding I/O call. If selection or vector I/O was not used, this function retrieves the cause(s) that prevent selection or vector I/O to be performed on that I/O call. The properties retrieved by this function are set before I/O takes place and are retained even when I/O fails.</p>
<p>If a selection I/O request falls back to vector I/O, that is not considered "breaking" selection I/O by this function, since vector I/O still passes all information to the file driver in a single callback.</p>
<p>Valid values returned in <code>no_selection_io_cause</code> are listed as follows. If there are multiple causes, it is a bitwise OR of the relevant causes.</p>
<ul>
<li><a class="el" href="_h5_ppublic_8h.html#af95c664a7d81d6ba2afada57dbd68098">H5D_SEL_IO_DISABLE_BY_API</a> Selection I/O was not performed because the feature was disabled by the API</li>
<li><a class="el" href="_h5_ppublic_8h.html#a151ba957f8a2b49c7365214621dc73ae">H5D_SEL_IO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET</a> Selection I/O was not performed because the dataset was neither contiguous nor chunked</li>
<li><a class="el" href="_h5_ppublic_8h.html#a6dc7f66df0be55845aadff104e828e31">H5D_SEL_IO_CONTIGUOUS_SIEVE_BUFFER</a> Selection I/O was not performed because of sieve buffer for contiguous dataset</li>
<li><a class="el" href="_h5_ppublic_8h.html#ad926b5089244351e4efd11c23e288c61">H5D_SEL_IO_NO_VECTOR_OR_SELECTION_IO_CB</a> Selection I/O was not performed because the VFD does not have vector or selection I/O callback</li>
<li><a class="el" href="_h5_ppublic_8h.html#adbbb3738f3a693a30e325048f530f2a7">H5D_SEL_IO_PAGE_BUFFER</a> Selection I/O was not performed because of page buffer</li>
<li><a class="el" href="_h5_ppublic_8h.html#a6186546550fa3150f57ded76c05264b2">H5D_SEL_IO_DATASET_FILTER</a> Selection I/O was not performed because of dataset filters</li>
<li><a class="el" href="_h5_ppublic_8h.html#aa78649650e450cb310c768b6e5333b4e">H5D_SEL_IO_CHUNK_CACHE</a> Selection I/O was not performed because of chunk cache</li>
<li><a class="el" href="_h5_ppublic_8h.html#a367e3e52a64124928a24dd3664f94f2d">H5D_SEL_IO_TCONV_BUF_TOO_SMALL</a> Selection I/O was not performed because the type conversion buffer is too small</li>
<li><a class="el" href="_h5_ppublic_8h.html#a70f610a09605a2d228d3cff36d93f3ab">H5D_SEL_IO_BKG_BUF_TOO_SMALL</a> Selection I/O was not performed because the type conversion background buffer is too small</li>
<li><a class="el" href="_h5_ppublic_8h.html#af6d12803003dfbaf21ceaad70decd098">H5D_SEL_IO_DEFAULT_OFF</a> Selection I/O was not performed because the selection I/O mode is DEFAULT and the library chose it to be off for this case</li>
</ul>
<dl class="section since"><dt>Since</dt><dd>1.14.1 </dd></dl>
</div>
</div>
<a id="gacca1a094d70c3b2277175145142fda10" name="gacca1a094d70c3b2277175145142fda10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacca1a094d70c3b2277175145142fda10">◆ </a></span>H5Pget_preserve()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int H5Pget_preserve </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>Checks status of the dataset transfer property list (<b>DEPRECATED</b>) </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000068">Deprecated</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Identifier for the dataset transfer property list</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 or 0 if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="#gacca1a094d70c3b2277175145142fda10" title="Checks status of the dataset transfer property list (DEPRECATED)">H5Pget_preserve()</a> checks the status of the dataset transfer property list.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.6.0 The flag parameter was changed from INTEGER to LOGICAL to better match the C API. (Fortran 90) </dd>
<dd>
1.8.2 Deprecated. </dd></dl>
</div>
</div>
<a id="ga324f2407a698f376c9970331dd8c8d16" name="ga324f2407a698f376c9970331dd8c8d16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga324f2407a698f376c9970331dd8c8d16">◆ </a></span>H5Pget_selection_io()</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_selection_io </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_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a> *</td> <td class="paramname"><span class="paramname"><em>selection_io_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the selection I/O mode. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">selection_io_mode</td><td>The selection I/O mode</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="#ga324f2407a698f376c9970331dd8c8d16" title="Retrieves the selection I/O mode.">H5Pget_selection_io()</a> queries the selection I/O mode set in in the dataset transfer property list <code>plist_id</code>.</p>
<p>Values returned in <code>selection_io_mode:</code> </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795a69dfe00660babb8a8f8abb29ba5210e7">H5D_SELECTION_IO_MODE_DEFAULT</a> = 0,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795a45fa23a7883df7239cfe4f36a97b99d8">H5D_SELECTION_IO_MODE_OFF</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795ad38fb01652ffe7ef8601455483ab809e">H5D_SELECTION_IO_MODE_ON</a></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a>;</div>
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
<dl class="section note"><dt>Note</dt><dd>The library may not perform selection I/O as it asks for if the layout callback determines that it is not feasible to do so. Please refer to <a class="el" href="#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause()</a> for details.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.14.1 </dd></dl>
</div>
</div>
<a id="gae8c8557d303fa914b569da0182284e89" name="gae8c8557d303fa914b569da0182284e89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8c8557d303fa914b569da0182284e89">◆ </a></span>H5Pget_type_conv_cb()</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_type_conv_cb </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_tpublic_8h.html#a8825c3dcb04c35a26f8709791b1fdb5e">H5T_conv_except_func_t</a> *</td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>operate_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets user-defined datatype conversion callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">op</td><td>User-defined type conversion callback function </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">operate_data</td><td>User-defined input data for the callback function</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="#gae8c8557d303fa914b569da0182284e89" title="Gets user-defined datatype conversion callback function.">H5Pget_type_conv_cb()</a> gets the user-defined datatype conversion callback function <code>op</code> in the dataset transfer property list <code>dxpl_id</code>.</p>
<p>The parameter <code>operate_data</code> is a pointer to user-defined input data for the callback function.</p>
<p>The callback function <code>op</code> defines the actions an application is to take when there is an exception during datatype conversion.</p>
<p>Please refer to the function <a class="el" href="#ga10a80b29444d933da1aa2003f46cf003" title="Sets user-defined datatype conversion callback function.">H5Pset_type_conv_cb()</a> for more details.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga9de8cad8b5664a956d965fd9414c376e" name="ga9de8cad8b5664a956d965fd9414c376e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9de8cad8b5664a956d965fd9414c376e">◆ </a></span>H5Pget_vlen_mem_manager()</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_vlen_mem_manager </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_m_mpublic_8h.html#a5fd832e4b7f42f93364153cb823e7ffa">H5MM_allocate_t</a> *</td> <td class="paramname"><span class="paramname"><em>alloc_func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>alloc_info</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_m_mpublic_8h.html#aa34c7616be59673cfc3d63fa7d960f25">H5MM_free_t</a> *</td> <td class="paramname"><span class="paramname"><em>free_func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>free_info</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> and <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim()</a> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Identifier for the dataset transfer property list </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">alloc_func</td><td>User's allocate routine, or NULL for system malloc </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">alloc_info</td><td>Extra parameter for user's allocation routine. Contents are ignored if preceding parameter is NULL</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">free_func</td><td>User's free routine, or NULL for system free</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">free_info</td><td>Extra parameter for user's free routine. Contents are ignored if preceding parameter is NULL</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="#ga9de8cad8b5664a956d965fd9414c376e" title="Gets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()">H5Pget_vlen_mem_manager()</a> is the companion function to <a class="el" href="#ga2220ab75de470b6a6d5b1173d12aa0cf" title="Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()">H5Pset_vlen_mem_manager()</a>, returning the parameters set by that function.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga51d126d64fa766d44160a95057a2c733" name="ga51d126d64fa766d44160a95057a2c733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga51d126d64fa766d44160a95057a2c733">◆ </a></span>H5Pset_btree_ratios()</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_btree_ratios </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">double</td> <td class="paramname"><span class="paramname"><em>left</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>middle</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double</td> <td class="paramname"><span class="paramname"><em>right</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets B-tree split ratios for a dataset transfer 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>The dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">left</td><td>The B-tree split ratio for left-most nodes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">middle</td><td>The B-tree split ratio for all other nodes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">right</td><td>The B-tree split ratio for right-most nodes and lone nodes</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="#ga51d126d64fa766d44160a95057a2c733" title="Sets B-tree split ratios for a dataset transfer property list.">H5Pset_btree_ratios()</a> sets the B-tree split ratios for a dataset transfer property list. The split ratios determine what percent of children go in the first node when a node splits.</p>
<p>The ratio <code>left</code> is used when the splitting node is the left-most node at its level in the tree; the ratio <code>right</code> is used when the splitting node is the right-most node at its level; and the ratio <code>middle</code> is used for all other cases.</p>
<p>A node that is the only node at its level in the tree uses the ratio <code>right</code> when it splits.</p>
<p>All ratios are real numbers between 0 and 1, inclusive.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="ga777e8c171c9e462230a9fa40874b38ce" name="ga777e8c171c9e462230a9fa40874b38ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga777e8c171c9e462230a9fa40874b38ce">◆ </a></span>H5Pset_buffer()</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_buffer </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">size_t</td> <td class="paramname"><span class="paramname"><em>size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>tconv</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>bkg</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets type conversion and background buffers. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size, in bytes, of the type conversion and background buffers </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tconv</td><td>Pointer to application-allocated type conversion buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bkg</td><td>Pointer to application-allocated background buffer </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>Given a dataset transfer property list, <a class="el" href="#ga777e8c171c9e462230a9fa40874b38ce" title="Sets type conversion and background buffers.">H5Pset_buffer()</a> sets the maximum size for the type conversion buffer and background buffer and optionally supplies pointers to application-allocated buffers. If the buffer size is smaller than the entire amount of data being transferred between the application and the file, and a type conversion buffer or background buffer is required, then strip mining will be used.</p>
<p>Note that there are minimum size requirements for the buffer. Strip mining can only break the data up along the first dimension, so the buffer must be large enough to accommodate a complete slice that encompasses all of the remaining dimensions. For example, when strip mining a <code>100x200x300</code> hyperslab of a simple data space, the buffer must be large enough to hold <code>1x200x300</code> data elements. When strip mining a <code>100x200x300x150</code> hyperslab of a simple data space, the buffer must be large enough to hold <code>1x200x300x150</code> data elements.</p>
<p>If <code>tconv</code> and/or <code>bkg</code> are null pointers, then buffers will be allocated and freed during the data transfer.</p>
<p>The default value for the maximum buffer is 1 MiB.</p>
<dl class="section version"><dt>Version</dt><dd>1.6.0 The <code>size</code> parameter has changed from type hsize_t to <code>size_t</code>. </dd>
<dd>
1.4.0 The <code>size</code> parameter has changed to type hsize_t.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.0.0 </dd></dl>
</div>
</div>
<a id="gaa8c317b6164ae22a6ddae4131bbbcd22" name="gaa8c317b6164ae22a6ddae4131bbbcd22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8c317b6164ae22a6ddae4131bbbcd22">◆ </a></span>H5Pset_data_transform()</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_data_transform </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>expression</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a data transform expression. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">expression</td><td>Pointer to the null-terminated data transform expression </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="#gaa8c317b6164ae22a6ddae4131bbbcd22" title="Sets a data transform expression.">H5Pset_data_transform()</a> sets the data transform to be used for reading and writing data. This function operates on the dataset transfer property list <code>plist_id</code>.</p>
<p>The <code>expression</code> parameter is a string containing an algebraic expression, such as <code>(5/9.0)*(x-32)</code> or <code>x*(x-5)</code>. When a dataset is read or written with this property list, the transform expression is applied with the <code>x</code> being replaced by the values in the dataset. When reading data, the values in the file are not changed and the transformed data is returned to the user.</p>
<p>Data transforms can only be applied to integer or floating-point datasets. Order of operations is obeyed and the only supported operations are +, -, *, and /. Parentheses can be nested arbitrarily and can be used to change precedence. When writing data back to the dataset, the transformed data is written to the file and there is no way to recover the original values to which the transform was applied.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gadd73dca2b824491cbe768028d7377b2f" name="gadd73dca2b824491cbe768028d7377b2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd73dca2b824491cbe768028d7377b2f">◆ </a></span>H5Pset_dataset_io_hyperslab_selection()</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_dataset_io_hyperslab_selection </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>rank</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_spublic_8h.html#a10093bab27cc5720efdab3186993da0f">H5S_seloper_t</a></td> <td class="paramname"><span class="paramname"><em>op</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>start</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>stride</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>count</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>block</em>[]</span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a hyperslab file selection for a dataset I/O operation. </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">rank</td><td>Number of dimensions of selection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>Operation to perform on current selection </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">start</td><td>Offset of start of hyperslab </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">stride</td><td>Hyperslab stride </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Number of blocks included in hyperslab </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>Size of block in hyperslab</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="#gadd73dca2b824491cbe768028d7377b2f" title="Sets a hyperslab file selection for a dataset I/O operation.">H5Pset_dataset_io_hyperslab_selection()</a> is designed to be used in conjunction with using <a class="el" href="_h5_spublic_8h.html#afee156939b96525e1b0026856f2288cf">H5S_PLIST</a> for the file dataspace ID when making a call to <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> or <a class="el" href="group___h5_d.html#ga98f44998b67587662af8b0d8a0a75906" title="Writes raw data from a buffer to a dataset.">H5Dwrite()</a>. When used with <a class="el" href="_h5_spublic_8h.html#afee156939b96525e1b0026856f2288cf">H5S_PLIST</a>, the selection created by one or more calls to this routine is used for determining which dataset elements to access.</p>
<p><code>rank</code> is the dimensionality of the selection and determines the size of the <code>start</code>, <code>stride</code>, <code>count</code>, and <code>block</code> arrays. <code>rank</code> must be between 1 and <a class="el" href="_h5_spublic_8h.html#a265cb2343f05cb71831119c90de31a8f">H5S_MAX_RANK</a>, inclusive.</p>
<p>The <code>op</code>, <code>start</code>, <code>stride</code>, <code>count</code>, and <code>block</code> parameters behave identically to their behavior for <a class="el" href="group___h5_s.html#ga6adfdf1b95dc108a65bf66e97d38536d" title="Selects a hyperslab region to add to the current selected region.">H5Sselect_hyperslab()</a>, please see the documentation for that routine for details about their use.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.0 </dd></dl>
</div>
</div>
<a id="ga001a22b64f60b815abf5de8b4776f09e" name="ga001a22b64f60b815abf5de8b4776f09e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga001a22b64f60b815abf5de8b4776f09e">◆ </a></span>H5Pset_dxpl_mpio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dxpl_mpio </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16">H5FD_mpio_xfer_t</a></td> <td class="paramname"><span class="paramname"><em>xfer_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets data transfer mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">xfer_mode</td><td>Transfer mode </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="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio()</a> sets the data transfer property list <code>dxpl_id</code> to use transfer mode <code>xfer_mode</code>. The property list can then be used to control the I/O transfer mode during data I/O operations.</p>
<p>Valid transfer modes are <a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16a6c67820a8798cd75a6f0ebbb44e9a2af">H5FD_MPIO_INDEPENDENT</a> (default) and <a class="el" href="_h5_f_dmpi_8h.html#a99bc5a964089fea144e7056b004bcc16a75d4dc80546ad3c16d2d7647ab267fab">H5FD_MPIO_COLLECTIVE</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gadc911ad42f580ce2df327383188ed4ba" name="gadc911ad42f580ce2df327383188ed4ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc911ad42f580ce2df327383188ed4ba">◆ </a></span>H5Pset_dxpl_mpio_chunk_opt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dxpl_mpio_chunk_opt </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_f_dmpi_8h.html#aad0ca234af678f0f0976d810ee2bf246">H5FD_mpio_chunk_opt_t</a></td> <td class="paramname"><span class="paramname"><em>opt_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a flag specifying linked-chunk I/O or multi-chunk I/O. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">opt_mode</td><td>Transfer mode </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="#gadc911ad42f580ce2df327383188ed4ba" title="Sets a flag specifying linked-chunk I/O or multi-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt()</a> specifies whether I/O is to be performed as linked-chunk I/O or as multi-chunk I/O. This function overrides the HDF5 library's internal algorithm for determining which mechanism to use.</p>
<p>When an application uses collective I/O with chunked storage, the HDF5 library normally uses an internal algorithm to determine whether that I/O activity should be conducted as one linked-chunk I/O or as multi-chunk I/O. <a class="el" href="#gadc911ad42f580ce2df327383188ed4ba" title="Sets a flag specifying linked-chunk I/O or multi-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt()</a> is provided so that an application can override the library's algorithm in circumstances where the library might lack the information needed to make an optimal decision.</p>
<p><a class="el" href="#gadc911ad42f580ce2df327383188ed4ba" title="Sets a flag specifying linked-chunk I/O or multi-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt()</a> works by setting one of the following flags in the parameter <code>opt_mode:</code> </p><ul>
<li><a class="el" href="_h5_f_dmpi_8h.html#aad0ca234af678f0f0976d810ee2bf246aff7d0c0869457b488871b64b3c173057">H5FD_MPIO_CHUNK_ONE_IO</a> - Do one-link chunked I/O</li>
<li><a class="el" href="_h5_f_dmpi_8h.html#aad0ca234af678f0f0976d810ee2bf246aa4c75c4d5abf261d58099c53e63e3b19">H5FD_MPIO_CHUNK_MULTI_IO</a> - Do multi-chunked I/O</li>
</ul>
<p>This function works by setting a corresponding property in the dataset transfer property list <code>dxpl_id</code>.</p>
<p>The library performs I/O in the specified manner unless it determines that the low-level MPI IO package does not support the requested behavior; in such cases, the HDF5 library will internally use independent I/O.</p>
<p>Use of this function is optional.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaaf5f3432a7d1a1c3f8e3eee6a3dc9810" name="gaaf5f3432a7d1a1c3f8e3eee6a3dc9810"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf5f3432a7d1a1c3f8e3eee6a3dc9810">◆ </a></span>H5Pset_dxpl_mpio_chunk_opt_num()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dxpl_mpio_chunk_opt_num </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>num_chunk_per_proc</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a numeric threshold for linked-chunk I/O. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">num_chunk_per_proc</td><td></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="#gaaf5f3432a7d1a1c3f8e3eee6a3dc9810" title="Sets a numeric threshold for linked-chunk I/O.">H5Pset_dxpl_mpio_chunk_opt_num()</a> sets a numeric threshold for the use of linked-chunk I/O.</p>
<p>The library will calculate the average number of chunks selected by each process when doing collective access with chunked storage. If the number is greater than the threshold set in <code>num_chunk_per_proc</code>, the library will use linked-chunk I/O; otherwise, a separate I/O process will be invoked for each chunk (multi-chunk I/O).</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0b53b19c37bda96d3578ce38b3858ea3" name="ga0b53b19c37bda96d3578ce38b3858ea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0b53b19c37bda96d3578ce38b3858ea3">◆ </a></span>H5Pset_dxpl_mpio_chunk_opt_ratio()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dxpl_mpio_chunk_opt_ratio </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned</td> <td class="paramname"><span class="paramname"><em>percent_num_proc_per_chunk</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a ratio threshold for collective I/O. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">percent_num_proc_per_chunk</td><td></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="#ga0b53b19c37bda96d3578ce38b3858ea3" title="Sets a ratio threshold for collective I/O.">H5Pset_dxpl_mpio_chunk_opt_ratio()</a> sets a threshold for the use of collective I/O based on the ratio of processes with collective access to a dataset with chunked storage. The decision whether to use collective I/O is made on a per-chunk basis.</p>
<p>The library will calculate the percentage of the total number of processes, the ratio, that hold selections in each chunk. If that percentage is greater than the threshold set in <code>percent_proc_per_chunk</code>, the library will do collective I/O for this chunk; otherwise, independent I/O will be done for the chunk.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gacb30d14d1791ec7ff9ee73aa148a51a3" name="gacb30d14d1791ec7ff9ee73aa148a51a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacb30d14d1791ec7ff9ee73aa148a51a3">◆ </a></span>H5Pset_dxpl_mpio_collective_opt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">H5_DLL <a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Pset_dxpl_mpio_collective_opt </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8">H5FD_mpio_collective_opt_t</a></td> <td class="paramname"><span class="paramname"><em>opt_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets low-level data transfer mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">opt_mode</td><td>Transfer mode </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="#gacb30d14d1791ec7ff9ee73aa148a51a3" title="Sets low-level data transfer mode.">H5Pset_dxpl_mpio_collective_opt()</a> sets the data transfer property list <code>dxpl_id</code> to use transfer mode <code>opt_mode</code> when performing I/O. This allows the application to specify collective I/O at the HDF5 interface level (with the <a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio()</a> API routine), while controlling whether the actual I/O is performed collectively (e.g., via MPI_File_write_at_all) or independently (e.g., via MPI_File_write_at). If the collectivity setting at the HDF5 interface level (set via <a class="el" href="#ga001a22b64f60b815abf5de8b4776f09e" title="Sets data transfer mode.">H5Pset_dxpl_mpio()</a>) is not set to H5FD_MPIO_COLLECTIVE, this setting will be ignored.</p>
<p>Valid transfer modes are <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8a3816f1011586f6f6f57ce6c2a6c2fcbe">H5FD_MPIO_COLLECTIVE_IO</a> (default) and <a class="el" href="_h5_f_dmpi_8h.html#afaf7d5667632176e8daca47549e29fb8aaacd91139f703159fde84fb5f7778886">H5FD_MPIO_INDIVIDUAL_IO</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga0d95dfa506784acc9aed850c99713609" name="ga0d95dfa506784acc9aed850c99713609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d95dfa506784acc9aed850c99713609">◆ </a></span>H5Pset_edc_check()</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_edc_check </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___f_l_e_t_c_h_e_r32.html#ga5217bb01cd38dbfc4c5c8cad39c01a08">H5Z_EDC_t</a></td> <td class="paramname"><span class="paramname"><em>check</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the dataset transfer property list to enable or disable error detection when reading data. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">check</td><td>Specifies whether error checking is enabled or disabled for dataset read operations </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="#ga0d95dfa506784acc9aed850c99713609" title="Sets the dataset transfer property list to enable or disable error detection when reading data.">H5Pset_edc_check()</a> sets the dataset transfer property list <code>plist</code> to enable or disable error detection when reading data.</p>
<p>Whether error detection is enabled or disabled is specified in the <code>check</code> parameter. Valid values are <a class="el" href="group___f_l_e_t_c_h_e_r32.html#gga5217bb01cd38dbfc4c5c8cad39c01a08ae1594c4d9c282b08461e6c1dd880dc2a">H5Z_ENABLE_EDC</a> (default) and <a class="el" href="group___f_l_e_t_c_h_e_r32.html#gga5217bb01cd38dbfc4c5c8cad39c01a08a0c21397694cd7ac1573b19b81c581c32">H5Z_DISABLE_EDC</a>.</p>
<dl class="section note"><dt>Note</dt><dd>The initial error detection implementation, Fletcher32 checksum, supports error detection for chunked datasets only.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>The Fletcher32 EDC checksum filter, set with <a class="el" href="group___o_c_p_l.html#ga8bc81abfbd0393b0a46e121f817a3f81" title="Sets up use of the Fletcher32 checksum filter.">H5Pset_fletcher32()</a>, was added in HDF5 Release 1.6.0. In the original implementation, however, the checksum value was calculated incorrectly on little-endian systems. The error was fixed in HDF5 Release 1.6.3.<br />
As a result of this fix, an HDF5 library of Release 1.6.0 through Release 1.6.2 cannot read a dataset created or written with Release 1.6.3 or later if the dataset was created with the checksum filter and the filter is enabled in the reading library. (Libraries of Release 1.6.3 and later understand the earlier error and compensate appropriately.)<br />
<b>Work-around:</b> An HDF5 library of Release 1.6.2 or earlier will be able to read a dataset created or written with the checksum filter by an HDF5 library of Release 1.6.3 or later if the checksum filter is disabled for the read operation. This can be accomplished via an <a class="el" href="#ga0d95dfa506784acc9aed850c99713609" title="Sets the dataset transfer property list to enable or disable error detection when reading data.">H5Pset_edc_check()</a> call with the value <a class="el" href="group___f_l_e_t_c_h_e_r32.html#gga5217bb01cd38dbfc4c5c8cad39c01a08a0c21397694cd7ac1573b19b81c581c32">H5Z_DISABLE_EDC</a> in the second parameter. This has the obvious drawback that the application will be unable to verify the checksum, but the data does remain accessible.</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.6.3 Error in checksum calculation on little-endian systems corrected in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga1890e730c34efa20cd6a5d1d2a0e8caa" name="ga1890e730c34efa20cd6a5d1d2a0e8caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1890e730c34efa20cd6a5d1d2a0e8caa">◆ </a></span>H5Pset_filter_callback()</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_filter_callback </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#a3b2331dc3dab96f25a94b6dd7675507c">H5Z_filter_func_t</a></td> <td class="paramname"><span class="paramname"><em>func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>op_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets user-defined filter callback function. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>User-defined filter callback function </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op_data</td><td>User-defined input data for the callback function </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="#ga1890e730c34efa20cd6a5d1d2a0e8caa" title="Sets user-defined filter callback function.">H5Pset_filter_callback()</a> sets the user-defined filter callback function <code>func</code> in the dataset transfer property list <code>plist_id</code>.</p>
<p>The parameter <code>op_data</code> is a pointer to user-defined input data for the callback function and will be passed through to the callback function.</p>
<p>The callback function <code>func</code> defines the actions an application is to take when a filter fails. The function prototype is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_enumeration" href="_h5_zpublic_8h.html#a868d4c5fa073332c69380d746351f078">H5Z_cb_return_t</a> (*<a class="code hl_typedef" href="_h5_zpublic_8h.html#a3b2331dc3dab96f25a94b6dd7675507c">H5Z_filter_func_t</a>)(<a class="code hl_typedef" href="_h5_zpublic_8h.html#afae8461c70d47e63be2163af23362237">H5Z_filter_t</a> filter, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> buf_size, <span class="keywordtype">void</span> *op_data);</div>
</div><!-- fragment --><p> where <code>filter</code> indicates which filter has failed, <code>buf</code> and <code>buf_size</code> are used to pass in the failed data, and op_data is the required input data for this callback function.</p>
<p>Valid callback function return values are <a class="el" href="_h5_zpublic_8h.html#a868d4c5fa073332c69380d746351f078a16fc9318a06ef5aa1e9d26b543c0f5c0">H5Z_CB_FAIL</a> and <a class="el" href="_h5_zpublic_8h.html#a868d4c5fa073332c69380d746351f078a6173e5f243ec2abbb36748fd82e8573f">H5Z_CB_CONT</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="gad8c1582c86e3316c70b0658b3b8e2071" name="gad8c1582c86e3316c70b0658b3b8e2071"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad8c1582c86e3316c70b0658b3b8e2071">◆ </a></span>H5Pset_hyper_vector_size()</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_hyper_vector_size </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">size_t</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets number of I/O vectors to be read/written in hyperslab I/O. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Number of I/O vectors to accumulate in memory for I/O operations<br />
Must be greater than 1 (one)<br />
Default value: 1024 </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="#gad8c1582c86e3316c70b0658b3b8e2071" title="Sets number of I/O vectors to be read/written in hyperslab I/O.">H5Pset_hyper_vector_size()</a> sets the number of I/O vectors to be accumulated in memory before being issued to the lower levels of the HDF5 library for reading or writing the actual data.</p>
<p>The I/O vectors are hyperslab offset and length pairs and are generated during hyperslab I/O.</p>
<p>The number of I/O vectors is passed in <code>size</code> to be set in the dataset transfer property list <code>plist_id</code>. <code>size</code> must be greater than 1 (one).</p>
<p><a class="el" href="#gad8c1582c86e3316c70b0658b3b8e2071" title="Sets number of I/O vectors to be read/written in hyperslab I/O.">H5Pset_hyper_vector_size()</a> is an I/O optimization function; increasing vector_size should provide better performance, but the library will use more memory during hyperslab I/O. The default value of <code>size</code> is 1024.</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga6f65ca81d8a10015513a69fe76c5d542" name="ga6f65ca81d8a10015513a69fe76c5d542"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6f65ca81d8a10015513a69fe76c5d542">◆ </a></span>H5Pset_modify_write_buf()</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_modify_write_buf </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="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></td> <td class="paramname"><span class="paramname"><em>modify_write_buf</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows the library to modify the contents of the write buffer. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">modify_write_buf</td><td>Whether the library can modify the contents of the write buffer</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="#ga6f65ca81d8a10015513a69fe76c5d542" title="Allows the library to modify the contents of the write buffer.">H5Pset_modify_write_buf()</a> sets whether the library is allowed to modify the contents of write buffers passed to HDF5 API routines that are passed the dataset transfer property list <code>plist_id</code>. The default value for modify_write_buf is false.</p>
<p>This function can be used to allow the library to perform in-place type conversion on write operations to save memory space. After making an API call with this parameter set to true, the contents of the write buffer are undefined.</p>
<dl class="section note"><dt>Note</dt><dd>When modify_write_buf is set to true the library may violate the const qualifier on the API parameter for the write buffer.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.14.1 </dd></dl>
</div>
</div>
<a id="gae8b87209ba6a3943eb614b6dfe55e588" name="gae8b87209ba6a3943eb614b6dfe55e588"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae8b87209ba6a3943eb614b6dfe55e588">◆ </a></span>H5Pset_preserve()</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_preserve </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="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a></td> <td class="paramname"><span class="paramname"><em>status</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the dataset transfer property list <code>status</code>. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>Status toggle of the dataset transfer 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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000069">Deprecated</a></b></dt><dd>This function is deprecated as it no longer has any effect; compound datatype field preservation is now core functionality in the HDF5 library.</dd></dl>
<p><a class="el" href="#gae8b87209ba6a3943eb614b6dfe55e588" title="Sets the dataset transfer property list status.">H5Pset_preserve()</a> sets the dataset transfer property list status to <code>1</code> or <code>0</code>.</p>
<p>When reading or writing compound datatypes and the destination is partially initialized and the read/write is intended to initialize the other members, one must set this property to <code>1</code>. Otherwise the I/O pipeline treats the destination datapoints as completely uninitialized.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.0</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.8.2 Deprecated. </dd></dl>
</div>
</div>
<a id="ga7d4d11c9c273d5a5ce2d174d66e4fa10" name="ga7d4d11c9c273d5a5ce2d174d66e4fa10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d4d11c9c273d5a5ce2d174d66e4fa10">◆ </a></span>H5Pset_selection_io()</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_selection_io </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_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a></td> <td class="paramname"><span class="paramname"><em>selection_io_mode</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the selection I/O mode. </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">selection_io_mode</td><td>The selection I/O mode to be set</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="#ga7d4d11c9c273d5a5ce2d174d66e4fa10" title="Sets the selection I/O mode.">H5Pset_selection_io()</a> sets the selection I/O mode <code>selection_io_mode</code> in the dataset transfer property list <code>plist_id</code>.</p>
<p>This can be used to enable collective I/O with type conversion, or with custom VFDs that support vector or selection I/O.</p>
<p>Values that can be set in <code>selection_io_mode:</code> </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a> {</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795a69dfe00660babb8a8f8abb29ba5210e7">H5D_SELECTION_IO_MODE_DEFAULT</a> = 0,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795a45fa23a7883df7239cfe4f36a97b99d8">H5D_SELECTION_IO_MODE_OFF</a>,</div>
<div class="line"> <a class="code hl_enumvalue" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795ad38fb01652ffe7ef8601455483ab809e">H5D_SELECTION_IO_MODE_ON</a></div>
<div class="line">} <a class="code hl_enumeration" href="_h5_ppublic_8h.html#a830b3ed265553177c07dd644f83ea795">H5D_selection_io_mode_t</a>;</div>
</div><!-- fragment --><p> (Click on a enumerator, field, or type for more information.)</p>
<dl class="section note"><dt>Note</dt><dd>The library may not perform selection I/O as it asks for if the layout callback determines that it is not feasible to do so. Please refer to <a class="el" href="#gad6fa6bfa5956e8c0bd69c22bde65f84c" title="Retrieves the cause for not performing selection or vector I/O on the last parallel I/O call.">H5Pget_no_selection_io_cause()</a> for details.</dd></dl>
<p>When used with type conversion, selection I/O requires the type conversion buffer (and the background buffer if applicable) be large enough to hold the entirety of the data involved in the I/O. For read operations, the library will use the application's read buffer as the type conversion buffer if the memory type is not smaller than the file type, eliminating the need for a separate type conversion buffer (a background buffer may still be required). For write operations, the library will similarly use the write buffer as a type conversion buffer, but only if <a class="el" href="#ga6f65ca81d8a10015513a69fe76c5d542" title="Allows the library to modify the contents of the write buffer.">H5Pset_modify_write_buf()</a> is used to allow the library to modify the contents of the write buffer.</p>
<dl class="section since"><dt>Since</dt><dd>1.14.1 </dd></dl>
</div>
</div>
<a id="ga10a80b29444d933da1aa2003f46cf003" name="ga10a80b29444d933da1aa2003f46cf003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10a80b29444d933da1aa2003f46cf003">◆ </a></span>H5Pset_type_conv_cb()</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_type_conv_cb </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>dxpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_tpublic_8h.html#a8825c3dcb04c35a26f8709791b1fdb5e">H5T_conv_except_func_t</a></td> <td class="paramname"><span class="paramname"><em>op</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>operate_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets user-defined datatype conversion callback function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dxpl_id</td><td>Dataset transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">op</td><td>User-defined type conversion callback function </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">operate_data</td><td>User-defined input data for the callback function </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="#ga10a80b29444d933da1aa2003f46cf003" title="Sets user-defined datatype conversion callback function.">H5Pset_type_conv_cb()</a> sets the user-defined datatype conversion callback function <code>op</code> in the dataset transfer property list <code>dxpl_id</code> </p>
<p>The parameter operate_data is a pointer to user-defined input data for the callback function and will be passed through to the callback function.</p>
<p>The callback function <code>op</code> defines the actions an application is to take when there is an exception during datatype conversion. The function prototype is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_enumeration" href="_h5_tpublic_8h.html#ab0559be2b5911fe789b6b6f1fe94419a">H5T_conv_ret_t</a> (*<a class="code hl_typedef" href="_h5_tpublic_8h.html#a8825c3dcb04c35a26f8709791b1fdb5e">H5T_conv_except_func_t</a>)(<a class="code hl_enumeration" href="_h5_tpublic_8h.html#ab9a2209f1ee5e5bf2b4f75affa9a195b">H5T_conv_except_t</a> except_type, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id,</div>
<div class="line"> <span class="keywordtype">void</span> *src_buf, <span class="keywordtype">void</span> *dst_buf, <span class="keywordtype">void</span> *user_data);</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga2220ab75de470b6a6d5b1173d12aa0cf" name="ga2220ab75de470b6a6d5b1173d12aa0cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2220ab75de470b6a6d5b1173d12aa0cf">◆ </a></span>H5Pset_vlen_mem_manager()</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_vlen_mem_manager </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_m_mpublic_8h.html#a5fd832e4b7f42f93364153cb823e7ffa">H5MM_allocate_t</a></td> <td class="paramname"><span class="paramname"><em>alloc_func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>alloc_info</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_m_mpublic_8h.html#aa34c7616be59673cfc3d63fa7d960f25">H5MM_free_t</a></td> <td class="paramname"><span class="paramname"><em>free_func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>free_info</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> and <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim()</a> </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 transfer property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alloc_func</td><td>User's allocate routine, or <code>NULL</code> for system <code>malloc</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alloc_info</td><td>Extra parameter for user's allocation routine. Contents are ignored if preceding parameter is <code>NULL</code>. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">free_func</td><td>User's free routine, or <code>NULL</code> for system <code>free</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">free_info</td><td>Extra parameter for user's free routine. Contents are ignored if preceding parameter is <code>NULL</code> </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="#ga2220ab75de470b6a6d5b1173d12aa0cf" title="Sets the memory manager for variable-length datatype allocation in H5Dread() and H5Dvlen_reclaim()">H5Pset_vlen_mem_manager()</a> sets the memory manager for variable-length datatype allocation in <a class="el" href="group___h5_d.html#ga8287d5a7be7b8e55ffeff68f7d26811c" title="Reads raw data from a dataset into a provided buffer.">H5Dread()</a> and free in <a class="el" href="group___h5_d.html#ga222a2fd93868e2524b2e42c3c6146119" title="Reclaims variable-length (VL) datatype memory buffers.">H5Dvlen_reclaim()</a>.</p>
<p>The <code>alloc_func</code> and <code>free_func</code> parameters identify the memory management routines to be used. If the user has defined custom memory management routines, <code>alloc_func</code> and/or free_func should be set to make those routine calls (i.e., the name of the routine is used as the value of the parameter); if the user prefers to use the system's <code>malloc</code> and/or <code>free</code>, the <code>alloc_func</code> and <code>free_func</code> parameters, respectively, should be set to <code>NULL</code> </p>
<p>The prototypes for these user-defined functions are as follows: </p><div class="fragment"></div><!-- fragment --><div class="fragment"></div><!-- fragment --><p>The <code>alloc_info</code> and <code>free_info</code> parameters can be used to pass along any required information to the user's memory management routines.</p>
<p>In summary, if the user has defined custom memory management routines, the name(s) of the routines are passed in the <code>alloc_func</code> and <code>free_func</code> parameters and the custom routines' parameters are passed in the <code>alloc_info</code> and <code>free_info</code> parameters. If the user wishes to use the system <code>malloc</code> and <code>free</code> functions, the <code>alloc_func</code> and/or <code>free_func</code> parameters are set to <code>NULL</code> and the <code>alloc_info</code> and <code>free_info</code> parameters are ignored.</p>
<dl class="section since"><dt>Since</dt><dd>1.0.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>
|
