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
|
<!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: Property List Class Root (Advanced)</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.2908dd1</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___p_l_c_r_a.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">Property List Class Root (Advanced)<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>You can create and customize user-defined property list classes using the functions described below. Arbitrary user-defined properties can also be inserted into existing property lists as so-called temporary properties. </p><div></div><div> <a class="anchor" id="table_plcra_id"></a>
<table class="doxtable">
<caption border="1" style="background-color:whitesmoke;">Property list class root (Advanced) functions (H5P)</caption>
<tr>
<th>Function </th><th>Purpose </th></tr>
<tr>
<td><a class="el" href="#gaa7978af06720106af04b9d034e57fcfa" title="Closes an existing property list class.">H5Pclose_class</a> </td><td>Closes an existing property list class. </td></tr>
<tr>
<td><a class="el" href="#ga339a27b865cf2d57ff95a6b26e94a581" title="Copies a property from one list or class to another.">H5Pcopy_prop</a> </td><td>Copies a property from one list or class to another. </td></tr>
<tr>
<td><a class="el" href="#ga62a1119b6ad2c33bcc9149df5e24ae12" title="Creates a new property list class.">H5Pcreate_class</a> </td><td>Creates a new property list class. </td></tr>
<tr>
<td><a class="el" href="#ga9425ef9f3bc3ee661eca6be654aeae20" title="Compares two property lists or classes for equality.">H5Pequal</a> </td><td>Compares two property lists or classes for equality. </td></tr>
<tr>
<td><a class="el" href="#gae135cf333c12375f3808cfe931ea9190" title="Queries whether a property name exists in a property list or class.">H5Pexist</a> </td><td>Queries whether a property name exists in a property list or class. </td></tr>
<tr>
<td><a class="el" href="#gac94a17bcb6d988a7ccb1cf2c6f4a3a82" title="Retrieves the name of a class.">H5Pget_class_name</a> </td><td>Retrieves the name of a class. </td></tr>
<tr>
<td><a class="el" href="#ga89f228c04207992d93fc3f2dddd860a5" title="Retrieves the parent class of a property class.">H5Pget_class_parent</a> </td><td>Retrieves the parent class of a property class. </td></tr>
<tr>
<td><a class="el" href="#ga13f41512715a8019e89529ea093c2c43" title="Queries the number of properties in a property list or class.">H5Pget_nprops</a> </td><td>Queries the number of properties in a property list or class. </td></tr>
<tr>
<td><a class="el" href="#gaaad1c5ad2069145e2f5397ce4ab3a93c" title="Queries the size of a property value in bytes.">H5Pget_size</a> </td><td>Queries the size of a property value in bytes. </td></tr>
<tr>
<td><a class="el" href="_h5version_8h.html#a9ccdea50538c7cfde87a9fa63ea68555">H5Pinsert</a> </td><td>Registers a temporary property with a property list. </td></tr>
<tr>
<td><a class="el" href="#ga68bc660e09b46dcb5ea3f25b245aff60" title="Determines whether a property list is a member of a class.">H5Pisa_class</a> </td><td>Determines whether a property list is a member of a class. </td></tr>
<tr>
<td><a class="el" href="#ga1c52aa0f6d1839798982973d7db9569e" title="Iterates over properties in a property class or list.">H5Piterate</a> </td><td>Iterates over properties in a property class or list </td></tr>
<tr>
<td><a class="el" href="_h5version_8h.html#a334ff323dfa6653ce21d0988ae7c73ba">H5Pregister</a>/<a class="el" href="#gaefb44d3535e309ba4041e420f3712aea" title="Removes a property from a property list class.">H5Punregister</a> </td><td>Registers/removes a permanent property with/from a property list class </td></tr>
<tr>
<td><a class="el" href="#ga2bf026d42a7823e89b6070a4cafc284b" title="Removes a property from a property list.">H5Premove</a> </td><td>Removes a property from a property list. </td></tr>
<tr>
<td><a class="el" href="#ga971d2f700cb98ccdfcdf93a39118983b" title="Sets a property list value.">H5Pset</a>/<a class="el" href="#ga40f1c3042011462c632844464a746db3" title="Queries the value of a property.">H5Pget</a> </td><td>Sets/queries a property list value </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:gaa7978af06720106af04b9d034e57fcfa" id="r_gaa7978af06720106af04b9d034e57fcfa"><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="#gaa7978af06720106af04b9d034e57fcfa">H5Pclose_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id)</td></tr>
<tr class="memdesc:gaa7978af06720106af04b9d034e57fcfa"><td class="mdescLeft"> </td><td class="mdescRight">Closes an existing property list class. <br /></td></tr>
<tr class="separator:gaa7978af06720106af04b9d034e57fcfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga339a27b865cf2d57ff95a6b26e94a581" id="r_ga339a27b865cf2d57ff95a6b26e94a581"><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="#ga339a27b865cf2d57ff95a6b26e94a581">H5Pcopy_prop</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_id, const char *name)</td></tr>
<tr class="memdesc:ga339a27b865cf2d57ff95a6b26e94a581"><td class="mdescLeft"> </td><td class="mdescRight">Copies a property from one list or class to another. <br /></td></tr>
<tr class="separator:ga339a27b865cf2d57ff95a6b26e94a581"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga62a1119b6ad2c33bcc9149df5e24ae12" id="r_ga62a1119b6ad2c33bcc9149df5e24ae12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga62a1119b6ad2c33bcc9149df5e24ae12">H5Pcreate_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> parent, const char *name, <a class="el" href="_h5_ppublic_8h.html#ada319197260febf9494b3b47aa68c7c6">H5P_cls_create_func_t</a> create, void *create_data, <a class="el" href="_h5_ppublic_8h.html#ac040a485e75e3c0f57f175253f98cc89">H5P_cls_copy_func_t</a> copy, void *copy_data, <a class="el" href="_h5_ppublic_8h.html#ae493e8a71e9d53b8ff9dbfa7c6bff91f">H5P_cls_close_func_t</a> close, void *close_data)</td></tr>
<tr class="memdesc:ga62a1119b6ad2c33bcc9149df5e24ae12"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new property list class. <br /></td></tr>
<tr class="separator:ga62a1119b6ad2c33bcc9149df5e24ae12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9425ef9f3bc3ee661eca6be654aeae20" id="r_ga9425ef9f3bc3ee661eca6be654aeae20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9425ef9f3bc3ee661eca6be654aeae20">H5Pequal</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id1, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id2)</td></tr>
<tr class="memdesc:ga9425ef9f3bc3ee661eca6be654aeae20"><td class="mdescLeft"> </td><td class="mdescRight">Compares two property lists or classes for equality. <br /></td></tr>
<tr class="separator:ga9425ef9f3bc3ee661eca6be654aeae20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae135cf333c12375f3808cfe931ea9190" id="r_gae135cf333c12375f3808cfe931ea9190"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae135cf333c12375f3808cfe931ea9190">H5Pexist</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name)</td></tr>
<tr class="memdesc:gae135cf333c12375f3808cfe931ea9190"><td class="mdescLeft"> </td><td class="mdescRight">Queries whether a property name exists in a property list or class. <br /></td></tr>
<tr class="separator:gae135cf333c12375f3808cfe931ea9190"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga40f1c3042011462c632844464a746db3" id="r_ga40f1c3042011462c632844464a746db3"><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="#ga40f1c3042011462c632844464a746db3">H5Pget</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name, void *value)</td></tr>
<tr class="memdesc:ga40f1c3042011462c632844464a746db3"><td class="mdescLeft"> </td><td class="mdescRight">Queries the value of a property. <br /></td></tr>
<tr class="separator:ga40f1c3042011462c632844464a746db3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac94a17bcb6d988a7ccb1cf2c6f4a3a82" id="r_gac94a17bcb6d988a7ccb1cf2c6f4a3a82"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#gac94a17bcb6d988a7ccb1cf2c6f4a3a82">H5Pget_class_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> pclass_id)</td></tr>
<tr class="memdesc:gac94a17bcb6d988a7ccb1cf2c6f4a3a82"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of a class. <br /></td></tr>
<tr class="separator:gac94a17bcb6d988a7ccb1cf2c6f4a3a82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga89f228c04207992d93fc3f2dddd860a5" id="r_ga89f228c04207992d93fc3f2dddd860a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga89f228c04207992d93fc3f2dddd860a5">H5Pget_class_parent</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> pclass_id)</td></tr>
<tr class="memdesc:ga89f228c04207992d93fc3f2dddd860a5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the parent class of a property class. <br /></td></tr>
<tr class="separator:ga89f228c04207992d93fc3f2dddd860a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga13f41512715a8019e89529ea093c2c43" id="r_ga13f41512715a8019e89529ea093c2c43"><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="#ga13f41512715a8019e89529ea093c2c43">H5Pget_nprops</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, size_t *nprops)</td></tr>
<tr class="memdesc:ga13f41512715a8019e89529ea093c2c43"><td class="mdescLeft"> </td><td class="mdescRight">Queries the number of properties in a property list or class. <br /></td></tr>
<tr class="separator:ga13f41512715a8019e89529ea093c2c43"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaad1c5ad2069145e2f5397ce4ab3a93c" id="r_gaaad1c5ad2069145e2f5397ce4ab3a93c"><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="#gaaad1c5ad2069145e2f5397ce4ab3a93c">H5Pget_size</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, const char *name, size_t *size)</td></tr>
<tr class="memdesc:gaaad1c5ad2069145e2f5397ce4ab3a93c"><td class="mdescLeft"> </td><td class="mdescRight">Queries the size of a property value in bytes. <br /></td></tr>
<tr class="separator:gaaad1c5ad2069145e2f5397ce4ab3a93c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga930e15d5f994e223bea80621ef3065d4" id="r_ga930e15d5f994e223bea80621ef3065d4"><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="#ga930e15d5f994e223bea80621ef3065d4">H5Pinsert2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name, size_t size, void *value, <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> set, <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> get, <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> prp_del, <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> copy, <a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a> compare, <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> close)</td></tr>
<tr class="memdesc:ga930e15d5f994e223bea80621ef3065d4"><td class="mdescLeft"> </td><td class="mdescRight">Registers a temporary property with a property list. <br /></td></tr>
<tr class="separator:ga930e15d5f994e223bea80621ef3065d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga68bc660e09b46dcb5ea3f25b245aff60" id="r_ga68bc660e09b46dcb5ea3f25b245aff60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga68bc660e09b46dcb5ea3f25b245aff60">H5Pisa_class</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> pclass_id)</td></tr>
<tr class="memdesc:ga68bc660e09b46dcb5ea3f25b245aff60"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a property list is a member of a class. <br /></td></tr>
<tr class="separator:ga68bc660e09b46dcb5ea3f25b245aff60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1c52aa0f6d1839798982973d7db9569e" id="r_ga1c52aa0f6d1839798982973d7db9569e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1c52aa0f6d1839798982973d7db9569e">H5Piterate</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, int *idx, <a class="el" href="_h5_ppublic_8h.html#a9d7a5c4938ce5732e469f1db706949fe">H5P_iterate_t</a> iter_func, void *iter_data)</td></tr>
<tr class="memdesc:ga1c52aa0f6d1839798982973d7db9569e"><td class="mdescLeft"> </td><td class="mdescRight">Iterates over properties in a property class or list. <br /></td></tr>
<tr class="separator:ga1c52aa0f6d1839798982973d7db9569e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac3f957a5d3cbb4adc8b7ba2aa5f1719" id="r_gaac3f957a5d3cbb4adc8b7ba2aa5f1719"><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="#gaac3f957a5d3cbb4adc8b7ba2aa5f1719">H5Pregister2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cls_id, const char *name, size_t size, void *def_value, <a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a> create, <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> set, <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> get, <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> prp_del, <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> copy, <a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a> compare, <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> close)</td></tr>
<tr class="memdesc:gaac3f957a5d3cbb4adc8b7ba2aa5f1719"><td class="mdescLeft"> </td><td class="mdescRight">Registers a permanent property with a property list class. <br /></td></tr>
<tr class="separator:gaac3f957a5d3cbb4adc8b7ba2aa5f1719"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2bf026d42a7823e89b6070a4cafc284b" id="r_ga2bf026d42a7823e89b6070a4cafc284b"><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="#ga2bf026d42a7823e89b6070a4cafc284b">H5Premove</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name)</td></tr>
<tr class="memdesc:ga2bf026d42a7823e89b6070a4cafc284b"><td class="mdescLeft"> </td><td class="mdescRight">Removes a property from a property list. <br /></td></tr>
<tr class="separator:ga2bf026d42a7823e89b6070a4cafc284b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga971d2f700cb98ccdfcdf93a39118983b" id="r_ga971d2f700cb98ccdfcdf93a39118983b"><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="#ga971d2f700cb98ccdfcdf93a39118983b">H5Pset</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name, const void *value)</td></tr>
<tr class="memdesc:ga971d2f700cb98ccdfcdf93a39118983b"><td class="mdescLeft"> </td><td class="mdescRight">Sets a property list value. <br /></td></tr>
<tr class="separator:ga971d2f700cb98ccdfcdf93a39118983b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaefb44d3535e309ba4041e420f3712aea" id="r_gaefb44d3535e309ba4041e420f3712aea"><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="#gaefb44d3535e309ba4041e420f3712aea">H5Punregister</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> pclass_id, const char *name)</td></tr>
<tr class="memdesc:gaefb44d3535e309ba4041e420f3712aea"><td class="mdescLeft"> </td><td class="mdescRight">Removes a property from a property list class. <br /></td></tr>
<tr class="separator:gaefb44d3535e309ba4041e420f3712aea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga91799f6cda78911e9ecc2cfaaea3a3b5" id="r_ga91799f6cda78911e9ecc2cfaaea3a3b5"><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="#ga91799f6cda78911e9ecc2cfaaea3a3b5">H5Pregister1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cls_id, const char *name, size_t size, void *def_value, <a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a> prp_create, <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> prp_set, <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> prp_get, <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> prp_del, <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> prp_copy, <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> prp_close)</td></tr>
<tr class="memdesc:ga91799f6cda78911e9ecc2cfaaea3a3b5"><td class="mdescLeft"> </td><td class="mdescRight">Registers a permanent property with a property list class. <br /></td></tr>
<tr class="separator:ga91799f6cda78911e9ecc2cfaaea3a3b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ba9694c03ae97c9f514470366a909f9" id="r_ga6ba9694c03ae97c9f514470366a909f9"><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="#ga6ba9694c03ae97c9f514470366a909f9">H5Pinsert1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, const char *name, size_t size, void *value, <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> prp_set, <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> prp_get, <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> prp_delete, <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> prp_copy, <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> prp_close)</td></tr>
<tr class="memdesc:ga6ba9694c03ae97c9f514470366a909f9"><td class="mdescLeft"> </td><td class="mdescRight">Registers a temporary property with a property list. <br /></td></tr>
<tr class="separator:ga6ba9694c03ae97c9f514470366a909f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf40518cb161ee9508da4b9c0d34553bf" id="r_gaf40518cb161ee9508da4b9c0d34553bf"><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="#gaf40518cb161ee9508da4b9c0d34553bf">H5Pencode1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> plist_id, void *buf, size_t *nalloc)</td></tr>
<tr class="memdesc:gaf40518cb161ee9508da4b9c0d34553bf"><td class="mdescLeft"> </td><td class="mdescRight">Encodes the property values in a property list into a binary buffer. <br /></td></tr>
<tr class="separator:gaf40518cb161ee9508da4b9c0d34553bf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa7978af06720106af04b9d034e57fcfa" name="gaa7978af06720106af04b9d034e57fcfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7978af06720106af04b9d034e57fcfa">◆ </a></span>H5Pclose_class()</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> H5Pclose_class </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>Closes an existing property list class. </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 class identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaa7978af06720106af04b9d034e57fcfa" title="Closes an existing property list class.">H5Pclose_class()</a> removes a property list class from the library. Existing property lists of this class will continue to exist, but new ones are not able to be created.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga339a27b865cf2d57ff95a6b26e94a581" name="ga339a27b865cf2d57ff95a6b26e94a581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga339a27b865cf2d57ff95a6b26e94a581">◆ </a></span>H5Pcopy_prop()</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> H5Pcopy_prop </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>dst_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies a property from one list or class to another. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dst_id</td><td>Identifier of the destination property list or class </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_id</td><td>Identifier of the source property list or class </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of the property to copy</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="#ga339a27b865cf2d57ff95a6b26e94a581" title="Copies a property from one list or class to another.">H5Pcopy_prop()</a> copies a property from one property list or class to another.</p>
<p>If a property is copied from one class to another, all the property information will be first deleted from the destination class and then the property information will be copied from the source class into the destination class.</p>
<p>If a property is copied from one list to another, the property will be first deleted from the destination list (generating a call to the close callback for the property, if one exists) and then the property is copied from the source list to the destination list (generating a call to the copy callback for the property, if one exists).</p>
<p>If the property does not exist in the class or list, this call is equivalent to calling <a class="el" href="_h5version_8h.html#a334ff323dfa6653ce21d0988ae7c73ba">H5Pregister()</a> or <a class="el" href="_h5version_8h.html#a9ccdea50538c7cfde87a9fa63ea68555">H5Pinsert()</a> (for a class or list, as appropriate) and the create callback will be called in the case of the property being copied into a list (if such a callback exists for the property).</p>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga62a1119b6ad2c33bcc9149df5e24ae12" name="ga62a1119b6ad2c33bcc9149df5e24ae12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga62a1119b6ad2c33bcc9149df5e24ae12">◆ </a></span>H5Pcreate_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Pcreate_class </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>parent</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#ada319197260febf9494b3b47aa68c7c6">H5P_cls_create_func_t</a></td> <td class="paramname"><span class="paramname"><em>create</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>create_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#ac040a485e75e3c0f57f175253f98cc89">H5P_cls_copy_func_t</a></td> <td class="paramname"><span class="paramname"><em>copy</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>copy_data</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#ae493e8a71e9d53b8ff9dbfa7c6bff91f">H5P_cls_close_func_t</a></td> <td class="paramname"><span class="paramname"><em>close</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>close_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new property list class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">parent</td><td>Property list class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property list class to register </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">create</td><td>Callback routine called when a property list is created </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">create_data</td><td>Pointer to user-defined class create data, to be passed along to class create callback </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>Callback routine called when a property list is copied </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy_data</td><td>Pointer to user-defined class copy data, to be passed along to class copy callback </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">close</td><td>Callback routine called when a property list is being closed </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">close_data</td><td>Pointer to user-defined class close data, to be passed along to class close callback</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a property list class identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga62a1119b6ad2c33bcc9149df5e24ae12" title="Creates a new property list class.">H5Pcreate_class()</a> registers a new property list class with the library. The new property list class can inherit from an existing property list class, <code>parent</code>, or may be derived from the default “empty” class, NULL. New classes with inherited properties from existing classes may not remove those existing properties, only add or remove their own class properties. Property list classes defined and supported in the HDF5 library distribution are listed and briefly described in <a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate()</a>. The <code>create</code>, <code>copy</code>, <code>close</code> functions are called when a property list of the new class is created, copied, or closed, respectively.</p>
<p><a class="el" href="#gaa7978af06720106af04b9d034e57fcfa" title="Closes an existing property list class.">H5Pclose_class()</a> must be used to release the property list class identifier returned by this function.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gaf40518cb161ee9508da4b9c0d34553bf" name="gaf40518cb161ee9508da4b9c0d34553bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf40518cb161ee9508da4b9c0d34553bf">◆ </a></span>H5Pencode1()</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> H5Pencode1 </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>buf</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>nalloc</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encodes the property values in a property list into a binary 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>Property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>Buffer into which the property list will be encoded. If the provided buffer is NULL, the size of the buffer required is returned through <code>nalloc</code>; the function does nothing more. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">nalloc</td><td>The size of the required 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>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000072">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of <a class="el" href="group___p_l_c_r.html#ga37b1b6666e62a86389015e7dfc384faa" title="Encodes the property values in a property list into a binary buffer.">H5Pencode2()</a> or the macro <a class="el" href="_h5version_8h.html#af1a9ff52a69251d57ffa686102f162a8">H5Pencode()</a>.</dd></dl>
<p><a class="el" href="#gaf40518cb161ee9508da4b9c0d34553bf" title="Encodes the property values in a property list into a binary buffer.">H5Pencode1()</a> encodes the property list <code>plist_id</code> into the binary buffer <code>buf</code>.</p>
<p>If the required buffer size is unknown, <code>buf</code> can be passed in as NULL and the function will set the required buffer size in <code>nalloc</code>. The buffer can then be created and the property list encoded with a subsequent <a class="el" href="#gaf40518cb161ee9508da4b9c0d34553bf" title="Encodes the property values in a property list into a binary buffer.">H5Pencode1()</a> call.</p>
<p>If the buffer passed in is not big enough to hold the encoded properties, the <a class="el" href="#gaf40518cb161ee9508da4b9c0d34553bf" title="Encodes the property values in a property list into a binary buffer.">H5Pencode1()</a> call can be expected to fail with a segmentation fault.</p>
<p>Properties that do not have encode callbacks will be skipped. There is currently no mechanism to register an encode callback for a user-defined property, so user-defined properties cannot currently be encoded.</p>
<p>Some properties cannot be encoded, particularly properties that are reliant on local context.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga9425ef9f3bc3ee661eca6be654aeae20" name="ga9425ef9f3bc3ee661eca6be654aeae20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9425ef9f3bc3ee661eca6be654aeae20">◆ </a></span>H5Pequal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Pequal </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>id1</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>id2</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two property lists or classes for equality. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id1</td><td>First property object to be compared </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">id2</td><td>Second property object to be compared</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#ga9425ef9f3bc3ee661eca6be654aeae20" title="Compares two property lists or classes for equality.">H5Pequal()</a> compares two property lists or classes to determine whether they are equal to one another.</p>
<p>Either both <code>id1</code> and <code>id2</code> must be property lists or both must be classes; comparing a list to a class is an error.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gae135cf333c12375f3808cfe931ea9190" name="gae135cf333c12375f3808cfe931ea9190"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae135cf333c12375f3808cfe931ea9190">◆ </a></span>H5Pexist()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Pexist </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries whether a property name exists in a property list or class. </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 property list or class to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to check for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#gae135cf333c12375f3808cfe931ea9190" title="Queries whether a property name exists in a property list or class.">H5Pexist()</a> determines whether a property exists within a property list or class.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga40f1c3042011462c632844464a746db3" name="ga40f1c3042011462c632844464a746db3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga40f1c3042011462c632844464a746db3">◆ </a></span>H5Pget()</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 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the value of a 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>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">value</td><td>Pointer to a location to which to copy the value of the property</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="#ga40f1c3042011462c632844464a746db3" title="Queries the value of a property.">H5Pget()</a> retrieves a copy of the value for a property in a property list. If there is a <code>get</code> callback routine registered for this property, the copy of the value of the property will first be passed to that routine and any changes to the copy of the value will be used when returning the property value from this routine.</p>
<p>This routine may be called for zero-sized properties with the <code>value</code> set to NULL. The <code>get</code> routine will be called with a NULL value if the callback exists.</p>
<p>The property name must exist or this routine will fail.</p>
<p>If the <code>get</code> callback routine returns an error, \ value will not be modified.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gac94a17bcb6d988a7ccb1cf2c6f4a3a82" name="gac94a17bcb6d988a7ccb1cf2c6f4a3a82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac94a17bcb6d988a7ccb1cf2c6f4a3a82">◆ </a></span>H5Pget_class_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * H5Pget_class_name </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>pclass_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the name of a class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pclass_id</td><td>Property list class identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a pointer to an allocated string containing the class name if successful, and NULL if not successful.</dd></dl>
<p><a class="el" href="#gac94a17bcb6d988a7ccb1cf2c6f4a3a82" title="Retrieves the name of a class.">H5Pget_class_name()</a> retrieves the name of a generic property list class. The pointer to the name must be freed by the user with a call to <a class="el" href="group___h5.html#ga71872bf6445cba956da86d4762b662cf" title="Frees memory allocated by the HDF5 library.">H5free_memory()</a> after each successful call.</p>
<table class="doxtable">
<tr>
<th>Class Name (class identifier) Returned </th><th>Property List Class </th><th>Expanded Name of the Property List Class </th><th>The Class Identifier Used with H5Pcreate </th><th>Comments </th></tr>
<tr>
<td>attribute create </td><td>acpl </td><td>Attribute Creation Property List </td><td>H5P_ATTRIBUTE_CREATE </td><td></td></tr>
<tr>
<td>dataset access </td><td>dapl </td><td>Dataset Access Property List </td><td>H5P_DATASET_ACCESS </td><td></td></tr>
<tr>
<td>dataset create </td><td>dcpl </td><td>Dataset Creation Property List </td><td>H5P_DATASET_CREATE </td><td></td></tr>
<tr>
<td>data transfer </td><td>dxpl </td><td>Data Transfer Property List </td><td>H5P_DATASET_XFER </td><td></td></tr>
<tr>
<td>datatype access </td><td></td><td></td><td>H5P_DATATYPE_ACCESS </td><td>This class can be created, but there are no properties in the class currently. </td></tr>
<tr>
<td>datatype create </td><td></td><td></td><td>H5P_DATATYPE_CREATE </td><td>This class can be created, but there are no properties in the class currently. </td></tr>
<tr>
<td>file access </td><td>fapl </td><td>File Access Property List </td><td>H5P_FILE_ACCESS </td><td></td></tr>
<tr>
<td>file create </td><td>fcpl </td><td>File Creation Property List </td><td>H5P_FILE_CREATE </td><td></td></tr>
<tr>
<td>file mount </td><td>fmpl </td><td>File Mount Property List </td><td>H5P_FILE_MOUNT </td><td></td></tr>
<tr>
<td>group access </td><td></td><td></td><td>H5P_GROUP_ACCESS </td><td>This class can be created, but there are no properties in the class currently. </td></tr>
<tr>
<td>group create </td><td>gcpl </td><td>Group Creation Property List </td><td>H5P_GROUP_CREATE </td><td></td></tr>
<tr>
<td>link access </td><td>lapl </td><td>Link Access Property List </td><td>H5P_LINK_ACCESS </td><td></td></tr>
<tr>
<td>link create </td><td>lcpl </td><td>Link Creation Property List </td><td>H5P_LINK_CREATE </td><td></td></tr>
<tr>
<td>object copy </td><td>ocpypl </td><td>Object Copy Property List </td><td>H5P_OBJECT_COPY </td><td></td></tr>
<tr>
<td>object create </td><td>ocpl </td><td>Object Creation Property List </td><td>H5P_OBJECT_CREATE </td><td></td></tr>
<tr>
<td>string create </td><td>strcpl </td><td>String Creation Property List </td><td>H5P_STRING_CREATE </td><td></td></tr>
</table>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga89f228c04207992d93fc3f2dddd860a5" name="ga89f228c04207992d93fc3f2dddd860a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89f228c04207992d93fc3f2dddd860a5">◆ </a></span>H5Pget_class_parent()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> H5Pget_class_parent </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>pclass_id</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the parent class of a property class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pclass_id</td><td>Property list class identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a parent class object identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p><a class="el" href="#ga89f228c04207992d93fc3f2dddd860a5" title="Retrieves the parent class of a property class.">H5Pget_class_parent()</a> retrieves an identifier for the parent class of a property class.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga13f41512715a8019e89529ea093c2c43" name="ga13f41512715a8019e89529ea093c2c43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga13f41512715a8019e89529ea093c2c43">◆ </a></span>H5Pget_nprops()</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_nprops </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>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>nprops</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the number of properties in a property list or class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Identifier for property object to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">nprops</td><td>Number of properties in object</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="#ga13f41512715a8019e89529ea093c2c43" title="Queries the number of properties in a property list or class.">H5Pget_nprops()</a> retrieves the number of properties in a property list or property list class.</p>
<p>If <code>id</code> is a property list identifier, the current number of properties in the list is returned in <code>nprops</code>.</p>
<p>If <code>id</code> is a property list class identifier, the number of registered properties in the class is returned in <code>nprops</code>.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gaaad1c5ad2069145e2f5397ce4ab3a93c" name="gaaad1c5ad2069145e2f5397ce4ab3a93c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaad1c5ad2069145e2f5397ce4ab3a93c">◆ </a></span>H5Pget_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_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>id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t *</td> <td class="paramname"><span class="paramname"><em>size</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Queries the size of a property value in bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Identifier of property object to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Size of property in bytes</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="#gaaad1c5ad2069145e2f5397ce4ab3a93c" title="Queries the size of a property value in bytes.">H5Pget_size()</a> retrieves the size of a property's value in bytes. This function operates on both property lists and property classes.</p>
<p>Zero-sized properties are allowed and return 0.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga6ba9694c03ae97c9f514470366a909f9" name="ga6ba9694c03ae97c9f514470366a909f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ba9694c03ae97c9f514470366a909f9">◆ </a></span>H5Pinsert1()</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> H5Pinsert1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>value</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_set</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_get</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_delete</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_copy</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_close</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a temporary property with a 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>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of property in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Initial value for the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_set</td><td>Callback routine called before a new value is copied into the property's value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_get</td><td>Callback routine called when a property value is retrieved from the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_delete</td><td>Callback routine called when a property is deleted from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_copy</td><td>Callback routine called when a property is copied from an existing property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_close</td><td>Callback routine called when a property list is being closed and the property value will be disposed of</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#_deprecated000071">Deprecated</a></b></dt><dd>As of HDF5-1.8 this function was deprecated in favor of <a class="el" href="#ga930e15d5f994e223bea80621ef3065d4" title="Registers a temporary property with a property list.">H5Pinsert2()</a> or the macro <a class="el" href="_h5version_8h.html#a9ccdea50538c7cfde87a9fa63ea68555">H5Pinsert()</a>.</dd></dl>
<p><a class="el" href="#ga6ba9694c03ae97c9f514470366a909f9" title="Registers a temporary property with a property list.">H5Pinsert1()</a> creates a new property in a property list. The property will exist only in this property list and copies made from it.</p>
<p>The initial property value must be provided in <code>value</code> and the property value will be set accordingly.</p>
<p>The name of the property must not already exist in this list, or this routine will fail.</p>
<p>The <code>prp_set</code> and <code>prp_get</code> callback routines may be set to NULL if they are not needed.</p>
<p>Zero-sized properties are allowed and do not store any data in the property list. The default value of a zero-size property may be set to NULL. They may be used to indicate the presence or absence of a particular piece of information.</p>
<p>The <code>prp_set</code> routine is called before a new value is copied into the property. The <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>. The <code>prp_set</code> routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the <code>prp_set</code> routine returns a negative value, the new property value is not copied into the property and the <code>set</code> routine returns an error value. The <code>prp_set</code> routine will be called for the initial value.</p>
<p><b>Note:</b> The <code>prp_set</code> callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The <code>prp_get</code> callback would then reverse the transformation or translation. A single <code>prp_get</code> or <code>prp_set</code> callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.</p>
<p>The <code>prp_get</code> routine is called when a value is retrieved from a property value. The <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>.</p>
<p>The <code>prp_get</code> routine may modify the value to be returned from the query and those changes will be preserved. If the <code>prp_get</code> routine returns a negative value, the query routine returns an error value.</p>
<p>The <code>prp_delete</code> routine is called when a property is being deleted from a property list. The <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>.</p>
<p>The <code>prp_copy</code> routine is called when a new property list with this property is being created through a <code>prp_copy</code> operation. The <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a>.</p>
<p>The <code>prp_copy</code> routine may modify the value to be set and those changes will be stored as the new value of the property. If the <code>prp_copy</code> routine returns a negative value, the new property value is not copied into the property and the prp_copy routine returns an error value.</p>
<p>The <code>prp_close</code> routine is called when a property list with this property is being closed. The <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a>.</p>
<p>The <code>prp_close</code> routine may modify the value passed in, the value is not used by the library when the close routine returns. If the <code>prp_close</code> routine returns a negative value, the property list <code>prp_close</code> routine returns an error value but the property list is still closed.</p>
<p><b>Note:</b> There is no <code>prp_create</code> callback routine for temporary property list objects; the initial value is assumed to have any necessary setup already performed on it.</p>
<p>The <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a> is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a> is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga930e15d5f994e223bea80621ef3065d4" name="ga930e15d5f994e223bea80621ef3065d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga930e15d5f994e223bea80621ef3065d4">◆ </a></span>H5Pinsert2()</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> H5Pinsert2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>value</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a></td> <td class="paramname"><span class="paramname"><em>set</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a></td> <td class="paramname"><span class="paramname"><em>get</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_del</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a></td> <td class="paramname"><span class="paramname"><em>copy</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a></td> <td class="paramname"><span class="paramname"><em>compare</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a></td> <td class="paramname"><span class="paramname"><em>close</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a temporary property with a 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>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to create </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of property in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Initial value for the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">set</td><td>Callback routine called before a new value is copied into the property's value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">get</td><td>Callback routine called when a property value is retrieved from the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_del</td><td>Callback routine called when a property is deleted from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>Callback routine called when a property is copied from an existing property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">compare</td><td>Callback routine called when a property is compared with another property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">close</td><td>Callback routine called when a property list is being closed and the property value will be disposed of</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="#ga930e15d5f994e223bea80621ef3065d4" title="Registers a temporary property with a property list.">H5Pinsert2()</a> creates a new property in a property list. The property will exist only in this property list and copies made from it.</p>
<p>The initial property value must be provided in <code>value</code> and the property value will be set accordingly.</p>
<p>The name of the property must not already exist in this list, or this routine will fail.</p>
<p>The <code>set</code> and <code>get</code> callback routines may be set to NULL if they are not needed.</p>
<p>Zero-sized properties are allowed and do not store any data in the property list. The default value of a zero-size property may be set to NULL. They may be used to indicate the presence or absence of a particular piece of information.</p>
<p>The <code>set</code> routine is called before a new value is copied into the property. The <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> callback function is defined as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list being modified </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being modified </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: Pointer to new value pointer for the property being modified </td></tr>
</table>
<p>The <code>set</code> routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the <code>set</code> routine returns a negative value, the new property value is not copied into the property and the <code>set</code> routine returns an error value. The <code>set</code> routine will be called for the initial value.</p>
<p><b>Note:</b> The <code>set</code> callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The <code>get</code> callback would then reverse the transformation or translation. A single <code>get</code> or <code>set</code> callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.</p>
<p>The <code>get</code> routine is called when a value is retrieved from a property value. The <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the above callback function are:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list being queried </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being queried </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: The value of the property being returned </td></tr>
</table>
<p>The <code>get</code> routine may modify the value to be returned from the query and those changes will be preserved. If the <code>get</code> routine returns a negative value, the query routine returns an error value.</p>
<p>The <code>prp_del</code> routine is called when a property is being deleted from a property list. The <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the above callback function are:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list the property is being deleted from </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property in the list </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: The value for the property being deleted </td></tr>
</table>
<p>The <code>prp_del</code> routine may modify the value passed in, but the value is not used by the library when the <code>prp_del</code> routine returns. If the <code>prp_del</code> routine returns a negative value, the property list <code>prp_del</code> routine returns an error value but the property is still deleted.</p>
<p>The <code>copy</code> routine is called when a new property list with this property is being created through a <code>copy</code> operation.</p>
<p>The <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the above callback function are: </p><table class="doxtable">
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being copied </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN/OUT: The value for the property being copied </td></tr>
</table>
<p>The <code>copy</code> routine may modify the value to be set and those changes will be stored as the new value of the property. If the <code>copy</code> routine returns a negative value, the new property value is not copied into the property and the copy routine returns an error value.</p>
<p>The <code>compare</code> routine is called when a property list with this property is compared to another property list with the same property.</p>
<p>The <a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28" title="Callback function for comparing property values.">H5P_prp_compare_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a>)(<span class="keyword">const</span> <span class="keywordtype">void</span> *value1, <span class="keyword">const</span> <span class="keywordtype">void</span> *value2, <span class="keywordtype">size_t</span> size);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const void * value1</code> </td><td>IN: The value of the first property to compare </td></tr>
<tr>
<td><code>const void * value2</code> </td><td>IN: The value of the second property to compare </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
</table>
<p>The <code>compare</code> routine may not modify the values. The <code>compare</code> routine should return a positive value if <code>value1</code> is greater than <code>value2</code>, a negative value if <code>value2</code> is greater than <code>value1</code> and zero if <code>value1</code> and <code>value2</code> are equal.</p>
<p>The <code>close</code> routine is called when a property list with this property is being closed.</p>
<p>The <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> callback function is defined as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property in the list </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: The value for the property being closed </td></tr>
</table>
<p>The <code>close</code> routine may modify the value passed in, the value is not used by the library when the close routine returns. If the <code>close</code> routine returns a negative value, the property list <code>close</code> routine returns an error value but the property list is still closed.</p>
<p><b>Note:</b> There is no <code>create</code> callback routine for temporary property list objects; the initial value is assumed to have any necessary setup already performed on it.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga68bc660e09b46dcb5ea3f25b245aff60" name="ga68bc660e09b46dcb5ea3f25b245aff60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68bc660e09b46dcb5ea3f25b245aff60">◆ </a></span>H5Pisa_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#aa8f6c28736dbd0f18388c67911d38aca">htri_t</a> H5Pisa_class </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>pclass_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether a property list is a member of a class. </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">pclass_id</td><td>Property list class identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns zero (false), a positive (true) or a negative (failure) value.</dd></dl>
<p><a class="el" href="#ga68bc660e09b46dcb5ea3f25b245aff60" title="Determines whether a property list is a member of a class.">H5Pisa_class()</a> checks to determine whether the property list <code>plist_id</code> is a member of the property list class <code>pclass_id</code>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa" title="Creates a new property list as an instance of a property list class.">H5Pcreate()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga1c52aa0f6d1839798982973d7db9569e" name="ga1c52aa0f6d1839798982973d7db9569e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c52aa0f6d1839798982973d7db9569e">◆ </a></span>H5Piterate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int H5Piterate </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>id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int *</td> <td class="paramname"><span class="paramname"><em>idx</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9d7a5c4938ce5732e469f1db706949fe">H5P_iterate_t</a></td> <td class="paramname"><span class="paramname"><em>iter_func</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>iter_data</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Iterates over properties in a property class or list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>Identifier of property object to iterate over </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">idx</td><td>Index of the property to begin with </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">iter_func</td><td>Function pointer to function to be called with each property iterated over </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">iter_data</td><td>Pointer to iteration data from user</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>On success: the return value of the last call to <code>iter_func</code> if it was non-zero; zero if all properties have been processed. On Failure, a negative value</dd></dl>
<p><a class="el" href="#ga1c52aa0f6d1839798982973d7db9569e" title="Iterates over properties in a property class or list.">H5Piterate()</a> iterates over the properties in the property object specified in <code>id</code>, which may be either a property list or a property class, performing a specified operation on each property in turn.</p>
<p>For each property in the object, <code>iter_func</code> and the additional information specified below are passed to the <a class="el" href="_h5_ppublic_8h.html#a9d7a5c4938ce5732e469f1db706949fe" title="Callback function for H5Piterate()">H5P_iterate_t</a> operator function.</p>
<p>The iteration begins with the <code>idx-th</code> property in the object; the next element to be processed by the operator is returned in <code>idx</code>. If <code>idx</code> is NULL, the iterator starts at the first property; since no stopping point is returned in this case, the iterator cannot be restarted if one of the calls to its operator returns non-zero.</p>
<p>The operation <code>iter_func</code> receives the property list or class identifier for the object being iterated over, <code>id</code>, the name of the current property within the object, <code>name</code>, and the pointer to the operator data passed in to <a class="el" href="#ga1c52aa0f6d1839798982973d7db9569e" title="Iterates over properties in a property class or list.">H5Piterate()</a>, <code>iter_data</code>.</p>
<dl class="section warning"><dt>Warning</dt><dd><a class="el" href="#ga1c52aa0f6d1839798982973d7db9569e" title="Iterates over properties in a property class or list.">H5Piterate()</a> assumes that the properties in the object identified by <code>id</code> remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga91799f6cda78911e9ecc2cfaaea3a3b5" name="ga91799f6cda78911e9ecc2cfaaea3a3b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga91799f6cda78911e9ecc2cfaaea3a3b5">◆ </a></span>H5Pregister1()</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> H5Pregister1 </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>cls_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>def_value</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_create</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_set</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_get</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_del</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_copy</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_close</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a permanent property with a property list class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cls_id</td><td>Property list class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to register </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of property in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def_value</td><td>Default value for property in newly created property lists </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_create</td><td>Callback routine called when a property list is being created and the property value will be initialized </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_set</td><td>Callback routine called before a new value is copied into the property's value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_get</td><td>Callback routine called when a property value is retrieved from the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_del</td><td>Callback routine called when a property is deleted from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_copy</td><td>Callback routine called when a property is copied from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_close</td><td>Callback routine called when a property list is being closed and the property value will be disposed of</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#_deprecated000070">Deprecated</a></b></dt><dd>As of HDF5-1.8 this function was deprecated in favor of <a class="el" href="#gaac3f957a5d3cbb4adc8b7ba2aa5f1719" title="Registers a permanent property with a property list class.">H5Pregister2()</a> or the macro <a class="el" href="_h5version_8h.html#a334ff323dfa6653ce21d0988ae7c73ba">H5Pregister()</a>.</dd></dl>
<p><a class="el" href="#ga91799f6cda78911e9ecc2cfaaea3a3b5" title="Registers a permanent property with a property list class.">H5Pregister1()</a> registers a new property with a property list class. The property will exist in all property list objects of that class after this routine is finished. The name of the property must not already exist. The default property value must be provided and all new property lists created with this property will have the property value set to the default provided. Any of the callback routines may be set to NULL if they are not needed.</p>
<p>Zero-sized properties are allowed and do not store any data in the property list. These may be used as flags to indicate the presence or absence of a particular piece of information. The default pointer for a zero-sized property may be set to NULL. The property <code>prp_create</code> and <code>prp_close</code> callbacks are called for zero-sized properties, but the <code>prp_set</code> and <code>prp_get</code> callbacks are never called.</p>
<p>The <code>prp_create</code> routine is called when a new property list with this property is being created. The <a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a>.</p>
<p>The <code>prp_create</code> routine may modify the value to be set and those changes will be stored as the initial value of the property. If the <code>prp_create</code> routine returns a negative value, the new property value is not copied into the property and the <code>prp_create</code> routine returns an error value.</p>
<p>The <code>prp_set</code> routine is called before a new value is copied into the property. The <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>.</p>
<p>The <code>prp_set</code> routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the <code>prp_set</code> routine returns a negative value, the new property value is not copied into the property and the <code>prp_set</code> routine returns an error value. The <code>prp_set</code> routine will not be called for the initial value; only the <code>prp_create</code> routine will be called.</p>
<p><b>Note:</b> The <code>prp_set</code> callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The <code>prp_get</code> callback would then reverse the transformation or translation. A single <code>prp_get</code> or <code>prp_set</code> callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.</p>
<p>The <code>prp_get</code> routine is called when a value is retrieved from a property value. The <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>.</p>
<p>The <code>prp_get</code> routine may modify the value to be returned from the query and those changes will be returned to the calling routine. If the <code>prp_set</code> routine returns a negative value, the query routine returns an error value.</p>
<p>The <code>prp_del</code> routine is called when a property is being deleted from a property list. The <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a>.</p>
<p>The <code>prp_del</code> routine may modify the value passed in, but the value is not used by the library when the <code>prp_del</code> routine returns. If the <code>prp_del</code> routine returns a negative value, the property list deletion routine returns an error value but the property is still deleted.</p>
<p>The <code>prp_copy</code> routine is called when a new property list with this property is being created through a <code>prp_copy</code> operation. The <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a>.</p>
<p>The <code>prp_copy</code> routine may modify the value to be set and those changes will be stored as the new value of the property. If the <code>prp_copy</code> routine returns a negative value, the new property value is not copied into the property and the <code>prp_copy</code> routine returns an error value.</p>
<p>The <code>prp_close</code> routine is called when a property list with this property is being closed. The <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> callback function is defined as <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a>.</p>
<p>The <code>prp_close</code> routine may modify the value passed in, but the value is not used by the library when the <code>prp_close</code> routine returns. If the <code>prp_close</code> routine returns a negative value, the property list close routine returns an error value but the property list is still closed.</p>
<p>The <a class="el" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb1_t</a> is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The <a class="el" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f" title="Callback function for H5Pregister2(),H5Pregister1(),H5Pinsert2(),H5Pinsert1()">H5P_prp_cb2_t</a> is as follows: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gaac3f957a5d3cbb4adc8b7ba2aa5f1719" name="gaac3f957a5d3cbb4adc8b7ba2aa5f1719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac3f957a5d3cbb4adc8b7ba2aa5f1719">◆ </a></span>H5Pregister2()</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> H5Pregister2 </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>cls_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>def_value</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a></td> <td class="paramname"><span class="paramname"><em>create</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a></td> <td class="paramname"><span class="paramname"><em>set</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a></td> <td class="paramname"><span class="paramname"><em>get</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a></td> <td class="paramname"><span class="paramname"><em>prp_del</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a></td> <td class="paramname"><span class="paramname"><em>copy</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a></td> <td class="paramname"><span class="paramname"><em>compare</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a></td> <td class="paramname"><span class="paramname"><em>close</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a permanent property with a property list class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cls_id</td><td>Property list class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to register </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of property in bytes </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">def_value</td><td>Default value for property in newly created property lists </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">create</td><td>Callback routine called when a property list is being created and the property value will be initialized </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">set</td><td>Callback routine called before a new value is copied into the property's value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">get</td><td>Callback routine called when a property value is retrieved from the property </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">prp_del</td><td>Callback routine called when a property is deleted from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>Callback routine called when a property is copied from a property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">compare</td><td>Callback routine called when a property is compared with another property list </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">close</td><td>Callback routine called when a property list is being closed and the property value will be disposed of</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="#gaac3f957a5d3cbb4adc8b7ba2aa5f1719" title="Registers a permanent property with a property list class.">H5Pregister2()</a> registers a new property with a property list class. The <code>cls_id</code> identifier can be obtained by calling <a class="el" href="#ga62a1119b6ad2c33bcc9149df5e24ae12" title="Creates a new property list class.">H5Pcreate_class()</a>. The property will exist in all property list objects of <code>cl_id</code> created after this routine finishes. The name of the property must not already exist, or this routine will fail. The default property value must be provided and all new property lists created with this property will have the property value set to the default value. Any of the callback routines may be set to NULL if they are not needed.</p>
<p>Zero-sized properties are allowed and do not store any data in the property list. These may be used as flags to indicate the presence or absence of a particular piece of information. The default pointer for a zero-sized property may be set to NULL. The property <code>create</code> and <code>close</code> callbacks are called for zero-sized properties, but the <code>set</code> and <code>get</code> callbacks are never called.</p>
<p>The <code>create</code> routine is called when a new property list with this property is being created. The <a class="el" href="_h5_ppublic_8h.html#a874ff6838c44e13eb75a80086ea18bd4">H5P_prp_create_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to this callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being modified </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN/OUT: The default value for the property being created, which will be passed to <a class="el" href="#gaac3f957a5d3cbb4adc8b7ba2aa5f1719" title="Registers a permanent property with a property list class.">H5Pregister2()</a> </td></tr>
</table>
<p>The <code>create</code> routine may modify the value to be set and those changes will be stored as the initial value of the property. If the <code>create</code> routine returns a negative value, the new property value is not copied into the property and the <code>create</code> routine returns an error value.</p>
<p>The <code>set</code> routine is called before a new value is copied into the property. The <a class="el" href="_h5_ppublic_8h.html#a71013bd340657c834adc61579a7a13d6">H5P_prp_set_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to this callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list being modified </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being modified </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void *value</code> </td><td>IN/OUT: Pointer to new value pointer for the property being modified </td></tr>
</table>
<p>The <code>set</code> routine may modify the value pointer to be set and those changes will be used when setting the property's value. If the <code>set</code> routine returns a negative value, the new property value is not copied into the property and the <code>set</code> routine returns an error value. The <code>set</code> routine will not be called for the initial value; only the <code>create</code> routine will be called.</p>
<p><b>Note:</b> The <code>set</code> callback function may be useful to range check the value being set for the property or may perform some transformation or translation of the value set. The <code>get</code> callback would then reverse the transformation or translation. A single <code>get</code> or <code>set</code> callback could handle multiple properties by performing different actions based on the property name or other properties in the property list.</p>
<p>The <code>get</code> routine is called when a value is retrieved from a property value. The <a class="el" href="_h5_ppublic_8h.html#a9fb7470c8fe7cd27e59586cb59bc6dc6">H5P_prp_get_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list being queried </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being queried </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN/OUT: The value of the property being returned </td></tr>
</table>
<p>The <code>get</code> routine may modify the value to be returned from the query and those changes will be returned to the calling routine. If the <code>set</code> routine returns a negative value, the query routine returns an error value.</p>
<p>The <code>prp_del</code> routine is called when a property is being deleted from a property list. The <a class="el" href="_h5_ppublic_8h.html#a9400197471623296d439b208b4f91de5">H5P_prp_delete_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#ac30e48dfeb620a9a6796a6fe2baa839f">H5P_prp_cb2_t</a>)(<a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> prop_id, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> <code>prop_id</code> </td><td>IN: The identifier of the property list the property is being deleted from </td></tr>
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property in the list </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: The value for the property being deleted </td></tr>
</table>
<p>The <code>prp_del</code> routine may modify the value passed in, but the value is not used by the library when the <code>prp_del</code> routine returns. If the <code>prp_del</code> routine returns a negative value, the property list delete routine returns an error value but the property is still deleted.</p>
<p>The <code>copy</code> routine is called when a new property list with this property is being created through a <code>copy</code> operation. The <a class="el" href="_h5_ppublic_8h.html#a7a6388bf6c82e985a8e03dac32874353">H5P_prp_copy_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property being copied </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN/OUT: The value for the property being copied </td></tr>
</table>
<p>The <code>copy</code> routine may modify the value to be set and those changes will be stored as the new value of the property. If the <code>copy</code> routine returns a negative value, the new property value is not copied into the property and the <code>copy</code> routine returns an error value.</p>
<p>The <code>compare</code> routine is called when a property list with this property is compared to another property list with the same property. The <a class="el" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28" title="Callback function for comparing property values.">H5P_prp_compare_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> int (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a50c6a45d41e2b17d6d63d55d5e4bbd28">H5P_prp_compare_func_t</a>)(<span class="keyword">const</span> <span class="keywordtype">void</span> *value1, <span class="keyword">const</span> <span class="keywordtype">void</span> *value2, <span class="keywordtype">size_t</span> size);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const void * value1</code> </td><td>IN: The value of the first property to compare </td></tr>
<tr>
<td><code>const void * value2</code> </td><td>IN: The value of the second property to compare </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
</table>
<p>The <code>compare</code> routine may not modify the values. The <code>compare</code> routine should return a positive value if <code>value1</code> is greater than <code>value2</code>, a negative value if <code>value2</code> is greater than <code>value1</code> and zero if <code>value1</code> and <code>value2</code> are equal.</p>
<p>The <code>close</code> routine is called when a property list with this property is being closed. The <a class="el" href="_h5_ppublic_8h.html#a9401085aa26970aac50b0bc8b629f4b5">H5P_prp_close_func_t</a> callback function is defined as follows:</p>
<div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <a class="code hl_typedef" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> (*<a class="code hl_typedef" href="_h5_ppublic_8h.html#a2069d596a2eab8b94eaeeb2a4c60795e">H5P_prp_cb1_t</a>)(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span> *value);</div>
</div><!-- fragment --><p>The parameters to the callback function are defined as follows:</p>
<table class="doxtable">
<tr>
<td><code>const char * name</code> </td><td>IN: The name of the property in the list </td></tr>
<tr>
<td><code>size_t size</code> </td><td>IN: The size of the property in bytes </td></tr>
<tr>
<td><code>void * value</code> </td><td>IN: The value for the property being closed </td></tr>
</table>
<p>The <code>close</code> routine may modify the value passed in, but the value is not used by the library when the <code>close</code> routine returns. If the <code>close</code> routine returns a negative value, the property list close routine returns an error value but the property list is still closed.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga2bf026d42a7823e89b6070a4cafc284b" name="ga2bf026d42a7823e89b6070a4cafc284b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bf026d42a7823e89b6070a4cafc284b">◆ </a></span>H5Premove()</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> H5Premove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a property from a 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>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to remove</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="#ga2bf026d42a7823e89b6070a4cafc284b" title="Removes a property from a property list.">H5Premove()</a> removes a property from a property list. Both properties which were in existence when the property list was created (i.e. properties registered with <a class="el" href="_h5version_8h.html#a334ff323dfa6653ce21d0988ae7c73ba">H5Pregister()</a>) and properties added to the list after it was created (i.e. added with <a class="el" href="#ga6ba9694c03ae97c9f514470366a909f9" title="Registers a temporary property with a property list.">H5Pinsert1()</a> may be removed from a property list. Properties do not need to be removed from a property list before the list itself is closed; they will be released automatically when <a class="el" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb" title="Terminates access to a property list.">H5Pclose()</a> is called.</p>
<p>If a <code>close</code> callback exists for the removed property, it will be called before the property is released.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="ga971d2f700cb98ccdfcdf93a39118983b" name="ga971d2f700cb98ccdfcdf93a39118983b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga971d2f700cb98ccdfcdf93a39118983b">◆ </a></span>H5Pset()</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 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>plist_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a property list value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">plist_id</td><td>Property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to modify </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>Pointer to value to set the property to</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="#ga971d2f700cb98ccdfcdf93a39118983b" title="Sets a property list value.">H5Pset()</a> sets a new value for a property in a property list. If there is a <code>set</code> callback routine registered for this property, the <code>value</code> will be passed to that routine and any changes to the <code>value</code> will be used when setting the property value. The information pointed to by the <code>value</code> pointer (possibly modified by the <code>set</code> callback) is copied into the property list value and may be changed by the application making the <a class="el" href="#ga971d2f700cb98ccdfcdf93a39118983b" title="Sets a property list value.">H5Pset()</a> call without affecting the property value.</p>
<p>The property name must exist or this routine will fail.</p>
<p>If the <code>set</code> callback routine returns an error, the property value will not be modified.</p>
<p>This routine may not be called for zero-sized properties and will return an error in that case.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.0 </dd></dl>
</div>
</div>
<a id="gaefb44d3535e309ba4041e420f3712aea" name="gaefb44d3535e309ba4041e420f3712aea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaefb44d3535e309ba4041e420f3712aea">◆ </a></span>H5Punregister()</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> H5Punregister </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>pclass_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a property from a property list class. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pclass_id</td><td>Property list class identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of property to remove</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="#gaefb44d3535e309ba4041e420f3712aea" title="Removes a property from a property list class.">H5Punregister()</a> removes a property from a property list class. Future property lists created of that class will not contain this property; existing property lists containing this property are not affected.</p>
<dl class="section since"><dt>Since</dt><dd>1.4.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>
|
