1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
|
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: References (H5R)</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>
<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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(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.f39b228</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="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.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group___h5_r.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">References (H5R)</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Use the functions in this module to manage HDF5 references. Referents can be HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga5dc19b9d1833af66c5e1f819f2c05c4a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#ga5dc19b9d1833af66c5e1f819f2c05c4a">H5Rdereference</a>   <a class="el" href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7">H5Rdereference2</a></td></tr>
<tr class="separator:ga5dc19b9d1833af66c5e1f819f2c05c4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe413df448be0d230de922357fd7bc3b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#gafe413df448be0d230de922357fd7bc3b">H5Rget_obj_type</a>   <a class="el" href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807">H5Rget_obj_type2</a></td></tr>
<tr class="separator:gafe413df448be0d230de922357fd7bc3b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad0fb6ec99ecefa602756a5682addfc69"><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="group___h5_r.html#gad0fb6ec99ecefa602756a5682addfc69">H5Rcreate_object</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id, <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr)</td></tr>
<tr class="memdesc:gad0fb6ec99ecefa602756a5682addfc69"><td class="mdescLeft"> </td><td class="mdescRight">Creates an object reference. <a href="group___h5_r.html#gad0fb6ec99ecefa602756a5682addfc69">More...</a><br /></td></tr>
<tr class="separator:gad0fb6ec99ecefa602756a5682addfc69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga60134eb917afbe89aa23eb25a30d249b"><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="group___h5_r.html#ga60134eb917afbe89aa23eb25a30d249b">H5Rcreate_region</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id, <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr)</td></tr>
<tr class="memdesc:ga60134eb917afbe89aa23eb25a30d249b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a region reference. <a href="group___h5_r.html#ga60134eb917afbe89aa23eb25a30d249b">More...</a><br /></td></tr>
<tr class="separator:ga60134eb917afbe89aa23eb25a30d249b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacae1bf2263befeac54d81f27995721f8"><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="group___h5_r.html#gacae1bf2263befeac54d81f27995721f8">H5Rcreate_attr</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, const char *attr_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id, <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr)</td></tr>
<tr class="memdesc:gacae1bf2263befeac54d81f27995721f8"><td class="mdescLeft"> </td><td class="mdescRight">Creates an attribute reference. <a href="group___h5_r.html#gacae1bf2263befeac54d81f27995721f8">More...</a><br /></td></tr>
<tr class="separator:gacae1bf2263befeac54d81f27995721f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga026114e6c23588bf89bb473eb9e4d095"><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="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095">H5Rdestroy</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr)</td></tr>
<tr class="memdesc:ga026114e6c23588bf89bb473eb9e4d095"><td class="mdescLeft"> </td><td class="mdescRight">Closes a reference. <a href="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095">More...</a><br /></td></tr>
<tr class="separator:ga026114e6c23588bf89bb473eb9e4d095"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga56989d33835ec289269d366dc28aa4ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#ga56989d33835ec289269d366dc28aa4ad">H5Rget_type</a> (const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr)</td></tr>
<tr class="memdesc:ga56989d33835ec289269d366dc28aa4ad"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of a reference. <a href="group___h5_r.html#ga56989d33835ec289269d366dc28aa4ad">More...</a><br /></td></tr>
<tr class="separator:ga56989d33835ec289269d366dc28aa4ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8d7dac2c604356f2fc657f36a201aea0"><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="group___h5_r.html#ga8d7dac2c604356f2fc657f36a201aea0">H5Requal</a> (const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref1_ptr, const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref2_ptr)</td></tr>
<tr class="memdesc:ga8d7dac2c604356f2fc657f36a201aea0"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether two references are equal. <a href="group___h5_r.html#ga8d7dac2c604356f2fc657f36a201aea0">More...</a><br /></td></tr>
<tr class="separator:ga8d7dac2c604356f2fc657f36a201aea0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad5b7b117cfaea90d1e4786304c58c55c"><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="group___h5_r.html#gad5b7b117cfaea90d1e4786304c58c55c">H5Rcopy</a> (const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *src_ref_ptr, <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *dst_ref_ptr)</td></tr>
<tr class="memdesc:gad5b7b117cfaea90d1e4786304c58c55c"><td class="mdescLeft"> </td><td class="mdescRight">Copies an existing reference. <a href="group___h5_r.html#gad5b7b117cfaea90d1e4786304c58c55c">More...</a><br /></td></tr>
<tr class="separator:gad5b7b117cfaea90d1e4786304c58c55c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa6692bd3a5b490c8db05b90a5888d0dd"><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="group___h5_r.html#gaa6692bd3a5b490c8db05b90a5888d0dd">H5Ropen_object</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> rapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id)</td></tr>
<tr class="memdesc:gaa6692bd3a5b490c8db05b90a5888d0dd"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 object referenced. <a href="group___h5_r.html#gaa6692bd3a5b490c8db05b90a5888d0dd">More...</a><br /></td></tr>
<tr class="separator:gaa6692bd3a5b490c8db05b90a5888d0dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga400154b014acd1736bae9a127f4e9a1a"><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="group___h5_r.html#ga400154b014acd1736bae9a127f4e9a1a">H5Ropen_region</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> rapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id)</td></tr>
<tr class="memdesc:ga400154b014acd1736bae9a127f4e9a1a"><td class="mdescLeft"> </td><td class="mdescRight">Sets up a dataspace and selection as specified by a region reference. <a href="group___h5_r.html#ga400154b014acd1736bae9a127f4e9a1a">More...</a><br /></td></tr>
<tr class="separator:ga400154b014acd1736bae9a127f4e9a1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2a00d73b9a13b9069d0ad39225dd9f71"><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="group___h5_r.html#ga2a00d73b9a13b9069d0ad39225dd9f71">H5Ropen_attr</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> rapl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> aapl_id)</td></tr>
<tr class="memdesc:ga2a00d73b9a13b9069d0ad39225dd9f71"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 attribute referenced. <a href="group___h5_r.html#ga2a00d73b9a13b9069d0ad39225dd9f71">More...</a><br /></td></tr>
<tr class="separator:ga2a00d73b9a13b9069d0ad39225dd9f71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6fb098a1a4c9369d76dbeeaf40d6d2af"><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="group___h5_r.html#ga6fb098a1a4c9369d76dbeeaf40d6d2af">H5Rget_obj_type3</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> rapl_id, <a class="el" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> *obj_type)</td></tr>
<tr class="memdesc:ga6fb098a1a4c9369d76dbeeaf40d6d2af"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <a href="group___h5_r.html#ga6fb098a1a4c9369d76dbeeaf40d6d2af">More...</a><br /></td></tr>
<tr class="separator:ga6fb098a1a4c9369d76dbeeaf40d6d2af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga659d950e37122a59d50612b407a48900"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#ga659d950e37122a59d50612b407a48900">H5Rget_file_name</a> (const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, char *name, size_t size)</td></tr>
<tr class="memdesc:ga659d950e37122a59d50612b407a48900"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the file name for a referenced object. <a href="group___h5_r.html#ga659d950e37122a59d50612b407a48900">More...</a><br /></td></tr>
<tr class="separator:ga659d950e37122a59d50612b407a48900"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5a0a3a874cd3c4dc630579521539bb6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6">H5Rget_obj_name</a> (<a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> rapl_id, char *name, size_t size)</td></tr>
<tr class="memdesc:gac5a0a3a874cd3c4dc630579521539bb6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object name for a referenced object. <a href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6">More...</a><br /></td></tr>
<tr class="separator:gac5a0a3a874cd3c4dc630579521539bb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf9c6823346cc34f02b9f5d11e56344a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#gaf9c6823346cc34f02b9f5d11e56344a0">H5Rget_attr_name</a> (const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> *ref_ptr, char *name, size_t size)</td></tr>
<tr class="memdesc:gaf9c6823346cc34f02b9f5d11e56344a0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the attribute name for a referenced object. <a href="group___h5_r.html#gaf9c6823346cc34f02b9f5d11e56344a0">More...</a><br /></td></tr>
<tr class="separator:gaf9c6823346cc34f02b9f5d11e56344a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf3736b2880a58471882b079b9f03defe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#gaf3736b2880a58471882b079b9f03defe">H5Rget_obj_type1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref)</td></tr>
<tr class="memdesc:gaf3736b2880a58471882b079b9f03defe"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <a href="group___h5_r.html#gaf3736b2880a58471882b079b9f03defe">More...</a><br /></td></tr>
<tr class="separator:gaf3736b2880a58471882b079b9f03defe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafe7bbbc168c4836949c4c0b092654c45"><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="group___h5_r.html#gafe7bbbc168c4836949c4c0b092654c45">H5Rdereference1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref)</td></tr>
<tr class="memdesc:gafe7bbbc168c4836949c4c0b092654c45"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 object referenced. <a href="group___h5_r.html#gafe7bbbc168c4836949c4c0b092654c45">More...</a><br /></td></tr>
<tr class="separator:gafe7bbbc168c4836949c4c0b092654c45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ac6997b5de26b11d91a95de2869950d"><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="group___h5_r.html#ga0ac6997b5de26b11d91a95de2869950d">H5Rcreate</a> (void *ref, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> space_id)</td></tr>
<tr class="memdesc:ga0ac6997b5de26b11d91a95de2869950d"><td class="mdescLeft"> </td><td class="mdescRight">Creates a reference. <a href="group___h5_r.html#ga0ac6997b5de26b11d91a95de2869950d">More...</a><br /></td></tr>
<tr class="separator:ga0ac6997b5de26b11d91a95de2869950d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga766e39a76bcdd68dc514425353eff807"><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="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807">H5Rget_obj_type2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> id, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref, <a class="el" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> *obj_type)</td></tr>
<tr class="memdesc:ga766e39a76bcdd68dc514425353eff807"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the type of object that an object reference points to. <a href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807">More...</a><br /></td></tr>
<tr class="separator:ga766e39a76bcdd68dc514425353eff807"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9b09586f7b6ec708434dd8f95f58a9b7"><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="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7">H5Rdereference2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> obj_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> oapl_id, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref)</td></tr>
<tr class="memdesc:ga9b09586f7b6ec708434dd8f95f58a9b7"><td class="mdescLeft"> </td><td class="mdescRight">Opens the HDF5 object referenced. <a href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7">More...</a><br /></td></tr>
<tr class="separator:ga9b09586f7b6ec708434dd8f95f58a9b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1702d609e85b9edd3d1e526a0276484f"><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="group___h5_r.html#ga1702d609e85b9edd3d1e526a0276484f">H5Rget_region</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dataset, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref)</td></tr>
<tr class="memdesc:ga1702d609e85b9edd3d1e526a0276484f"><td class="mdescLeft"> </td><td class="mdescRight">Sets up a dataspace and selection as specified by a region reference. <a href="group___h5_r.html#ga1702d609e85b9edd3d1e526a0276484f">More...</a><br /></td></tr>
<tr class="separator:ga1702d609e85b9edd3d1e526a0276484f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4c112c388f697324270fd085100dccaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa">H5Rget_name</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> ref_type, const void *ref, char *name, size_t size)</td></tr>
<tr class="memdesc:ga4c112c388f697324270fd085100dccaa"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a name for a referenced object. <a href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa">More...</a><br /></td></tr>
<tr class="separator:ga4c112c388f697324270fd085100dccaa"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga5dc19b9d1833af66c5e1f819f2c05c4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5dc19b9d1833af66c5e1f819f2c05c4a">◆ </a></span>H5Rdereference</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Rdereference   <a class="el" href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7">H5Rdereference2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group___h5_r.html#ga5dc19b9d1833af66c5e1f819f2c05c4a">H5Rdereference()</a> is a macro that is mapped to either <a class="el" href="group___h5_r.html#gafe7bbbc168c4836949c4c0b092654c45" title="Opens the HDF5 object referenced.">H5Rdereference1()</a> or <a class="el" href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7" title="Opens the HDF5 object referenced.">H5Rdereference2()</a>.<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<a id="gafe413df448be0d230de922357fd7bc3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe413df448be0d230de922357fd7bc3b">◆ </a></span>H5Rget_obj_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Rget_obj_type   <a class="el" href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807">H5Rget_obj_type2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="group___h5_r.html#gafe413df448be0d230de922357fd7bc3b">H5Rget_obj_type()</a> is a macro that is mapped to either <a class="el" href="group___h5_r.html#gaf3736b2880a58471882b079b9f03defe" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type1()</a> or <a class="el" href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type2()</a> or H5R_get_obj_type3().<br />
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html">API Compatibility Macros</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad5b7b117cfaea90d1e4786304c58c55c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad5b7b117cfaea90d1e4786304c58c55c">◆ </a></span>H5Rcopy()</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> H5Rcopy </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>src_ref_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>dst_ref_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies an existing reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">src_ref_ptr</td><td>Pointer to reference to copy </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dst_ref_ptr</td><td>Pointer to output reference</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="group___h5_r.html#gad5b7b117cfaea90d1e4786304c58c55c" title="Copies an existing reference.">H5Rcopy()</a> creates a copy of an existing reference. <code>src_ref_ptr</code> points to the reference to copy, and <code>dst_ref_ptr</code> is the pointer to the destination reference. </p>
</div>
</div>
<a id="ga0ac6997b5de26b11d91a95de2869950d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ac6997b5de26b11d91a95de2869950d">◆ </a></span>H5Rcreate()</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> H5Rcreate </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ref</em>, </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"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </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"><em>space_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">ref</td><td>Reference created by the function call </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier used to locate the object being pointed to </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of object at location <code>loc_id</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Type of reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference, i.e., of type <a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#ga0ac6997b5de26b11d91a95de2869950d" title="Creates a reference.">H5Rcreate()</a> creates the reference, <code>ref</code>, of the type specified in <code>ref_type</code>, pointing to the object <code>name</code> located at <code>loc_id</code>.</p>
<p>The HDF5 library maps the void type specified above for <code>ref</code> to the type specified in <code>ref_type</code>, which will be one of the following: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> = (-1), </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> = 0, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> = 1, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a> = 2, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a> = 3, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a> = 4, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a> = 5 </div>
<div class="line">} <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a>;</div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056e"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a></div><div class="ttdeci">H5R_type_t</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:51</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a></div><div class="ttdeci">@ H5R_DATASET_REGION2</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:56</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a></div><div class="ttdeci">@ H5R_BADTYPE</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:52</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a></div><div class="ttdeci">@ H5R_OBJECT2</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:55</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a></div><div class="ttdeci">@ H5R_MAXTYPE</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:58</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a></div><div class="ttdeci">@ H5R_DATASET_REGION1</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:54</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a></div><div class="ttdeci">@ H5R_OBJECT1</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:53</div></div>
<div class="ttc" id="a_h5_rpublic_8h_html_a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5"><div class="ttname"><a href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a></div><div class="ttdeci">@ H5R_ATTR</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:57</div></div>
</div><!-- fragment --><p> The parameters <code>loc_id</code> and <code>name</code> are used to locate the object.</p>
<p>The parameter <code>space_id</code> identifies the dataset region that a dataset region reference points to. This parameter is used only with dataset region references and should be set to -1 if the reference is an object reference, <a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a>.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gacae1bf2263befeac54d81f27995721f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacae1bf2263befeac54d81f27995721f8">◆ </a></span>H5Rcreate_attr()</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> H5Rcreate_attr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>attr_name</em>, </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"><em>oapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an attribute reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">attr_name</td><td>Name of attribute </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ref_ptr</td><td>Pointer to reference</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="group___h5_r.html#gacae1bf2263befeac54d81f27995721f8" title="Creates an attribute reference.">H5Rcreate_attr()</a> creates the reference, <code>ref_ptr</code>, pointing to the attribute named <code>attr_name</code> and attached to the object named <code>name</code> located at <code>loc_id</code>.</p>
<p>The parameters <code>loc_id</code> and <code>name</code> locate the object. The parameter <code>attr_name</code> specifies the attribute within the object.</p>
<p>The parameter <code>oapl_id</code> is an object access property list identifier for the object that the referenced attribute is attached to. The access property list must be of the same type as that object, that is a group, dataset or committed datatype property list.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
<div class="ttc" id="a_h5_rpublic_8h_html_a30e65b87f330f177dc5ae434104af580"><div class="ttname"><a href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a></div><div class="ttdeci">#define H5R_REF_BUF_SIZE</div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:38</div></div>
<div class="ttc" id="astruct_h5_r__ref__t_html"><div class="ttname"><a href="struct_h5_r__ref__t.html">H5R_ref_t</a></div><div class="ttdef"><b>Definition:</b> H5Rpublic.h:97</div></div>
</div><!-- fragment --><p> <a class="el" href="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095" title="Closes a reference.">H5Rdestroy()</a> should be used to release the resource from the reference. </p>
</div>
</div>
<a id="gad0fb6ec99ecefa602756a5682addfc69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad0fb6ec99ecefa602756a5682addfc69">◆ </a></span>H5Rcreate_object()</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> H5Rcreate_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </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"><em>oapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an object reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ref_ptr</td><td>Pointer to reference</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="group___h5_r.html#gad0fb6ec99ecefa602756a5682addfc69" title="Creates an object reference.">H5Rcreate_object()</a> creates a reference pointing to the object named <code>name</code> located at <code>loc_id</code>. The parameters <code>loc_id</code> and <code>name</code> are used to locate the object.</p>
<p>The parameter <code>oapl_id</code> is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group, dataset or committed datatype property list.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment --><p> <a class="el" href="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095" title="Closes a reference.">H5Rdestroy()</a> should be used to release the resource from the reference. </p>
</div>
</div>
<a id="ga60134eb917afbe89aa23eb25a30d249b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60134eb917afbe89aa23eb25a30d249b">◆ </a></span>H5Rcreate_region()</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> H5Rcreate_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </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"><em>space_id</em>, </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"><em>oapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a region reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, named datatype, or attribute. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>Name of object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">space_id</td><td>Dataspace identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">ref_ptr</td><td>Pointer to reference</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="group___h5_r.html#ga60134eb917afbe89aa23eb25a30d249b" title="Creates a region reference.">H5Rcreate_region()</a> creates the reference, <code>ref_ptr</code>, pointing to the region represented by <code>space_id</code> within the object named name located at <code>loc_id</code>.</p>
<p>The parameters <code>loc_id</code> and <code>name</code> are used to locate the object. The parameter <code>space_id</code> identifies the dataset region that a dataset region reference points to.</p>
<p>The parameter <code>oapl_id</code> is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a dataset property list in this case.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment --><p> <a class="el" href="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095" title="Closes a reference.">H5Rdestroy()</a> should be used to release the resource from the reference. </p>
</div>
</div>
<a id="gafe7bbbc168c4836949c4c0b092654c45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafe7bbbc168c4836949c4c0b092654c45">◆ </a></span>H5Rdereference1()</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> H5Rdereference1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>obj_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the HDF5 object referenced. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>The reference type of <code>ref</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Reference to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns identifier of referenced object if successful; otherwise returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000082">Deprecated:</a></b></dt><dd>This function has been renamed from <a class="el" href="group___h5_r.html#ga5dc19b9d1833af66c5e1f819f2c05c4a">H5Rdereference()</a> and is deprecated in favor of the macro <a class="el" href="group___h5_r.html#ga5dc19b9d1833af66c5e1f819f2c05c4a">H5Rdereference()</a> or the function <a class="el" href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7" title="Opens the HDF5 object referenced.">H5Rdereference2()</a>.</dd></dl>
<p>Given a reference, <code>ref</code>, to an object or a region in an object, <a class="el" href="group___h5_r.html#gafe7bbbc168c4836949c4c0b092654c45" title="Opens the HDF5 object referenced.">H5Rdereference1()</a> opens that object and returns an identifier.</p>
<p>The parameter <code>obj_id</code> must be a valid identifier for an object in the HDF5 file containing the referenced object, including the file identifier.</p>
<p>The parameter <code>ref_type</code> specifies the reference type of the reference <code>ref</code>. <code>ref_type</code> may contain either of the following values:</p><ul>
<li><a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a></li>
<li><a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a></li>
</ul>
<p>The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function, such as <a class="el" href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> or <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a> for datasets.</p>
<dl class="section version"><dt>Version</dt><dd>1.10.0 Function <a class="el" href="group___h5_r.html#ga5dc19b9d1833af66c5e1f819f2c05c4a">H5Rdereference()</a> renamed to <a class="el" href="group___h5_r.html#gafe7bbbc168c4836949c4c0b092654c45" title="Opens the HDF5 object referenced.">H5Rdereference1()</a> and deprecated in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga9b09586f7b6ec708434dd8f95f58a9b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9b09586f7b6ec708434dd8f95f58a9b7">◆ </a></span>H5Rdereference2()</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> H5Rdereference2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>obj_id</em>, </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"><em>oapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the HDF5 object referenced. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">obj_id</td><td>Object identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>The reference type of <code>ref</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Reference to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns identifier of referenced object if successful; otherwise returns a negative value.</dd></dl>
<p>Given a reference, <code>ref</code>, to an object or a region in an object, <a class="el" href="group___h5_r.html#ga9b09586f7b6ec708434dd8f95f58a9b7" title="Opens the HDF5 object referenced.">H5Rdereference2()</a> opens that object and returns an identifier.</p>
<p>The parameter <code>obj_id</code> must be a valid identifier for the HDF5 file containing the referenced object or for any object in that HDF5 file.</p>
<p>The parameter <code>oapl_id</code> is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group, dataset, or datatype property list.</p>
<p>The parameter <code>ref_type</code> specifies the reference type of the reference <code>ref</code>. <code>ref_type</code> may contain either of the following values:</p><ul>
<li><a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a></li>
<li><a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a></li>
</ul>
<p>The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function, such as <a class="el" href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> or <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a> for datasets.</p>
<dl class="section since"><dt>Since</dt><dd>1.10.0 </dd></dl>
</div>
</div>
<a id="ga026114e6c23588bf89bb473eb9e4d095"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga026114e6c23588bf89bb473eb9e4d095">◆ </a></span>H5Rdestroy()</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> H5Rdestroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes a reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p>Given a reference, <code>ref_ptr</code>, to an object, region or attribute attached to an object, <a class="el" href="group___h5_r.html#ga026114e6c23588bf89bb473eb9e4d095" title="Closes a reference.">H5Rdestroy()</a> releases allocated resources from a previous create call.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment -->
</div>
</div>
<a id="ga8d7dac2c604356f2fc657f36a201aea0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d7dac2c604356f2fc657f36a201aea0">◆ </a></span>H5Requal()</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> H5Requal </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref1_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref2_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether two references are equal. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref1_ptr</td><td>Pointer to reference to compare </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref2_ptr</td><td>Pointer to reference to compare</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a positive value if the references are equal. Returns 0 if the references are not equal. Returns a negative value when the function fails.</dd></dl>
<p><a class="el" href="group___h5_r.html#ga8d7dac2c604356f2fc657f36a201aea0" title="Determines whether two references are equal.">H5Requal()</a> determines whether two references point to the same object, region or attribute.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment -->
</div>
</div>
<a id="gaf9c6823346cc34f02b9f5d11e56344a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9c6823346cc34f02b9f5d11e56344a0">◆ </a></span>H5Rget_attr_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Rget_attr_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the attribute name for a referenced object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to query </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">name</td><td>Buffer to place the attribute name of the reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the <code>name</code> buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the name if successful, otherwise, a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#gaf9c6823346cc34f02b9f5d11e56344a0" title="Retrieves the attribute name for a referenced object.">H5Rget_attr_name()</a> retrieves the attribute name for the attribute reference pointed to by <code>ref_ptr</code>.</p>
<p>Up to size characters of the name are returned in <code>name</code>; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of <code>size</code>, is unknown, a preliminary <a class="el" href="group___h5_r.html#gaf9c6823346cc34f02b9f5d11e56344a0" title="Retrieves the attribute name for a referenced object.">H5Rget_attr_name()</a> call can be made. The return value of this call will be the size of the attribute name. That value can then be passed in for size in the second call to <a class="el" href="group___h5_r.html#gaf9c6823346cc34f02b9f5d11e56344a0" title="Retrieves the attribute name for a referenced object.">H5Rget_attr_name()</a>, which will retrieve the actual name. </p>
</div>
</div>
<a id="ga659d950e37122a59d50612b407a48900"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga659d950e37122a59d50612b407a48900">◆ </a></span>H5Rget_file_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Rget_file_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the file name for a referenced object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to query </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">name</td><td>Buffer to place the file name of the reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the <code>name</code> buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the name if successful, otherwise, a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#ga659d950e37122a59d50612b407a48900" title="Retrieves the file name for a referenced object.">H5Rget_file_name()</a> retrieves the file name for the object, region or attribute reference pointed to by <code>ref_ptr</code>.</p>
<p>Up to <code>size</code> characters of the name are returned in <code>name</code>; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of size, is unknown, a preliminary <a class="el" href="group___h5_r.html#ga659d950e37122a59d50612b407a48900" title="Retrieves the file name for a referenced object.">H5Rget_file_name()</a> call can be made. The return value of this call will be the size of the file name. That value can then be passed in for size in the second call to <a class="el" href="group___h5_r.html#ga659d950e37122a59d50612b407a48900" title="Retrieves the file name for a referenced object.">H5Rget_file_name()</a>, which will retrieve the actual name. </p>
</div>
</div>
<a id="ga4c112c388f697324270fd085100dccaa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c112c388f697324270fd085100dccaa">◆ </a></span>H5Rget_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Rget_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>loc_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a name for a referenced object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">loc_id</td><td>Identifier for the file containing the reference or for any object in that file </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Type of reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>An object or dataset region reference </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>A buffer to place the name of the referenced object or dataset region. If <code>NULL</code>, then this call will return the size in bytes of the name. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the <code>name</code> buffer. When the size is passed in, the <code>NULL</code> terminator needs to be included.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa" title="Retrieves a name for a referenced object.">H5Rget_name()</a> retrieves a name for the object identified by <code>ref</code>.<br />
<code>loc_id</code> is used to identify the file containing the reference. It can be the file identifier for the file containing the reference or an identifier for any object in that file.</p>
<p><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> is the reference type of <code>ref</code>. Valid values include the following: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> = (-1), </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> = 0, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> = 1, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a> = 2, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a> = 3, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a> = 4, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a> = 5 </div>
<div class="line">} <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a>;</div>
</div><!-- fragment --><p> <code>ref</code> is the reference for which the target object's name is sought.</p>
<p>If <code>ref</code> is an object reference, <code>name</code> will be returned with a name for the referenced object. If <code>ref</code> is a dataset region reference, <code>name</code> will contain a name for the object containing the referenced region.</p>
<p>Up to <code>size</code> characters of the name are returned in <code>name</code>; additional characters, if any, are not returned to the user application.</p>
<p>If the length of the name, which determines the required value of <code>size</code>, is unknown, a preliminary <a class="el" href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa" title="Retrieves a name for a referenced object.">H5Rget_name()</a> call can be made. The return value of this call will be the size of the object name. That value can then be assigned to <code>size</code> for a second <a class="el" href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa" title="Retrieves a name for a referenced object.">H5Rget_name()</a> call, which will retrieve the actual name.</p>
<p>If there is no name associated with the object identifier or if the <code>name</code> is <code>NULL</code>, <a class="el" href="group___h5_r.html#ga4c112c388f697324270fd085100dccaa" title="Retrieves a name for a referenced object.">H5Rget_name()</a> returns the size of the <code>name</code> buffer (the size does not include the <code>NULL</code> terminator).</p>
<p>Note that an object in an HDF5 file may have multiple paths if there are multiple links pointing to it. This function may return any one of these paths.</p>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gac5a0a3a874cd3c4dc630579521539bb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5a0a3a874cd3c4dc630579521539bb6">◆ </a></span>H5Rget_obj_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#af629ed855824cf5955b54529adf78ad6">ssize_t</a> H5Rget_obj_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </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"><em>rapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the object name for a referenced object. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rapl_id</td><td>Reference access property list identifier </td></tr>
<tr><td class="paramdir">[in,out]</td><td class="paramname">name</td><td>Buffer to place the file name of the reference </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size of the <code>name</code> buffer</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the length of the name if successful, returning 0 (zero) if no name is associated with the identifier. Otherwise returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6" title="Retrieves the object name for a referenced object.">H5Rget_obj_name()</a> retrieves the object name for the object, region or attribute reference pointed to by <code>ref_ptr</code>.</p>
<p>The parameter <code>rapl_id</code> is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</p>
<p>Up to size characters of the name are returned in <code>name</code>; additional characters, if any, are not returned to the user application. If the length of the name, which determines the required value of <code>size</code>, is unknown, a preliminary call to <a class="el" href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6" title="Retrieves the object name for a referenced object.">H5Rget_obj_name()</a> call can be made. The return value of this call will be the size of the object name. That value can then be passed in for <code>size</code> in the second call to <a class="el" href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6" title="Retrieves the object name for a referenced object.">H5Rget_obj_name()</a>, which will retrieve the actual name. If there is no name associated with the object identifier or if the name is NULL, <a class="el" href="group___h5_r.html#gac5a0a3a874cd3c4dc630579521539bb6" title="Retrieves the object name for a referenced object.">H5Rget_obj_name()</a> returns the size of the name buffer (the size does not include the <code>\0</code> terminator).</p>
<p>If <code>ref_ptr</code> is an object reference, <code>name</code> will be returned with a name for the referenced object. If <code>ref_ptr</code> is a dataset region reference, <code>name</code> will contain a name for the object containing the referenced region. If <code>ref_ptr</code> is an attribute reference, <code>name</code> will contain a name for the object the attribute is attached to. Note that an object in an HDF5 file may have multiple paths if there are multiple links pointing to it. This function may return any one of these paths. </p>
</div>
</div>
<a id="gaf3736b2880a58471882b079b9f03defe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3736b2880a58471882b079b9f03defe">◆ </a></span>H5Rget_obj_type1()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> H5Rget_obj_type1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of object that an object reference points to. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>The dataset containing the reference object or the group containing that dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Type of reference to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Reference to query</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a valid object type if successful; otherwise returns a negative value (<a class="el" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a45d6844bdf74176be3b846d007f8c740">H5G_UNKNOWN</a>).</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000081">Deprecated:</a></b></dt><dd>This function has been renamed from <a class="el" href="group___h5_r.html#gafe413df448be0d230de922357fd7bc3b">H5Rget_obj_type()</a> and is deprecated in favor of the macro <a class="el" href="group___h5_r.html#gafe413df448be0d230de922357fd7bc3b">H5Rget_obj_type()</a> or the function <a class="el" href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type2()</a>.</dd></dl>
<p>Given an object reference, <code>ref</code>, <a class="el" href="group___h5_r.html#gaf3736b2880a58471882b079b9f03defe" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type1()</a> returns the type of the referenced object.</p>
<p>A <em>reference type</em> is the type of reference, either an object reference or a dataset region reference. An <em>object reference</em> points to an HDF5 object, while a <em>dataset region reference</em> points to a defined region within a dataset.</p>
<p>The <em>referenced object</em> is the object the reference points to. The <em>referenced object type</em>, or the type of the referenced object, is the type of the object that the reference points to.</p>
<p>The location identifier, <code>id</code>, is the identifier for either the dataset containing the object reference or the group containing that dataset.</p>
<p>Valid reference types, to pass in as <code>ref_type</code>, include the following: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> = (-1), </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> = 0, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> = 1, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a> = 2, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a> = 3, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a> = 4, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a> = 5 </div>
<div class="line">} <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a>;</div>
</div><!-- fragment --><p> If the application does not already know the object reference type, that can be determined with three preliminary calls:</p>
<ul>
<li>Call <a class="el" href="group___h5_d.html#ga7cd04b8332e8a0939b9973fbc500cadb" title="Returns an identifier for a copy of the datatype for a dataset.">H5Dget_type()</a> on the dataset containing the reference to get a datatype identifier for the dataset's datatype. </li>
<li>Using that datatype identifier, <a class="el" href="group___h5_t.html#ga364545c053f925fec65880b235e37898" title="Returns a datatype class.">H5Tget_class()</a> returns a datatype class.<br />
If the datatype class is <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a>, <a class="el" href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f" title="Determines whether two datatype identifiers refer to the same datatype.">H5Tequal()</a> can then be used to determine whether the reference's datatype is <a class="el" href="group___p_d_t_s_t_d.html#gadc17e0960dc7ef08e029bf17201670e1">H5T_STD_REF_OBJ</a> or <a class="el" href="group___p_d_t_s_t_d.html#gaf5cb0d5cec3d40d8b3ac27512f86895e">H5T_STD_REF_DSETREG</a>:<ul>
<li>If the datatype is <a class="el" href="group___p_d_t_s_t_d.html#gadc17e0960dc7ef08e029bf17201670e1">H5T_STD_REF_OBJ</a>, the reference object type is <a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a>.</li>
<li>If the datatype is <a class="el" href="group___p_d_t_s_t_d.html#gaf5cb0d5cec3d40d8b3ac27512f86895e">H5T_STD_REF_DSETREG</a>, the reference object type is <a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a>.</li>
</ul>
</li>
</ul>
<p>When the function completes successfully, it returns one of the following valid object type values (defined in <a class="el" href="_h5_gpublic_8h.html">H5Gpublic.h</a>): </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a> {</div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a45d6844bdf74176be3b846d007f8c740">H5G_UNKNOWN</a> = -1, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a5797c5320135bb6d2d95e4ac65c3f165">H5G_GROUP</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a76b698867a009f71f14db4e18a0a74e7">H5G_DATASET</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a1e1ef9abeaee9ae9b93ee7ecd05243ef">H5G_TYPE</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a0043526475bbfd89e75a77d2868c7a6c">H5G_LINK</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a9d73a648e21cacd56c1b93d1d75f67d3">H5G_UDLINK</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a8c0a2907854311285cd7bf5ab5562404">H5G_RESERVED_5</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a5fd24183914c12dd049f433cb6db2ff1">H5G_RESERVED_6</a>, </div>
<div class="line"> <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6aeb72828acc9addd40e217c9303e43be2">H5G_RESERVED_7</a> </div>
<div class="line">} <a class="code" href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a>;</div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6">H5G_obj_t</a></div><div class="ttdeci">H5G_obj_t</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:535</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a0043526475bbfd89e75a77d2868c7a6c"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a0043526475bbfd89e75a77d2868c7a6c">H5G_LINK</a></div><div class="ttdeci">@ H5G_LINK</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:540</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a1e1ef9abeaee9ae9b93ee7ecd05243ef"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a1e1ef9abeaee9ae9b93ee7ecd05243ef">H5G_TYPE</a></div><div class="ttdeci">@ H5G_TYPE</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:539</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a45d6844bdf74176be3b846d007f8c740"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a45d6844bdf74176be3b846d007f8c740">H5G_UNKNOWN</a></div><div class="ttdeci">@ H5G_UNKNOWN</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:536</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a5797c5320135bb6d2d95e4ac65c3f165"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a5797c5320135bb6d2d95e4ac65c3f165">H5G_GROUP</a></div><div class="ttdeci">@ H5G_GROUP</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:537</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a5fd24183914c12dd049f433cb6db2ff1"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a5fd24183914c12dd049f433cb6db2ff1">H5G_RESERVED_6</a></div><div class="ttdeci">@ H5G_RESERVED_6</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:543</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a76b698867a009f71f14db4e18a0a74e7"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a76b698867a009f71f14db4e18a0a74e7">H5G_DATASET</a></div><div class="ttdeci">@ H5G_DATASET</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:538</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a8c0a2907854311285cd7bf5ab5562404"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a8c0a2907854311285cd7bf5ab5562404">H5G_RESERVED_5</a></div><div class="ttdeci">@ H5G_RESERVED_5</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:542</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6a9d73a648e21cacd56c1b93d1d75f67d3"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6a9d73a648e21cacd56c1b93d1d75f67d3">H5G_UDLINK</a></div><div class="ttdeci">@ H5G_UDLINK</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:541</div></div>
<div class="ttc" id="a_h5_gpublic_8h_html_a4ee921b13233a7c297b81a49022a1dd6aeb72828acc9addd40e217c9303e43be2"><div class="ttname"><a href="_h5_gpublic_8h.html#a4ee921b13233a7c297b81a49022a1dd6aeb72828acc9addd40e217c9303e43be2">H5G_RESERVED_7</a></div><div class="ttdeci">@ H5G_RESERVED_7</div><div class="ttdef"><b>Definition:</b> H5Gpublic.h:544</div></div>
</div><!-- fragment --> <dl class="section version"><dt>Version</dt><dd>1.8.0 Function <a class="el" href="group___h5_r.html#gafe413df448be0d230de922357fd7bc3b">H5Rget_obj_type()</a> renamed to <a class="el" href="group___h5_r.html#gaf3736b2880a58471882b079b9f03defe" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type1()</a> and deprecated in this release. </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.6.0 </dd></dl>
</div>
</div>
<a id="ga766e39a76bcdd68dc514425353eff807"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga766e39a76bcdd68dc514425353eff807">◆ </a></span>H5Rget_obj_type2()</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> H5Rget_obj_type2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> * </td>
<td class="paramname"><em>obj_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of object that an object reference points to. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">id</td><td>The dataset containing the reference object or the group containing that dataset </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Type of reference to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Reference to query </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">obj_type</td><td>Type of referenced 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>Given an object reference, <code>ref</code>, <a class="el" href="group___h5_r.html#ga766e39a76bcdd68dc514425353eff807" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type2()</a> returns the type of the referenced object in <code>obj_type</code>.</p>
<p>A <em>reference type</em> is the type of reference, either an object reference or a dataset region reference. An <em>object reference</em> points to an HDF5 object while a <em>dataset region reference</em> points to a defined region within a dataset.</p>
<p>The <em>referenced object</em> is the object the reference points to. The <em>referenced object type</em>, or the type of the referenced object, is the type of the object that the reference points to.</p>
<p>The location identifier, <code>id</code>, is the identifier for either the dataset containing the object reference or the group containing that dataset.</p>
<p>Valid reference types, to pass in as <code>ref_type</code>, include the following: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> = (-1), </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> = 0, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> = 1, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a> = 2, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a> = 3, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a> = 4, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a> = 5 </div>
<div class="line">} <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a>;</div>
</div><!-- fragment --><p> If the application does not already know the object reference type, that can be determined with three preliminary calls:</p>
<ul>
<li>Call <a class="el" href="group___h5_d.html#ga7cd04b8332e8a0939b9973fbc500cadb" title="Returns an identifier for a copy of the datatype for a dataset.">H5Dget_type()</a> on the dataset containing the reference to get a datatype identifier for the dataset's datatype. </li>
<li>Using that datatype identifier, <a class="el" href="group___h5_t.html#ga364545c053f925fec65880b235e37898" title="Returns a datatype class.">H5Tget_class()</a> returns a datatype class.<br />
If the datatype class is <a class="el" href="_h5_tpublic_8h.html#a071841985f647f69516dbe77d93167f2a5850e0b9353a5e7aeb615fb943d4e9cd">H5T_REFERENCE</a>, <a class="el" href="group___h5_t.html#gaa92250f289b557b63cba974defa20b0f" title="Determines whether two datatype identifiers refer to the same datatype.">H5Tequal()</a> can then be used to determine whether the reference's datatype is <a class="el" href="group___p_d_t_s_t_d.html#gadc17e0960dc7ef08e029bf17201670e1">H5T_STD_REF_OBJ</a> or <a class="el" href="group___p_d_t_s_t_d.html#gaf5cb0d5cec3d40d8b3ac27512f86895e">H5T_STD_REF_DSETREG</a>:<ul>
<li>If the datatype is <a class="el" href="group___p_d_t_s_t_d.html#gadc17e0960dc7ef08e029bf17201670e1">H5T_STD_REF_OBJ</a>, the reference object type is <a class="el" href="_h5_rpublic_8h.html#ae1ffa09875ca6778df3a577592dacbd2">H5R_OBJECT</a>.</li>
<li>If the datatype is <a class="el" href="group___p_d_t_s_t_d.html#gaf5cb0d5cec3d40d8b3ac27512f86895e">H5T_STD_REF_DSETREG</a>, the reference object type is <a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a>.</li>
</ul>
</li>
</ul>
<p>When the function completes successfully, it returns one of the following valid object type values (defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a>): </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> {</div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca77b7f6c4f4a5dc7463b868876e303d20">H5O_TYPE_UNKNOWN</a> = -1, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecadab6343bd9f2c6d54d07816d5d823cf8">H5O_TYPE_GROUP</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca5ca744a77f8cd2b28dda90c37807ae31">H5O_TYPE_DATASET</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaaf17b046771c311d41bed7383874050e">H5O_TYPE_NAMED_DATATYPE</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca284c0f71c6d5986d1d62a5beea599468">H5O_TYPE_MAP</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaedfc23c7f5f047b0ca4b03608661ec79">H5O_TYPE_NTYPES</a> </div>
<div class="line">} <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a>;</div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdec"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a></div><div class="ttdeci">H5O_type_t</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:107</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdeca284c0f71c6d5986d1d62a5beea599468"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca284c0f71c6d5986d1d62a5beea599468">H5O_TYPE_MAP</a></div><div class="ttdeci">@ H5O_TYPE_MAP</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:112</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdeca5ca744a77f8cd2b28dda90c37807ae31"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca5ca744a77f8cd2b28dda90c37807ae31">H5O_TYPE_DATASET</a></div><div class="ttdeci">@ H5O_TYPE_DATASET</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:110</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdeca77b7f6c4f4a5dc7463b868876e303d20"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca77b7f6c4f4a5dc7463b868876e303d20">H5O_TYPE_UNKNOWN</a></div><div class="ttdeci">@ H5O_TYPE_UNKNOWN</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:108</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdecaaf17b046771c311d41bed7383874050e"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaaf17b046771c311d41bed7383874050e">H5O_TYPE_NAMED_DATATYPE</a></div><div class="ttdeci">@ H5O_TYPE_NAMED_DATATYPE</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:111</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdecadab6343bd9f2c6d54d07816d5d823cf8"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecadab6343bd9f2c6d54d07816d5d823cf8">H5O_TYPE_GROUP</a></div><div class="ttdeci">@ H5O_TYPE_GROUP</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:109</div></div>
<div class="ttc" id="a_h5_opublic_8h_html_a929ff459574495f461657f6be804cdecaedfc23c7f5f047b0ca4b03608661ec79"><div class="ttname"><a href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaedfc23c7f5f047b0ca4b03608661ec79">H5O_TYPE_NTYPES</a></div><div class="ttdeci">@ H5O_TYPE_NTYPES</div><div class="ttdef"><b>Definition:</b> H5Opublic.h:113</div></div>
</div><!-- fragment --> <dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga6fb098a1a4c9369d76dbeeaf40d6d2af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6fb098a1a4c9369d76dbeeaf40d6d2af">◆ </a></span>H5Rget_obj_type3()</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> H5Rget_obj_type3 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </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"><em>rapl_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> * </td>
<td class="paramname"><em>obj_type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of object that an object reference points to. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to query </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rapl_id</td><td>Reference access property list identifier </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">obj_type</td><td>Type of referenced 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>Given a reference, <code>ref_ptr</code>, <a class="el" href="group___h5_r.html#ga6fb098a1a4c9369d76dbeeaf40d6d2af" title="Retrieves the type of object that an object reference points to.">H5Rget_obj_type3()</a> retrieves the type of the referenced object in <code>obj_type</code>.</p>
<p>The parameter <code>rapl</code> id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</p>
<p>Upon success, the function returns in <code>obj_type</code> the type of the object that the reference points to. Valid values for this referenced object type are as followed (defined in <a class="el" href="_h5_opublic_8h.html">H5Opublic.h</a>): </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a> {</div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca77b7f6c4f4a5dc7463b868876e303d20">H5O_TYPE_UNKNOWN</a> = -1, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecadab6343bd9f2c6d54d07816d5d823cf8">H5O_TYPE_GROUP</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca5ca744a77f8cd2b28dda90c37807ae31">H5O_TYPE_DATASET</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaaf17b046771c311d41bed7383874050e">H5O_TYPE_NAMED_DATATYPE</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdeca284c0f71c6d5986d1d62a5beea599468">H5O_TYPE_MAP</a>, </div>
<div class="line"> <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdecaedfc23c7f5f047b0ca4b03608661ec79">H5O_TYPE_NTYPES</a> </div>
<div class="line">} <a class="code" href="_h5_opublic_8h.html#a929ff459574495f461657f6be804cdec">H5O_type_t</a>;</div>
</div><!-- fragment -->
</div>
</div>
<a id="ga1702d609e85b9edd3d1e526a0276484f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1702d609e85b9edd3d1e526a0276484f">◆ </a></span>H5Rget_region()</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> H5Rget_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> </td>
<td class="paramname"><em>dataset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> </td>
<td class="paramname"><em>ref_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ref</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up a dataspace and selection as specified by a region reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dataset</td><td>File identifier or identifier for any object in the file containing the referenced region </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref_type</td><td>Reference type of <code>ref</code>, which must be <a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>Region reference to open</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a valid dataspace identifier if successful; otherwise returns a negative value.</dd></dl>
<p><a class="el" href="group___h5_r.html#ga1702d609e85b9edd3d1e526a0276484f" title="Sets up a dataspace and selection as specified by a region reference.">H5Rget_region()</a> creates a copy of the dataspace of the dataset pointed to by a region reference, <code>ref</code>, and defines a selection matching the selection pointed to by ref within the dataspace copy.</p>
<p><code>dataset</code> is used to identify the file containing the referenced region; it can be a file identifier or an identifier for any object in the file.</p>
<p>The parameter <code>ref_type</code> specifies the reference type of <code>ref</code> and must contain the value <a class="el" href="_h5_rpublic_8h.html#a2a28c48c03a4616a02f9157fca4b2df0">H5R_DATASET_REGION</a>.</p>
<p>Use <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> to release the dataspace identifier returned by this function when the identifier is no longer needed. </p>
</div>
</div>
<a id="ga56989d33835ec289269d366dc28aa4ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga56989d33835ec289269d366dc28aa4ad">◆ </a></span>H5Rget_type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a> H5Rget_type </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the type of a reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a valid reference type if successful; otherwise returns <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> .</dd></dl>
<p>Given a reference, <code>ref_ptr</code>, <a class="el" href="group___h5_r.html#ga56989d33835ec289269d366dc28aa4ad" title="Retrieves the type of a reference.">H5Rget_type()</a> returns the type of the reference.</p>
<p>Valid returned reference types are: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea4fc6b2cf09334d77851f8b208105d58f">H5R_BADTYPE</a> = (-1), </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> = 0, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> = 1, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea58376ddd57d594982e0034a3ca2e5bad">H5R_OBJECT2</a> = 2, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056ea2099d2dee8001ab3ce2e7041af5c93d6">H5R_DATASET_REGION2</a> = 3, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae63b3cfa3688767f46335fad6db981a5">H5R_ATTR</a> = 4, </div>
<div class="line"> <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eaa89d43156d194e6538203cf7f4b6bda0">H5R_MAXTYPE</a> = 5 </div>
<div class="line">} <a class="code" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056e">H5R_type_t</a>;</div>
</div><!-- fragment --><p> Note that <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eae218034c065fc240fab1b2c709b7e23c">H5R_OBJECT1</a> and <a class="el" href="_h5_rpublic_8h.html#a7d148ddc165e65b01efabfd738ac056eac9d8cfad097bec7d118333303f67c916">H5R_DATASET_REGION1</a> can never be associated with an <a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> reference and can, therefore, never be returned through that function.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment -->
</div>
</div>
<a id="ga2a00d73b9a13b9069d0ad39225dd9f71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2a00d73b9a13b9069d0ad39225dd9f71">◆ </a></span>H5Ropen_attr()</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> H5Ropen_attr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </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"><em>rapl_id</em>, </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"><em>aapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the HDF5 attribute referenced. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to open </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rapl_id</td><td>Reference access property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">aapl_id</td><td>Attribute access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a attribute identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p>Given a reference, <code>ref_ptr</code>, to an attribute attached to an object, <a class="el" href="group___h5_r.html#ga2a00d73b9a13b9069d0ad39225dd9f71" title="Opens the HDF5 attribute referenced.">H5Ropen_attr()</a> opens the attribute attached to that object and returns an identifier.</p>
<p>The parameter <code>rapl</code> id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</p>
<p>The parameter <code>aapl_id</code> is an attribute access property list identifier for the referenced attribute.</p>
<p>The attribute opened with this function should be closed with <a class="el" href="group___h5_a.html#gaef4394b661e2c930879e9868e122bdda" title="Closes the specified attribute.">H5Aclose()</a> when it is no longer needed. </p>
</div>
</div>
<a id="gaa6692bd3a5b490c8db05b90a5888d0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6692bd3a5b490c8db05b90a5888d0dd">◆ </a></span>H5Ropen_object()</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> H5Ropen_object </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </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"><em>rapl_id</em>, </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"><em>oapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the HDF5 object referenced. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to open </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rapl_id</td><td>Reference access property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a object identifier if successful; otherwise returns <a class="el" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>.</dd></dl>
<p>Given a reference, <code>ref_ptr</code>, to an object, a region in an object, or an attribute attached to an object, <a class="el" href="group___h5_r.html#gaa6692bd3a5b490c8db05b90a5888d0dd" title="Opens the HDF5 object referenced.">H5Ropen_object()</a> opens that object and returns an identifier.</p>
<p>The parameter <code>oapl_id</code> is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a group or dataset property list.</p>
<p><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> is defined in <a class="el" href="_h5_rpublic_8h.html">H5Rpublic.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> uint8_t __data[<a class="code" href="_h5_rpublic_8h.html#a30e65b87f330f177dc5ae434104af580">H5R_REF_BUF_SIZE</a>]; </div>
<div class="line"> int64_t align; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code" href="struct_h5_r__ref__t.html">H5R_ref_t</a>;</div>
</div><!-- fragment --><p> The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function, such as <a class="el" href="group___h5_o.html#ga545ad7c54987013ebd50b40fe9e73c61" title="Closes an object in an HDF5 file.">H5Oclose()</a> or <a class="el" href="group___h5_d.html#gae47c3f38db49db127faf221624c30609" title="Closes the specified dataset.">H5Dclose()</a> for datasets. </p>
</div>
</div>
<a id="ga400154b014acd1736bae9a127f4e9a1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga400154b014acd1736bae9a127f4e9a1a">◆ </a></span>H5Ropen_region()</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> H5Ropen_region </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_h5_r__ref__t.html">H5R_ref_t</a> * </td>
<td class="paramname"><em>ref_ptr</em>, </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"><em>rapl_id</em>, </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"><em>oapl_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up a dataspace and selection as specified by a region reference. </p>
<hr />
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ref_ptr</td><td>Pointer to reference to open </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">rapl_id</td><td>Reference access property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">oapl_id</td><td>Object access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a dataspace 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="group___h5_r.html#ga400154b014acd1736bae9a127f4e9a1a" title="Sets up a dataspace and selection as specified by a region reference.">H5Ropen_region()</a> creates a copy of the dataspace of the dataset pointed to by a region reference, <code>ref_ptr</code>, and defines a selection matching the selection pointed to by <code>ref_ptr</code> within the dataspace copy.</p>
<p>The parameter <code>rapl</code> id is a reference access property list identifier for the reference. The access property list can be used to access external files that the reference points to (through a file access property list).</p>
<p>The parameter <code>oapl</code> id is an object access property list identifier for the referenced object. The access property list must be of the same type as the object being referenced, that is a dataset property list in that case.</p>
<p>Use <a class="el" href="group___h5_s.html#ga2b53128a39c8f104c1c9c2a91590fcc1" title="Releases and terminates access to a dataspace.">H5Sclose()</a> to release the dataspace identifier returned by this function when the identifier is no longer needed. </p>
</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.9.1 </li>
</ul>
</div>
</body>
</html>
|
