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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Links (H5L)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<!-- <link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
-->
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
</head>
<body>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
 <span id="projectnumber">1.15.0.560e80c</span>
</div>
<div id="projectbrief">API Reference</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('group___h5_l.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Topics</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Links (H5L)</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 links and link types. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group___t_r_a_v.html">Link Traversal</a> for <a class="el" href="group___t_r_a_v.html#ga55406698106930db68242987c11ba051">H5Literate</a>, <a class="el" href="group___t_r_a_v.html#ga655b002428e0176c2fa23a0315fbbcc2">H5Literate_by_name</a> and <a class="el" href="group___t_r_a_v.html#gac0558936502924d9e898d8b6e041ed69">H5Lvisit</a>, <a class="el" href="group___t_r_a_v.html#ga138405315e233673741893e4e250f055">H5Lvisit_by_name</a> </dd>
<dd>
<a class="el" href="group___h5_l_a.html">Advanced Link Functions</a> for <a class="el" href="group___h5_l_a.html#ga5073a814de9878bad53e1d3c900ea77f" title="Registers a user-defined link class or changes behavior of an existing class.">H5Lregister</a>, <a class="el" href="group___h5_l_a.html#ga01ddc889d27306a96a7cd27b6084a5ec" title="Unregisters a class of user-defined links.">H5Lunregister</a> and <a class="el" href="group___h5_l_a.html#ga02c1cf38efea97d18e5e2f65df3f08a2" title="Determines whether a class of user-defined links is registered.">H5Lis_registered</a> </dd></dl>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
Topics</h2></td></tr>
<tr class="memitem:group___h5_l_a" id="r_group___h5_l_a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___h5_l_a.html">Advanced Link Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group___t_r_a_v" id="r_group___t_r_a_v"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___t_r_a_v.html">Link Traversal</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga97279697f3010a6ad31dd7f4341eb698" id="r_ga97279697f3010a6ad31dd7f4341eb698"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info</a>   <a class="el" href="#ga65e63c6e880fd0183c40486d6748e400">H5Lget_info2</a></td></tr>
<tr class="separator:ga97279697f3010a6ad31dd7f4341eb698"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4db00b8b944eae68233438165c784b67" id="r_ga4db00b8b944eae68233438165c784b67"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx</a>   <a class="el" href="#gaecfb3ef8520e9224b24a151ff8459ba9">H5Lget_info_by_idx2</a></td></tr>
<tr class="separator:ga4db00b8b944eae68233438165c784b67"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0bbc7f9bf25c8aca9dd8433a325c8acb" id="r_ga0bbc7f9bf25c8aca9dd8433a325c8acb"><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="#ga0bbc7f9bf25c8aca9dd8433a325c8acb">H5Lmove</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_loc, const char *src_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_loc, const char *dst_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga0bbc7f9bf25c8aca9dd8433a325c8acb"><td class="mdescLeft"> </td><td class="mdescRight">Moves a link within an HDF5 file. <br /></td></tr>
<tr class="separator:ga0bbc7f9bf25c8aca9dd8433a325c8acb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafd4624f1c040d5f1df36cb1e6986aac6" id="r_gafd4624f1c040d5f1df36cb1e6986aac6"><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="#gafd4624f1c040d5f1df36cb1e6986aac6">H5Lcopy</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> src_loc, const char *src_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_loc, const char *dst_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gafd4624f1c040d5f1df36cb1e6986aac6"><td class="mdescLeft"> </td><td class="mdescRight">Creates an identical copy of a link with the same creation time and target. The new link can have a different name and be in a different location than the original. <br /></td></tr>
<tr class="separator:gafd4624f1c040d5f1df36cb1e6986aac6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69d50f7acdfd2f1dc7c4372397e63bd2" id="r_ga69d50f7acdfd2f1dc7c4372397e63bd2"><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="#ga69d50f7acdfd2f1dc7c4372397e63bd2">H5Lcreate_hard</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> cur_loc, const char *cur_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> dst_loc, const char *dst_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga69d50f7acdfd2f1dc7c4372397e63bd2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a hard link to an object. <br /></td></tr>
<tr class="separator:ga69d50f7acdfd2f1dc7c4372397e63bd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga894444623b58ce1ac3bd35538245ac78" id="r_ga894444623b58ce1ac3bd35538245ac78"><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="#ga894444623b58ce1ac3bd35538245ac78">H5Lcreate_soft</a> (const char *link_target, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> link_loc_id, const char *link_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga894444623b58ce1ac3bd35538245ac78"><td class="mdescLeft"> </td><td class="mdescRight">Creates a soft link. <br /></td></tr>
<tr class="separator:ga894444623b58ce1ac3bd35538245ac78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5b4e7f59f5d4bdae94fd8ce6875295cf" id="r_ga5b4e7f59f5d4bdae94fd8ce6875295cf"><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="#ga5b4e7f59f5d4bdae94fd8ce6875295cf">H5Ldelete</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> lapl_id)</td></tr>
<tr class="memdesc:ga5b4e7f59f5d4bdae94fd8ce6875295cf"><td class="mdescLeft"> </td><td class="mdescRight">Removes a link from a group. <br /></td></tr>
<tr class="separator:ga5b4e7f59f5d4bdae94fd8ce6875295cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaf5f820856afdd34f9070a797a246805" id="r_gaaf5f820856afdd34f9070a797a246805"><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="#gaaf5f820856afdd34f9070a797a246805">H5Ldelete_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gaaf5f820856afdd34f9070a797a246805"><td class="mdescLeft"> </td><td class="mdescRight">Removes the <em>n</em>-th link in a group. <br /></td></tr>
<tr class="separator:gaaf5f820856afdd34f9070a797a246805"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8eaacc372afc314e44521dfc1f66dcf4" id="r_ga8eaacc372afc314e44521dfc1f66dcf4"><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="#ga8eaacc372afc314e44521dfc1f66dcf4">H5Lget_val</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, void *buf, size_t size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga8eaacc372afc314e44521dfc1f66dcf4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of a link. <br /></td></tr>
<tr class="separator:ga8eaacc372afc314e44521dfc1f66dcf4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7be56de947e09a8d084e9d13a90bf3c" id="r_gaf7be56de947e09a8d084e9d13a90bf3c"><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="#gaf7be56de947e09a8d084e9d13a90bf3c">H5Lget_val_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, void *buf, size_t size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gaf7be56de947e09a8d084e9d13a90bf3c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves value of the <em>n</em>-th link in a group, according to the order within an index. <br /></td></tr>
<tr class="separator:gaf7be56de947e09a8d084e9d13a90bf3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga171be6e41dc1a464edc402df0ebdf801" id="r_ga171be6e41dc1a464edc402df0ebdf801"><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="#ga171be6e41dc1a464edc402df0ebdf801">H5Lexists</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> lapl_id)</td></tr>
<tr class="memdesc:ga171be6e41dc1a464edc402df0ebdf801"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether a link with the specified name exists in a group. <br /></td></tr>
<tr class="separator:ga171be6e41dc1a464edc402df0ebdf801"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga65e63c6e880fd0183c40486d6748e400" id="r_ga65e63c6e880fd0183c40486d6748e400"><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="#ga65e63c6e880fd0183c40486d6748e400">H5Lget_info2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_l__info2__t.html">H5L_info2_t</a> *linfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga65e63c6e880fd0183c40486d6748e400"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about a link. <br /></td></tr>
<tr class="separator:ga65e63c6e880fd0183c40486d6748e400"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaecfb3ef8520e9224b24a151ff8459ba9" id="r_gaecfb3ef8520e9224b24a151ff8459ba9"><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="#gaecfb3ef8520e9224b24a151ff8459ba9">H5Lget_info_by_idx2</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="struct_h5_l__info2__t.html">H5L_info2_t</a> *linfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gaecfb3ef8520e9224b24a151ff8459ba9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves metadata for a link in a group, according to the order within a field or index. <br /></td></tr>
<tr class="separator:gaecfb3ef8520e9224b24a151ff8459ba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga453ea40c3bb85ec8120dd17deed2bd90" id="r_ga453ea40c3bb85ec8120dd17deed2bd90"><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="#ga453ea40c3bb85ec8120dd17deed2bd90">H5Lget_name_by_idx</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, char *name, size_t size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga453ea40c3bb85ec8120dd17deed2bd90"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves name of the <em>n</em>-th link in a group, according to the order within a specified field or index. <br /></td></tr>
<tr class="separator:ga453ea40c3bb85ec8120dd17deed2bd90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadaf9732947c45cd4d2442e7f58873fc2" id="r_gadaf9732947c45cd4d2442e7f58873fc2"><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="#gadaf9732947c45cd4d2442e7f58873fc2">H5Lcreate_ud</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> link_loc_id, const char *link_name, <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> link_type, const void *udata, size_t udata_size, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gadaf9732947c45cd4d2442e7f58873fc2"><td class="mdescLeft"> </td><td class="mdescRight">Creates a link of a user-defined type. <br /></td></tr>
<tr class="separator:gadaf9732947c45cd4d2442e7f58873fc2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade0c3b274c185d148f000172fbdc3220" id="r_gade0c3b274c185d148f000172fbdc3220"><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="#gade0c3b274c185d148f000172fbdc3220">H5Lunpack_elink_val</a> (const void *ext_linkval, size_t link_size, unsigned *flags, const char **filename, const char **obj_path)</td></tr>
<tr class="memdesc:gade0c3b274c185d148f000172fbdc3220"><td class="mdescLeft"> </td><td class="mdescRight">Decodes external link information. <br /></td></tr>
<tr class="separator:gade0c3b274c185d148f000172fbdc3220"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15dfaeb9b1c0b3136533cb97ee45e683" id="r_ga15dfaeb9b1c0b3136533cb97ee45e683"><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="#ga15dfaeb9b1c0b3136533cb97ee45e683">H5Lcreate_external</a> (const char *file_name, const char *obj_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> link_loc_id, const char *link_name, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lcpl_id, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga15dfaeb9b1c0b3136533cb97ee45e683"><td class="mdescLeft"> </td><td class="mdescRight">Creates an external link, a soft link to an object in a different file. <br /></td></tr>
<tr class="separator:ga15dfaeb9b1c0b3136533cb97ee45e683"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacc2ad7f2b402c4bf9bb122d7f43b98dc" id="r_gacc2ad7f2b402c4bf9bb122d7f43b98dc"><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="#gacc2ad7f2b402c4bf9bb122d7f43b98dc">H5Lget_info1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *name, <a class="el" href="struct_h5_l__info1__t.html">H5L_info1_t</a> *linfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:gacc2ad7f2b402c4bf9bb122d7f43b98dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns information about a link. <br /></td></tr>
<tr class="separator:gacc2ad7f2b402c4bf9bb122d7f43b98dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ed207f47e0e0f768f0d540c73e37e2a" id="r_ga7ed207f47e0e0f768f0d540c73e37e2a"><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="#ga7ed207f47e0e0f768f0d540c73e37e2a">H5Lget_info_by_idx1</a> (<a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> loc_id, const char *group_name, <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a> idx_type, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a> order, <a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a> n, <a class="el" href="struct_h5_l__info1__t.html">H5L_info1_t</a> *linfo, <a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> lapl_id)</td></tr>
<tr class="memdesc:ga7ed207f47e0e0f768f0d540c73e37e2a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves metadata for a link in a group, according to the order within a field or index. <br /></td></tr>
<tr class="separator:ga7ed207f47e0e0f768f0d540c73e37e2a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga97279697f3010a6ad31dd7f4341eb698" name="ga97279697f3010a6ad31dd7f4341eb698"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga97279697f3010a6ad31dd7f4341eb698">◆ </a></span>H5Lget_info</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Lget_info   <a class="el" href="#ga65e63c6e880fd0183c40486d6748e400">H5Lget_info2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a> is a macro that is mapped to either <a class="el" href="#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1()</a> or <a class="el" href="#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2()</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="ga4db00b8b944eae68233438165c784b67" name="ga4db00b8b944eae68233438165c784b67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4db00b8b944eae68233438165c784b67">◆ </a></span>H5Lget_info_by_idx</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define H5Lget_info_by_idx   <a class="el" href="#gaecfb3ef8520e9224b24a151ff8459ba9">H5Lget_info_by_idx2</a></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx()</a> is a macro that is mapped to either <a class="el" href="#ga7ed207f47e0e0f768f0d540c73e37e2a" title="Retrieves metadata for a link in a group, according to the order within a field or index.">H5Lget_info_by_idx1()</a> or <a class="el" href="#gaecfb3ef8520e9224b24a151ff8459ba9" title="Retrieves metadata for a link in a group, according to the order within a field or index.">H5Lget_info_by_idx2()</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>
<h2 class="groupheader">Function Documentation</h2>
<a id="gafd4624f1c040d5f1df36cb1e6986aac6" name="gafd4624f1c040d5f1df36cb1e6986aac6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafd4624f1c040d5f1df36cb1e6986aac6">◆ </a></span>H5Lcopy()</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> H5Lcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>src_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dst_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dst_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an identical copy of a link with the same creation time and target. The new link can have a different name and be in a different location than the original. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">src_loc</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">src_name</td><td>Name of the link to be copied </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_loc</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_name</td><td>Name to be assigned to the new copy </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a> copies the link specified by <code>src_name</code> from the location specified by <code>src_loc_id</code> to the location specified by <code>dst_loc_id</code>. The new copy of the link is created with the name <code>dst_name</code>.</p>
<p>If <code>dst_loc_id</code> is a file identifier, <code>dst_name</code> will be interpreted relative to that file's root group.</p>
<p>The new link is created with the creation and access property lists specified by <code>lcpl_id</code> and <code>lapl_id</code>. The interpretation of <code>lcpl_id</code> is limited in the manner described in the next paragraph.</p>
<p><a class="el" href="#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a> retains the creation time and the target of the original link. However, since the link may be renamed, the character encoding is specified in <code>lcpl_id</code> rather than in that of the original link. Other link creation properties are ignored.</p>
<p>If the link is a soft link, also known as a symbolic link, its target is interpreted relative to the location of the copy.</p>
<p>Several properties are available to govern the behavior of <a class="el" href="#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a>. These properties are set in the link creation and access property lists, <code>lcpl_id</code> and <code>lapl_id</code>, respectively. The property controlling creation of missing intermediate groups is set in the link creation property list with <a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group()</a>; this function ignores any other properties in the link creation property list. Properties controlling character encoding, link traversals, and external link prefixes are set in the link access property list with <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding()</a>, <a class="el" href="group___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4" title="Sets maximum number of soft or user-defined link traversals.">H5Pset_nlinks()</a>, and <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a> does not affect the object that the link points to.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd><a class="el" href="#gafd4624f1c040d5f1df36cb1e6986aac6" title="Creates an identical copy of a link with the same creation time and target. The new link can have a d...">H5Lcopy()</a> cannot copy hard links across files as a hard link is not valid without a target object; to copy objects from one file to another, see <a class="el" href="group___h5_o.html#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___h5_o.html#gaa94449be6f67f499be5ddd3fc44f4225" title="Copies an object in an HDF5 file.">H5Ocopy()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga15dfaeb9b1c0b3136533cb97ee45e683" name="ga15dfaeb9b1c0b3136533cb97ee45e683"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga15dfaeb9b1c0b3136533cb97ee45e683">◆ </a></span>H5Lcreate_external()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_h5public_8h.html#a3b079ecf932a5c599499cf7e298af160">herr_t</a> H5Lcreate_external </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>file_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>obj_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>link_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>link_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an external link, a soft link to an object in a different file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">file_name</td><td>Name of the target file containing the target object. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">obj_name</td><td>Path within the target file to the target object </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_loc_id</td><td>Location identifier. The identifier may be that of a file, group, dataset, or named datatype. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_name</td><td>Name of the new link, relative to <code>link_loc_id</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a> creates a new external link. An external link is a soft link to an object in a different HDF5 file from the location of the link, i.e., to an external object.</p>
<p><code>file_name</code> identifies the target file containing the target object; <code>obj_name</code> specifies the path of the target object within that file. <code>obj_name</code> must be an absolute pathname in <code>file_name</code>, i.e., it must start at the target file's root group, but it is not interpreted until an application attempts to traverse it.</p>
<p><code>link_loc_id</code> and <code>link_name</code> specify the location and name, respectively, of the new link. <code>link_name</code> is interpreted relative to <code>link_loc_id</code>. If <code>link_name</code> begins with <code>/</code>, then it is interpreted as an absolute path in the file. The name of the created link will be the last element of the provided path. Prior elements in the path are used to locate the parent group of the new link.</p>
<p><code>lcpl_id</code> is the link creation property list used in creating the new link.</p>
<p><code>lapl_id</code> is the link access property list used in traversing the new link. Note that an external file opened by the traversal of an external link is always opened with the weak file close degree property setting, <a class="el" href="_h5_fpublic_8h.html#aa85fa00d037d2b0401cf72edf9a6475faea1127311a219b44e4af3cb12609035f">H5F_CLOSE_WEAK</a> (see <a class="el" href="group___f_a_p_l.html#ga60e3567f677fd3ade75b909b636d7b9c" title="Sets the file close degree.">H5Pset_fclose_degree()</a>); any file close degree property setting in <code>lapl_id</code> is ignored.</p>
<p>An external link behaves similarly to a soft link, and like a soft link in an HDF5 file, it may dangle: the target file and object need not exist at the time that the external link is created.</p>
<p>When the external link <code>link_name</code> is accessed, the library will search for the target file <code>file_name</code> as described below:</p>
<ul>
<li>If <code>file_name</code> is a relative pathname, the following steps are performed:<ul>
<li>The library will get the prefix(es) set in the environment variable <code>HDF5_EXT_PREFIX</code> and will try to prepend each prefix to <code>file_name</code> to form a new <code>file_name</code>.</li>
<li>If the new <code>file_name</code> does not exist or if <code>HDF5_EXT_PREFIX</code> is not set, the library will get the prefix set via <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a> and prepend it to <code>file_name</code> to form a new <code>file_name</code>.</li>
<li>If the new <code>file_name</code> does not exist or no prefix is being set by <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>, then the path of the file associated with <code>link_loc_id</code> is obtained. This path can be the absolute path or the current working directory plus the relative path of that file when it is created/opened. The library will prepend this path to <code>file_name</code> to form a new <code>file_name</code>.</li>
<li>If the new <code>file_name</code> does not exist, then the library will look for <code>file_name</code> and will return failure/success accordingly.</li>
</ul>
</li>
<li>If <code>file_name</code> is an absolute pathname, the library will first try to find <code>file_name</code>. If <code>file_name</code> does not exist, <code>file_name</code> is stripped of directory paths to form a new <code>file_name</code>. The search for the new <code>file_name</code> then follows the same steps as described above for a relative pathname. See examples below illustrating how target_file_name is stripped to form a new <code>file_name</code>.</li>
</ul>
<p>Note that <code>file_name</code> is considered to be an absolute pathname when the following condition is true:</p>
<ul>
<li>For Unix, the first character of <code>file_name</code> is a slash (<code>/</code>). For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
<li>For Windows, there are 6 cases:<ol type="1">
<li><code>file_name</code> is an absolute drive with an absolute pathname. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>file_name</code> is an absolute pathname without specifying drive name. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>file_name</code> is an absolute drive with a relative pathname. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>tmp\A.h5</code>.</li>
<li><code>file_name</code> is in UNC (Uniform Naming Convention) format with a server name, share name, and pathname. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>file_name</code> is in Long UNC (Uniform Naming Convention) format with a server name, share name, and pathname. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
<li><code>file_name</code> is in Long UNC (Uniform Naming Convention) format with an absolute drive and an absolute pathname. For example, consider a <code>file_name</code> of <code>/tmp/A</code>.h5. If that target file does not exist, the new <code>file_name</code> after stripping will be <code>A.h5</code>.</li>
</ol>
</li>
</ul>
<p>The library opens the target file <code>file_name</code> with the file access property list that is set via <a class="el" href="group___l_a_p_l.html#ga3895e8e60ce8f0b6f32ab7a22c715d1a" title="Sets a file access property list for use in accessing a file pointed to by an external link.">H5Pset_elink_fapl()</a> when the external link link_name is accessed. If no such property list is set, the library uses the file access property list associated with the file of <code>link_loc_id</code> to open the target file.</p>
<p>If an application requires additional control over file access flags or the file access property list, see <a class="el" href="group___l_a_p_l.html#ga8850042eed51777866d7bd0d050cfdc2" title="Sets the external link traversal callback function in a link access property list.">H5Pset_elink_cb()</a>; this function enables the use of an external link callback function as described in <a class="el" href="_h5_lpublic_8h.html#a96345937d04b66a13baec1ef1a6cff76" title="Callback for external link traversal.">H5L_elink_traverse_t()</a>.</p>
<dl class="section attention"><dt>Attention</dt><dd>A file close degree property setting (<a class="el" href="group___f_a_p_l.html#ga60e3567f677fd3ade75b909b636d7b9c" title="Sets the file close degree.">H5Pset_fclose_degree()</a>) in the external link file access property list or in the external link callback function will be ignored. A file opened by means of traversing an external link is always opened with the weak file close degree property setting, <a class="el" href="_h5_fpublic_8h.html#aa85fa00d037d2b0401cf72edf9a6475faea1127311a219b44e4af3cb12609035f">H5F_CLOSE_WEAK</a> .</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga69d50f7acdfd2f1dc7c4372397e63bd2" title="Creates a hard link to an object.">H5Lcreate_hard()</a>, <a class="el" href="#ga894444623b58ce1ac3bd35538245ac78" title="Creates a soft link.">H5Lcreate_soft()</a>, <a class="el" href="#gadaf9732947c45cd4d2442e7f58873fc2" title="Creates a link of a user-defined type.">H5Lcreate_ud()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga69d50f7acdfd2f1dc7c4372397e63bd2" name="ga69d50f7acdfd2f1dc7c4372397e63bd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga69d50f7acdfd2f1dc7c4372397e63bd2">◆ </a></span>H5Lcreate_hard()</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> H5Lcreate_hard </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>cur_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>cur_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dst_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dst_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a hard link to an object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cur_loc</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">cur_name</td><td>Name of the target object, which must already exist </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_loc</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">dst_name</td><td>The name of the new link </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga69d50f7acdfd2f1dc7c4372397e63bd2" title="Creates a hard link to an object.">H5Lcreate_hard()</a> creates a new hard link to a pre-existing object in an HDF5 file.</p>
<p><code>cur_loc</code> and <code>cur_name</code> specify the location and name, respectively, of the target object, i.e., the object that the new hard link points to. <code>dst_loc</code> and <code>dst_name</code> specify the location and name, respectively, of the new hard link.</p>
<p><code>cur_name</code> and <code>dst_name</code> are interpreted relative to <code>cur_loc</code> and <code>dst_loc</code>, respectively. If a given name begins with <code>/</code>, then it will be interpreted as absolute path in the file. The names of the created links will be the last element of each provided path. Prior elements in each path are used to locate the parent groups of each new link. If <code>cur_loc</code> and <code>dst_loc</code> are the same location, the HDF5 macro <a class="el" href="_h5_lpublic_8h.html#a484bbac16dab421b9e32c4d9c2128658" title="Macro to indicate operation occurs on same location.">H5L_SAME_LOC</a> can be used for either parameter (but not both).</p>
<p><code>lcpl_id</code> and <code>lapl_id</code> are the link creation and access property lists associated with the new link.</p>
<dl class="section note"><dt>Note</dt><dd>Hard and soft links are for use only if the target object is in the current file. If the desired target object is in a different file from the new link, an external link may be created with <a class="el" href="#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a>.</dd>
<dd>
The HDF5 library keeps a count of all hard links pointing to an object; if the hard link count reaches zero (0), the object will be deleted from the file. Creating new hard links to an object will prevent it from being deleted if other links are removed. The library maintains no similar count for soft links and they can dangle.</dd>
<dd>
The new link may be one of many that point to that object.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga894444623b58ce1ac3bd35538245ac78" name="ga894444623b58ce1ac3bd35538245ac78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga894444623b58ce1ac3bd35538245ac78">◆ </a></span>H5Lcreate_soft()</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> H5Lcreate_soft </td>
<td>(</td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>link_target</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>link_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>link_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a soft link. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">link_target</td><td>An HDF5 path name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_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">link_name</td><td>The name of the new link </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga894444623b58ce1ac3bd35538245ac78" title="Creates a soft link.">H5Lcreate_soft()</a> creates a new soft link to an object in an HDF5 file.</p>
<p><code>link_target</code> specifies the HDF5 path name the soft link contains. <code>link_target</code> can be an arbitrary HDF5 path name and is interpreted only at lookup time. This path may be absolute in the file or relative to <code>link_loc_id</code>.</p>
<p><code>link_loc_id</code> and <code>link_name</code> specify the location and name, respectively, of the new soft link. <code>link_name</code> is interpreted as a path relative to <code>link_loc_id</code>, or an absolute path if it begins with <code>/</code>. The name of the created link will be the last element of the provided path. Prior elements in the path are used to locate the parent group of the new link.</p>
<p>If <code>link_loc_id</code> is a group identifier, the object pointed to by <code>link_name</code> will be accessed as a member of that group. If <code>link_loc_id</code> is a file identifier, the object will be accessed as a member of the file's root group.</p>
<p><code>lcpl_id</code> and <code>lapl_id</code> are the link creation and access property lists associated with the new link.</p>
<p>For instance, if target_path is <code></code>./foo, <code>link_loc_id</code> specifies <code></code>./x/y/bar, and the name of the new link is <code>new_link</code>, then a subsequent request for <code></code>./x/y/bar/new_link will return the same object as would be found at <code></code>./foo.</p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="#ga894444623b58ce1ac3bd35538245ac78" title="Creates a soft link.">H5Lcreate_soft()</a> is for use only if the target object is in the current file. If the desired target object is in a different file from the new link, use <a class="el" href="#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a> to create an external link.</dd>
<dd>
Soft links and external links are also known as symbolic links as they use a name to point to an object; hard links employ an object's address in the file.</dd>
<dd>
Unlike hard links, a soft link in an HDF5 file is allowed to dangle, meaning that the target object need not exist at the time that the link is created.</dd>
<dd>
The HDF5 library does not keep a count of soft links as it does of hard links.</dd>
<dd>
The new link may be one of many that point to that object.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga69d50f7acdfd2f1dc7c4372397e63bd2" title="Creates a hard link to an object.">H5Lcreate_hard()</a>, <a class="el" href="#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gadaf9732947c45cd4d2442e7f58873fc2" name="gadaf9732947c45cd4d2442e7f58873fc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadaf9732947c45cd4d2442e7f58873fc2">◆ </a></span>H5Lcreate_ud()</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> H5Lcreate_ud </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>link_loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>link_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a></td> <td class="paramname"><span class="paramname"><em>link_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>udata</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>udata_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a link of a user-defined type. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">link_loc_id</td><td>Location identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_name</td><td>Link name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_type</td><td>User-defined link class </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">udata</td><td>User-supplied link information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">udata_size</td><td>Size of udata buffer </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gadaf9732947c45cd4d2442e7f58873fc2" title="Creates a link of a user-defined type.">H5Lcreate_ud()</a> creates a link of user-defined type <code>link_type</code> named <code>link_name</code> at the location specified in <code>link_loc_id</code> with user-specified data <code>udata</code>.</p>
<p><code>link_name</code> is interpreted relative to <code>link_loc_id</code>. If <code>link_name</code> begins with <code>/</code>, then it will be interpreted as an absolute path in the file. The name of the created link will be the last element of the provided path. Prior elements in the path are used to locate the parent group of the new link.</p>
<p>Valid values for the link class of the new link, <code>link_type</code>, include <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a1b8b636539eab03587c22735ec84ea06">H5L_TYPE_EXTERNAL</a> and any user-defined link classes that have been registered with the library. See <a class="el" href="group___h5_l_a.html#ga5073a814de9878bad53e1d3c900ea77f" title="Registers a user-defined link class or changes behavior of an existing class.">H5Lregister()</a> for further information.</p>
<p>The format of the information pointed to by <code>udata</code> is defined by the user. <code>udata_size</code> specifies the size of the <code>udata</code> buffer. <code>udata</code> may be NULL if <code>udata_size</code> is zero (0).</p>
<p>The property lists specified by <code>lcpl_id</code> and <code>lapl_id</code> specify properties used to create and access the link.</p>
<dl class="section note"><dt>Note</dt><dd>The external link type, <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a1b8b636539eab03587c22735ec84ea06">H5L_TYPE_EXTERNAL</a>, included in the HDF5 library distribution, is implemented as a user-defined link type. This was done, in part, to provide a model for the implementation of other user-defined links.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga5b4e7f59f5d4bdae94fd8ce6875295cf" name="ga5b4e7f59f5d4bdae94fd8ce6875295cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5b4e7f59f5d4bdae94fd8ce6875295cf">◆ </a></span>H5Ldelete()</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> H5Ldelete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a link from a group. </p>
<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 the link to delete </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete()</a> removes the link specified by <code>name</code> from the location <code>loc_id</code>.</p>
<p>If the link being removed is a hard link, <a class="el" href="#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete()</a> also decrements the link count for the object to which name points. Unless there is a duplicate hard link in that group, this action removes the object to which name points from the group that previously contained it.</p>
<p>Object headers keep track of how many hard links refer to an object; when the hard link count, also referred to as the reference count, reaches zero, the object can be removed from the file. The file space associated will then be released, i.e., identified in memory as freespace. Objects which are open are not removed until all identifiers to the object are closed.</p>
<dl class="section attention"><dt>Attention</dt><dd>Exercise caution in the use of <a class="el" href="#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete()</a>; if the link being removed is on the only path leading to an HDF5 object, that object may become permanently inaccessible in the file.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga69d50f7acdfd2f1dc7c4372397e63bd2" title="Creates a hard link to an object.">H5Lcreate_hard()</a>, <a class="el" href="#ga894444623b58ce1ac3bd35538245ac78" title="Creates a soft link.">H5Lcreate_soft()</a>, <a class="el" href="#ga15dfaeb9b1c0b3136533cb97ee45e683" title="Creates an external link, a soft link to an object in a different file.">H5Lcreate_external()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaaf5f820856afdd34f9070a797a246805" name="gaaf5f820856afdd34f9070a797a246805"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaf5f820856afdd34f9070a797a246805">◆ </a></span>H5Ldelete_by_idx()</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> H5Ldelete_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>idx_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the <em>n</em>-th link in a group. </p>
<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">group_name</td><td>Name of subject group </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index or field which determines the order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order within field or index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Link for which to retrieve information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaaf5f820856afdd34f9070a797a246805" title="Removes the n-th link in a group.">H5Ldelete_by_idx()</a> removes the <em>n</em>-th link in a group according to the specified order, <code>order</code>, in the specified index, <code>index</code>.</p>
<p>If <code>loc_id</code> specifies the group in which the link resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga5b4e7f59f5d4bdae94fd8ce6875295cf" title="Removes a link from a group.">H5Ldelete()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga171be6e41dc1a464edc402df0ebdf801" name="ga171be6e41dc1a464edc402df0ebdf801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga171be6e41dc1a464edc402df0ebdf801">◆ </a></span>H5Lexists()</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> H5Lexists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines whether a link with the specified name exists in a group. </p>
<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>Link name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> allows an application to determine whether the link <code>name</code> exists in the location specified by <code>loc_id</code>. The link may be of any type; only the presence of a link with that name is checked.</p>
<p>Note that <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> verifies only that the target link exists. If name includes either a relative path or an absolute path to the target link, intermediate steps along the path must be verified before the existence of the target link can be safely checked. If the path is not verified, and an intermediate element of the path does not exist, <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> will fail. The example in the next paragraph illustrates one step-by-step method for verifying the existence of a link with a relative or absolute path.</p>
<p><b>Example:</b> Use the following steps to verify the existence of the link <code>datasetD</code> in the <code>group</code> group1/group2/softlink_to_group3/, where <code>group1</code> is a member of the group specified by <code>loc_id:</code> </p>
<ol type="1">
<li>First, use <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> to verify that the <code>group1</code> exists.</li>
<li>If <code>group1</code> exists, use <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> again, this time with name set to <code>group1/group2</code>, to verify that <code>group2</code> exists.</li>
<li>If <code>group2</code> exists, use <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> with name set to <code>group1/group2/softlink_to_group3</code> to verify that <code>softlink_to_group3</code> exists.</li>
<li>If <code>softlink_to_group3</code> exists, you can now safely use <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> with <code>name</code> set to <code>group1/group2/softlink_to_group3/datasetD</code> to verify that the target link, <code>datasetD</code>, exists.</li>
</ol>
<p>If the link to be verified is specified with an absolute path, the same approach should be used, but starting with the first link in the file's root group. For instance, if <code>datasetD</code> were in <code>/group1/group2/softlink_to_group3</code>, the first call to <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> would have name set to <code>/group1</code>.</p>
<p>Note that this is an outline and does not include all the necessary details. Depending on circumstances, for example, you may need to verify that an intermediate link points to a group and that a soft link points to an existing target.</p>
<dl class="section note"><dt>Note</dt><dd>The behavior of <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> was changed in the 1.10 release in the case where the root group, <code>"/"</code>, is the name of the link. This change is described below: <ol>
<li>
Let <code>file</code> denote a valid HDF5 file identifier, and let <code>lapl</code> denote a valid link access property list identifier. A call to <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> with arguments <code>file</code>, <code>"/"</code>, and <code>lapl</code> returns a positive value; in other words, <code>H5Lexists(file, "/", lapl)</code> returns a positive value. In the HDF5 1.8 release, this function returns 0. </li>
<li>
Let <code>root</code> denote a valid HDF5 group identifier that refers to the root group of an HDF5 file, and let <code>lapl</code> denote a valid link access property list identifier. A call to <a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> with arguments c root, <code>"/"</code>, and <code>lapl</code> returns a positive value; in other words, <code>H5Lexists(root, "/", lapl)</code> returns a positive value. In the HDF5 1.8 release, this function returns 0. </li>
</ol>
Note that the function accepts link names and path names. This is potentially misleading to callers, and we plan to separate the functionality for link names and path names in a future release.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd><a class="el" href="#ga171be6e41dc1a464edc402df0ebdf801" title="Determines whether a link with the specified name exists in a group.">H5Lexists()</a> checks the existence of only the final element in a relative or absolute path; it does not check any other path elements. The function will therefore fail when both of the following conditions exist:<ul>
<li><code>name</code> is not local to the group specified by <code>loc_id</code> or, if <code>loc_id</code> is something other than a group identifier, <code>name</code> is not local to the root group.</li>
<li>Any element of the relative path or absolute path in name, except the target link, does not exist.</li>
</ul>
</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.10.0 Function behavior changed in this release. (See the note.) </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gacc2ad7f2b402c4bf9bb122d7f43b98dc" name="gacc2ad7f2b402c4bf9bb122d7f43b98dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacc2ad7f2b402c4bf9bb122d7f43b98dc">◆ </a></span>H5Lget_info1()</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> H5Lget_info1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_l__info1__t.html">H5L_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>linfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about a link. </p>
<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>Link name </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">linfo</td><td>Buffer in which link information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000050">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2()</a> or the macro <a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a>.</dd></dl>
<p><a class="el" href="#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1()</a> returns information about the specified link through the <code>linfo</code> argument.</p>
<p>The location identifier, <code>loc_id</code>, specifies the location of the link. A link name, <code>name</code>, interpreted relative to <code>loc_id</code>, specifies the link being queried.</p>
<p><code>lapl_id</code> is the link access property list associated with the link <code>name</code>. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p><a class="el" href="#gacc2ad7f2b402c4bf9bb122d7f43b98dc" title="Returns information about a link.">H5Lget_info1()</a> returns information about name in the data structure <a class="el" href="struct_h5_l__info1__t.html">H5L_info1_t</a>, which is described below and defined in <a class="el" href="_h5_lpublic_8h.html">H5Lpublic.h</a>. This structure is returned in the buffer <code>linfo</code>. </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"> <a class="code hl_enumeration" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> type; </div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> corder_valid; </div>
<div class="line"> int64_t corder; </div>
<div class="line"> <a class="code hl_enumeration" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71a">H5T_cset_t</a> cset; </div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#a8c86e866f40d7167cf9a1934c72b856f">haddr_t</a> address; </div>
<div class="line"> <span class="keywordtype">size_t</span> val_size; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_l__info1__t.html">H5L_info1_t</a>;</div>
</div><!-- fragment --><p> In the above struct, type specifies the link class. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48ab90f13082490fcd293a228b2785489e3">H5L_TYPE_HARD</a></td><td>Hard link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a38eb885df3f43f179b973f576fe996ed">H5L_TYPE_SOFT</a></td><td>Soft link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a1b8b636539eab03587c22735ec84ea06">H5L_TYPE_EXTERNAL</a></td><td>External link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a4a582d434de3ee2c583384c4d3a3273d">H5L_TYPE_ERROR</a></td><td>Error</td></tr>
</table>
<p>There will be additional valid values if user-defined links have been registered.</p>
<p><code>corder</code> specifies the link's creation order position while <code>corder_valid</code> indicates whether the value in <code>corder</code> is valid.</p>
<p>If <code>corder_valid</code> is <code>true</code>, the value in <code>corder</code> is known to be valid; if <code>corder_valid</code> is <code>false</code>, the value in <code>corder</code> is presumed to be invalid;</p>
<p><code>corder</code> starts at zero (0) and is incremented by one (1) as new links are created. But higher-numbered entries are not adjusted when a lower-numbered link is deleted; the deleted link's creation order position is simply left vacant. In such situations, the value of <code>corder</code> for the last link created will be larger than the number of links remaining in the group.</p>
<p><code>cset</code> specifies the character set in which the link name is encoded. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa27383e03d1cad9b4c32d8611a145d663">H5T_CSET_ASCII</a></td><td>US ASCII</td></tr>
<tr>
<td><a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a></td><td>UTF-8 Unicode encoding</td></tr>
</table>
<p>This value is set with <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a>.</p>
<p><code>address</code> and <code>val_size</code> are returned for hard and symbolic links, respectively. Symbolic links include soft and external links and some user-defined links.</p>
<p>If the link is a hard link, <code>address</code> specifies the file address that the link points to.</p>
<p>If the link is a symbolic link, <code>val_size</code> will be the length of the link value, e.g., the length of the HDF5 path name with a null terminator.</p>
<dl class="section version"><dt>Version</dt><dd>1.12.0 Function was deprecated. </dd>
<dd>
1.8.2 Fortran subroutine added in this release. </dd>
<dd>
1.8.4 Fortran subroutine syntax changed in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga65e63c6e880fd0183c40486d6748e400" name="ga65e63c6e880fd0183c40486d6748e400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga65e63c6e880fd0183c40486d6748e400">◆ </a></span>H5Lget_info2()</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> H5Lget_info2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_l__info2__t.html">H5L_info2_t</a> *</td> <td class="paramname"><span class="paramname"><em>linfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns information about a link. </p>
<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>Link name </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">linfo</td><td>Buffer in which link information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2()</a> returns information about the specified link through the <code>linfo</code> argument.</p>
<p>The location identifier, <code>loc_id</code>, specifies the location of the link. A link name, <code>name</code>, interpreted relative to <code>loc_id</code>, specifies the link being queried.</p>
<p><code>lapl_id</code> is the link access property list associated with the link name. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p><a class="el" href="#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2()</a> returns information about name in the data structure <a class="el" href="struct_h5_l__info2__t.html" title="Information struct for links.">H5L_info2_t</a>, which is described below and defined in <a class="el" href="_h5_lpublic_8h.html">H5Lpublic.h</a>. This structure is returned in the buffer <code>linfo</code>. </p><div class="fragment"><div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"> <a class="code hl_enumeration" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48">H5L_type_t</a> type; </div>
<div class="line"> <a class="code hl_typedef" href="_h5public_8h.html#ad470b00eccd2115c707c02de5fa1120d">hbool_t</a> corder_valid; </div>
<div class="line"> int64_t corder; </div>
<div class="line"> <a class="code hl_enumeration" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71a">H5T_cset_t</a> cset; </div>
<div class="line"> <span class="keyword">union </span>{</div>
<div class="line"> <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> token; </div>
<div class="line"> <span class="keywordtype">size_t</span> val_size; </div>
<div class="line"> } u;</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_l__info2__t.html">H5L_info2_t</a>;</div>
</div><!-- fragment --><p> In the above struct, <code>type</code> specifies the link class. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48ab90f13082490fcd293a228b2785489e3">H5L_TYPE_HARD</a></td><td>Hard link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a38eb885df3f43f179b973f576fe996ed">H5L_TYPE_SOFT</a></td><td>Soft link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a1b8b636539eab03587c22735ec84ea06">H5L_TYPE_EXTERNAL</a></td><td>External link</td></tr>
<tr>
<td><a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a4a582d434de3ee2c583384c4d3a3273d">H5L_TYPE_ERROR</a></td><td>Error</td></tr>
</table>
<p>There will be additional valid values if user-defined links have been registered.</p>
<p><code>corder</code> specifies the link's creation order position, while <code>corder_valid</code> indicates whether the value in corder is valid.</p>
<p>If <code>corder_valid</code> is <code>true</code>, the value in <code>corder</code> is known to be valid; if <code>corder_valid</code> is <code>false</code>, the value in <code>corder</code> is presumed to be invalid; <code>corder</code> starts at zero (0) and is incremented by one (1) as new links are created. But higher-numbered entries are not adjusted when a lower-numbered link is deleted; the deleted link's creation order position is simply left vacant. In such situations, the value of <code>corder</code> for the last link created will be larger than the number of links remaining in the group.</p>
<p><code>cset</code> specifies the character set in which the link name is encoded. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa27383e03d1cad9b4c32d8611a145d663">H5T_CSET_ASCII</a></td><td>US ASCII</td></tr>
<tr>
<td><a class="el" href="_h5_tpublic_8h.html#a03755b8370672668ddc7063add28e71aa41685667f69bf81eb7de5dd5f452e658">H5T_CSET_UTF8</a></td><td>UTF-8 Unicode encoding</td></tr>
</table>
<p>This value is set with <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding</a>.</p>
<p><code>token</code> is the location that a hard link points to, and <code>val_size</code> is the size of a soft link or user-defined link value. <a class="el" href="struct_h5_o__token__t.html">H5O_token_t</a> is used in the VOL layer. It is defined in <a class="el" href="_h5public_8h.html">H5public.h</a> as: </p><div class="fragment"><div class="line"> </div>
<div class="line"><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a> {</div>
<div class="line"> uint8_t <a class="code hl_variable" href="struct_h5_o__token__t.html#adaac031833a234d10c1ff3130f6aa4cc">__data</a>[<a class="code hl_define" href="_h5public_8h.html#ac91e46b83ee173747f9792b33755ff0e">H5O_MAX_TOKEN_SIZE</a>];</div>
<div class="line">} <a class="code hl_struct" href="struct_h5_o__token__t.html">H5O_token_t</a>;</div>
</div><!-- fragment --><p>If the link is a symbolic link, <code>val_size</code> will be the length of the link value, e.g., the length of the HDF5 path name with a null terminator.</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0 </dd></dl>
</div>
</div>
<a id="ga7ed207f47e0e0f768f0d540c73e37e2a" name="ga7ed207f47e0e0f768f0d540c73e37e2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7ed207f47e0e0f768f0d540c73e37e2a">◆ </a></span>H5Lget_info_by_idx1()</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> H5Lget_info_by_idx1 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>idx_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_l__info1__t.html">H5L_info1_t</a> *</td> <td class="paramname"><span class="paramname"><em>linfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves metadata for a link in a group, according to the order within a field or index. </p>
<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 </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">group_name</td><td>Group name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Link position for which to retrieve information </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">linfo</td><td>Buffer in which link information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000051">Deprecated</a></b></dt><dd>As of HDF5-1.12 this function has been deprecated in favor of the function <a class="el" href="#gaecfb3ef8520e9224b24a151ff8459ba9" title="Retrieves metadata for a link in a group, according to the order within a field or index.">H5Lget_info_by_idx2()</a> and the macro <a class="el" href="#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx()</a>.</dd></dl>
<p>H5get_info_by_idx1() returns the metadata for a link in a group according to a specified field or index and a specified order.</p>
<p>The link for which information is to be returned is specified by <code>idx_type</code>, <code>order</code>, and <code>n</code> as follows:</p>
<ul>
<li><code>idx_type</code> specifies the field by which the links in <code>group_name</code> are ordered. The links may be indexed on this field, in which case operations seeking specific links are likely to complete more quickly.</li>
<li><code>order</code> specifies the order in which the links are to be referenced for the purposes of this function.</li>
<li><code>n</code> specifies the position of the subject link. Note that this count is zero-based; 0 (zero) indicates that the function will return the value of the first link; if <code>n</code> is 5, the function will return the value of the sixth link; etc.</li>
</ul>
<p>For example, assume that <code>idx_type</code>, <code>order</code>, and <code>n</code> are <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a>, and 5, respectively. <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a> indicates that the links are accessed in lexicographic order by their names. <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a> specifies that the list be traversed in reverse order, or in decremented order. And 5 specifies that this call to the function will return the metadata for the 6th link (<code>n</code> + 1) from the end.</p>
<p>See <a class="el" href="group___t_r_a_v.html#ga1e7c0a8cf17699563c02e128f27042f1" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate1()</a> for a list of valid values and further discussion regarding <code>idx_type</code> and <code>order</code>.</p>
<p>If <code>loc_id</code> specifies the group in which the link resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<dl class="section version"><dt>Version</dt><dd>1.12.0 Function was renamed to H5Lget_index_by_idx1() and deprecated. </dd>
<dd>
1.8.4 Fortran subroutine syntax changed in this release. </dd>
<dd>
1.8.2 Fortran subroutine added in this release.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaecfb3ef8520e9224b24a151ff8459ba9" name="gaecfb3ef8520e9224b24a151ff8459ba9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaecfb3ef8520e9224b24a151ff8459ba9">◆ </a></span>H5Lget_info_by_idx2()</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> H5Lget_info_by_idx2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>idx_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_h5_l__info2__t.html">H5L_info2_t</a> *</td> <td class="paramname"><span class="paramname"><em>linfo</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves metadata for a link in a group, according to the order within a field or index. </p>
<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 </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">group_name</td><td>Group name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Link position for which to retrieve information </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">linfo</td><td>Buffer in which link information is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p>H5get_info_by_idx2() returns the metadata for a link in a group according to a specified field or index and a specified order. The link for which information is to be returned is specified by <code>idx_type</code>, <code>order</code>, and <code>n</code> as follows:</p>
<ul>
<li><code>idx_type</code> specifies the field by which the links in <code>group_name</code> are ordered. The links may be indexed on this field, in which case operations seeking specific links are likely to complete more quickly.</li>
<li><code>order</code> specifies the order in which the links are to be referenced for the purposes of this function.</li>
<li><code>n</code> specifies the position of the subject link. Note that this count is zero-based; 0 (zero) indicates that the function will return the value of the first link; if <code>n</code> is 5, the function will return the value of the sixth link; etc.</li>
</ul>
<p>For example, assume that <code>idx_type</code>, <code>order</code>, and <code>n</code> are <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a>, <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a>, and 5, respectively. <a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a> indicates that the links are accessed in lexicographic order by their names. <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a> specifies that the list be traversed in reverse order, or in decremented order. And 5 specifies that this call to the function will return the metadata for the 6th link (<code>n</code> + 1) from the end.</p>
<p>See <a class="el" href="group___t_r_a_v.html#gad7ca4206f06b5ada85b6ec5867ec6c73" title="Iterates over links in a group, with user callback routine, according to the order within an index.">H5Literate2()</a> for a list of valid values and further discussion regarding <code>idx_type</code> and <code>order</code>.</p>
<p>If <code>loc_id</code> specifies the group in which the link resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<dl class="section since"><dt>Since</dt><dd>1.12.0</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga65e63c6e880fd0183c40486d6748e400" title="Returns information about a link.">H5Lget_info2()</a> </dd></dl>
</div>
</div>
<a id="ga453ea40c3bb85ec8120dd17deed2bd90" name="ga453ea40c3bb85ec8120dd17deed2bd90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga453ea40c3bb85ec8120dd17deed2bd90">◆ </a></span>H5Lget_name_by_idx()</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> H5Lget_name_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>idx_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves name of the <em>n</em>-th link in a group, according to the order within a specified field or index. </p>
<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 </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">group_name</td><td>Group name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Index type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Iteration order </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Link position for which to retrieve information </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Buffer in which link name is returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Size in bytes of <code>name</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the size of the link name if successful; otherwise returns a negative value.</dd></dl>
<p>H5get_name_by_idx() retrieves the name of the <em>n</em>-th link in a group, according to the specified order, <code>order</code>, within a specified field or index, <code>idx_type</code>.</p>
<p><code>idx_type</code> specifies the index that is used. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a644e6701706be4d37660864336c7bd3e">H5_INDEX_NAME</a></td><td>Lexicographic order on name</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3a315475479b34056043b4b6583bafb280">H5_INDEX_CRT_ORDER</a></td><td>Index on creation order</td></tr>
</table>
<p><code>order</code> specifies the order in which objects are inspected along the index specified in <code>idx_type</code>. Valid values include the following: </p><table class="doxtable">
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a></td><td>Increasing order</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a></td><td>Decreasing order</td></tr>
<tr>
<td><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a></td><td>Fastest available order</td></tr>
</table>
<p>If <code>loc_id</code> specifies the group in which the link resides, <code>group_name</code> can be a dot (<code></code>.).</p>
<p>The size in bytes of name is specified in <code>size</code>. If <code>size</code> is unknown, it can be determined via an initial <a class="el" href="#ga453ea40c3bb85ec8120dd17deed2bd90" title="Retrieves name of the n-th link in a group, according to the order within a specified field or index.">H5Lget_name_by_idx()</a> call with name set to NULL; the function's return value will be the size of the name.</p>
<dl class="section note"><dt>Note</dt><dd>Please note that in order for the specified index to correspond to the creation order index, <code>order</code> must be set to <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a80c3e083c0a77063b1a66553decfcb08">H5_ITER_INC</a> or <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a2f123d7a4d68054e8aa2d0f1d0a3fcd2">H5_ITER_DEC</a> when calling <a class="el" href="#ga453ea40c3bb85ec8120dd17deed2bd90" title="Retrieves name of the n-th link in a group, according to the order within a specified field or index.">H5Lget_name_by_idx()</a>. </dd>
<dd>
The index <code>n</code> passed to <a class="el" href="#ga453ea40c3bb85ec8120dd17deed2bd90" title="Retrieves name of the n-th link in a group, according to the order within a specified field or index.">H5Lget_name_by_idx()</a> is the index of the link within the link table, sorted according to <code>order</code> and <code>idx_type</code>. If order is <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a>, then the link table is not sorted, and it does not matter what <code>idx_type</code> is. Specifying <a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9a15eebaf7d85d5e37e918858634e29d01">H5_ITER_NATIVE</a> does not guarantee any particular order, only that it remains consistent.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga8eaacc372afc314e44521dfc1f66dcf4" name="ga8eaacc372afc314e44521dfc1f66dcf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8eaacc372afc314e44521dfc1f66dcf4">◆ </a></span>H5Lget_val()</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> H5Lget_val </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buf</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the value of a link. </p>
<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>Link name </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>The buffer to hold the link value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Maximum number of bytes of link value to be returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a> returns the value of link <code>name</code>. For symbolic links, this is the path to which the link points, including the null terminator. For external and user-defined links, it is the link buffer.</p>
<p><code>size</code> is the size of <code>buf</code> and should be the size of the link value being returned. This size value can be determined through a call to <a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a>; it is returned in the <code>val_size</code> field of the <a class="el" href="_h5version_8h.html#af542682cfe46de7b0759e52a1608d1e4">H5L_info_t</a> <code>struct</code>.</p>
<p>If <code>size</code> is smaller than the size of the returned value, then the string stored in <code>buf</code> will be truncated to <code>size</code> bytes. For soft links, this means that the value will not be null terminated.</p>
<p>In the case of external links, the target file and object names are extracted from <code>buf</code> by calling <a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a>.</p>
<p>The link class of link <code>name</code> can be determined with a call to <a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a>.</p>
<p><code>lapl_id</code> specifies the link access property list associated with the link <code>name</code>. In the general case, when default link access properties are acceptable, this can be passed in as <a class="el" href="_h5_ppublic_8h.html#afa85e97bfbf9bf1c58e39263846c568f">H5P_DEFAULT</a>. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>).</p>
<p>This function should be used only after <a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a> has been called to verify that <code>name</code> is a symbolic link. This can be determined from the <code>link_type</code> field of the <a class="el" href="_h5version_8h.html#af542682cfe46de7b0759e52a1608d1e4">H5L_info_t</a> <code>struct</code>.</p>
<dl class="section note"><dt>Note</dt><dd>This function will fail if called on a hard link.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#gaf7be56de947e09a8d084e9d13a90bf3c" title="Retrieves value of the n-th link in a group, according to the order within an index.">H5Lget_val_by_idx()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="gaf7be56de947e09a8d084e9d13a90bf3c" name="gaf7be56de947e09a8d084e9d13a90bf3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf7be56de947e09a8d084e9d13a90bf3c">◆ </a></span>H5Lget_val_by_idx()</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> H5Lget_val_by_idx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>loc_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>group_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a8203c78e10ab2d89d8bce688a31afad3">H5_index_t</a></td> <td class="paramname"><span class="paramname"><em>idx_type</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a6a6ddd1504d1ed61939d46d91d9441b9">H5_iter_order_t</a></td> <td class="paramname"><span class="paramname"><em>order</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5public_8h.html#a7f81cce70fb546af88da24d9285d3c1c">hsize_t</a></td> <td class="paramname"><span class="paramname"><em>n</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>buf</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves value of the <em>n</em>-th link in a group, according to the order within an index. </p>
<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">group_name</td><td>Group name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">idx_type</td><td>Type of index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">order</td><td>Order within field or index </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>Link position for which to retrieve information </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">buf</td><td>The buffer to hold the link value </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Maximum number of bytes of link value to be returned </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gaf7be56de947e09a8d084e9d13a90bf3c" title="Retrieves value of the n-th link in a group, according to the order within an index.">H5Lget_val_by_idx()</a> retrieves the value of the <em>n</em>-th link in a group, according to the specified order, <code>order</code>, within an index, <code>index</code>.</p>
<p>For soft links, the value is an HDF5 path name.</p>
<p>For external links, this is a compound value containing file and path name information; to use this external link information, it must first be decoded with <a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a></p>
<p>For user-defined links, this value will be described in the definition of the user-defined link type.</p>
<p><code>loc_id</code> specifies the location identifier of the group specified by <code>group_name</code>.</p>
<p><code>group_name</code> specifies the group in which the link exists. If <code>loc_id</code> already specifies the group in which the link exists, <code>group_name</code> must be a dot (<code></code>.).</p>
<p>The size in bytes of link_val is specified in <code>size</code>. The size value can be determined through a call to <a class="el" href="#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx()</a>; it is returned in the <code>val_size</code> field of the <a class="el" href="_h5version_8h.html#af542682cfe46de7b0759e52a1608d1e4">H5L_info_t</a> <code>struct</code>. If size is smaller than the size of the returned value, then the string stored in link_val will be truncated to size bytes. For soft links, this means that the value will not be null terminated.</p>
<p>If the type of the link is unknown or uncertain, <a class="el" href="#gaf7be56de947e09a8d084e9d13a90bf3c" title="Retrieves value of the n-th link in a group, according to the order within an index.">H5Lget_val_by_idx()</a> should be called only after the type has been determined via a call to <a class="el" href="#ga4db00b8b944eae68233438165c784b67">H5Lget_info_by_idx()</a>.</p>
<dl class="section note"><dt>Note</dt><dd>This function will fail if called on a hard link.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
<a id="ga0bbc7f9bf25c8aca9dd8433a325c8acb" name="ga0bbc7f9bf25c8aca9dd8433a325c8acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb">◆ </a></span>H5Lmove()</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> H5Lmove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>src_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>src_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>dst_loc</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>dst_name</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lcpl_id</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a></td> <td class="paramname"><span class="paramname"><em>lapl_id</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves a link within an HDF5 file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">src_loc</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">src_name</td><td>Original link name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_loc</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">dst_name</td><td>New link name </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lcpl_id</td><td>Link creation property list identifier </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">lapl_id</td><td>Link access property list identifier</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a> moves a link within an HDF5 file. The original link, <code>src_name</code>, is removed from <code>src_loc</code> and the new link, <code>dst_name</code>, is inserted at dst_loc. This change is accomplished as an atomic operation.</p>
<p><code>src_loc</code> and <code>src_name</code> identify the original link. <code>src_loc</code> is the original location identifier; <code>src_name</code> is the path to the link and is interpreted relative to <code>src_loc</code>.</p>
<p><code>dst_loc</code> and <code>dst_name</code> identify the new link. <code>dst_loc</code> is either a file or group identifier; <code>dst_name</code> is the path to the link and is interpreted relative to <code>dst_loc</code>.</p>
<p><code>lcpl_id</code> and <code>lapl_id</code> are the link creation and link access property lists, respectively, associated with the new link, <code>dst_name</code>.</p>
<p>Through these property lists, several properties are available to govern the behavior of <a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a>. The property controlling creation of missing intermediate groups is set in the link creation property list with <a class="el" href="group___l_c_p_l.html#ga66c4c5d3f34e5cf65d00e47a5387383c" title="Specifies in property list whether to create missing intermediate groups.">H5Pset_create_intermediate_group()</a>; <a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a> ignores any other properties in the link creation property list. Properties controlling character encoding, link traversals, and external link prefixes are set in the link access property list with <a class="el" href="group___a_c_p_l.html#gad4fa8e2d17236786f770cf17eef908cc" title="Sets the character encoding used to encode link and attribute names.">H5Pset_char_encoding()</a>, <a class="el" href="group___l_a_p_l.html#gaa46c63c196a0cf5cd94dede039c030f4" title="Sets maximum number of soft or user-defined link traversals.">H5Pset_nlinks()</a>, and <a class="el" href="group___l_a_p_l.html#gafa5eced13ba3a00cdd65669626dc7294" title="Sets prefix to be applied to external link paths.">H5Pset_elink_prefix()</a>, respectively.</p>
<dl class="section note"><dt>Note</dt><dd>Note that <a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a> does not modify the value of the link; the new link points to the same object as the original link pointed to. Furthermore, if the object pointed to by the original link was already open with a valid object identifier, that identifier will remain valid after the call to <a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a>.</dd></dl>
<dl class="section attention"><dt>Attention</dt><dd>Exercise care in moving links as it is possible to render data in a file inaccessible with <a class="el" href="#ga0bbc7f9bf25c8aca9dd8433a325c8acb" title="Moves a link within an HDF5 file.">H5Lmove()</a>. If the link being moved is on the only path leading to an HDF5 object, that object may become permanently inaccessible in the file.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.8.0</dd></dl>
<hr />
</div>
</div>
<a id="gade0c3b274c185d148f000172fbdc3220" name="gade0c3b274c185d148f000172fbdc3220"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade0c3b274c185d148f000172fbdc3220">◆ </a></span>H5Lunpack_elink_val()</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> H5Lunpack_elink_val </td>
<td>(</td>
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>ext_linkval</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>link_size</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned *</td> <td class="paramname"><span class="paramname"><em>flags</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **</td> <td class="paramname"><span class="paramname"><em>filename</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char **</td> <td class="paramname"><span class="paramname"><em>obj_path</em></span> )</td>
</tr>
</table>
</div><div class="memdoc">
<p>Decodes external link information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ext_linkval</td><td>Buffer containing external link information </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">link_size</td><td>Size, in bytes, of the <code>ext_linkval</code> buffer </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>External link flags, packed as a bitmap (<em>Reserved as a bitmap for flags; no flags are currently defined, so the only valid value * is 0.</em>) </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">filename</td><td>Returned filename</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">obj_path</td><td>Returned object path, relative to <code>filename</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a non-negative value if successful; otherwise, returns a negative value.</dd></dl>
<p><a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a> decodes the external link information returned by <a class="el" href="#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a> in the <code>ext_linkval</code> buffer.</p>
<p><code>ext_linkval</code> should be the buffer set by <a class="el" href="#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a> and will consist of two NULL-terminated strings, the filename and object path, one after the other.</p>
<p>Given this buffer, <a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a> creates pointers to the filename and object path within the buffer and returns them in <code>filename</code> and <code>obj_path</code>, unless they are passed in as NULL.</p>
<p><a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a> requires that <code>ext_linkval</code> contain a concatenated pair of null-terminated strings, so use of this function on a string that is not an external link <code>udata</code> buffer may result in a segmentation fault. This failure can be avoided by adhering to the following procedure: </p><ol>
<li>
Call <a class="el" href="#ga97279697f3010a6ad31dd7f4341eb698">H5Lget_info()</a> to get the link type and the size of the link value.</li>
<li>
</li>
<li>
Verify that the link is an external link, i.e., that its link type is <a class="el" href="_h5_lpublic_8h.html#a1e3c5d37c60e7a59b0179e26a4094a48a1b8b636539eab03587c22735ec84ea06">H5L_TYPE_EXTERNAL</a>. </li>
<li>
Call <a class="el" href="#ga8eaacc372afc314e44521dfc1f66dcf4" title="Returns the value of a link.">H5Lget_val()</a> to get the link value. </li>
<li>
Call <a class="el" href="#gade0c3b274c185d148f000172fbdc3220" title="Decodes external link information.">H5Lunpack_elink_val()</a> to unpack that value. </li>
</ol>
<dl class="section since"><dt>Since</dt><dd>1.8.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>
|
