forked from HDFGroup/hdf5
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathH5Lff.F90
1638 lines (1450 loc) · 62.7 KB
/
H5Lff.F90
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
!> @defgroup FH5L Fortran Link (H5L) Interface
!!
!! @see H5L, C-API
!!
!! @see @ref H5L_UG, User Guide
!!
!> @ingroup FH5L
!!
!! @brief This module contains Fortran interfaces for H5L functions.
!
! COPYRIGHT
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
! Copyright by The HDF Group. *
! All rights reserved. *
! *
! This file is part of HDF5. The full HDF5 copyright notice, including *
! terms governing use, modification, and redistribution, is contained in *
! the LICENSE file, which can be found at the root of the source code *
! distribution tree, or in https://www.hdfgroup.org/licenses. *
! If you do not have access to either file, you may request a copy from *
! [email protected]. *
! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
!
! NOTES
! _____ __ __ _____ ____ _____ _______ _ _ _______
! |_ _| \/ | __ \ / __ \| __ \__ __|/\ | \ | |__ __|
! **** | | | \ / | |__) | | | | |__) | | | / \ | \| | | | ****
! **** | | | |\/| | ___/| | | | _ / | | / /\ \ | . ` | | | ****
! **** _| |_| | | | | | |__| | | \ \ | |/ ____ \| |\ | | | ****
! |_____|_| |_|_| \____/|_| \_\ |_/_/ \_\_| \_| |_|
!
! If you add a new H5L function you must add the function name to the
! Windows dll file 'hdf5_fortrandll.def.in' in the fortran/src directory.
! This is needed for Windows based operating systems.
!
MODULE H5L
USE H5GLOBAL
IMPLICIT NONE
TYPE, bind(c) :: union_t
TYPE(H5O_TOKEN_T_F) :: token !< Type for object tokens
INTEGER(size_t) :: val_size !< Size of a soft link or user-defined link value
END TYPE union_t
!
! @brief Fortran2003 Derived Type for @ref H5L_info_t
!
TYPE, bind(c) :: h5l_info_t
INTEGER(c_int) :: type !< Specifies the link class. Valid values include the following:
!< \li H5L_TYPE_HARD_F Hard link
!< \li H5L_TYPE_SOFT_F Soft link
!< \li H5L_TYPE_EXTERNAL_F External link
!< \li H5L_TYPE_ERROR_F Invalid link type id
! LOGICAL(c_bool) :: corder_valid ! bool corder_valid
INTEGER(c_int64_t) :: corder !< Creation order
INTEGER(c_int) :: cset !< Character set of link name is encoded. Valid values include the following:
!< \li H5T_CSET_ASCII US ASCII
!< \li H5T_CSET_UTF8 UTF-8 Unicode encoding
TYPE(union_t) :: u
END TYPE h5l_info_t
CONTAINS
!>
!! \ingroup FH5L
!!
!! \brief Copies a link from one location to another.
!!
!! \param src_loc_id Location identifier. The identifier may be that of a file, group, dataset, or named datatype.
!! \param src_name Name of the link to be copied.
!! \param dest_loc_id Location identifier. The identifier may be that of a file, group, dataset, or named datatype.
!! \param dest_name Name to be assigned to the new copy.
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Lcopy()
!!
SUBROUTINE h5lcopy_f(src_loc_id, src_name, dest_loc_id, dest_name, hdferr, &
lcpl_id, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: src_loc_id
CHARACTER(LEN=*), INTENT(IN) :: src_name
INTEGER(HID_T), INTENT(IN) :: dest_loc_id
CHARACTER(LEN=*), INTENT(IN) :: dest_name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: src_namelen
INTEGER(SIZE_T) :: dest_namelen
INTERFACE
INTEGER FUNCTION h5lcopy_c(src_loc_id, src_name, src_namelen, dest_loc_id, dest_name, dest_namelen, &
lcpl_id_default, lapl_id_default) BIND(C,name='h5lcopy_c')
IMPORT :: c_char
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: src_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: src_name
INTEGER(HID_T), INTENT(IN) :: dest_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: dest_name
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: src_namelen
INTEGER(SIZE_T) :: dest_namelen
END FUNCTION h5lcopy_c
END INTERFACE
src_namelen = LEN(src_name)
dest_namelen = LEN(dest_name)
lcpl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = h5lcopy_c(src_loc_id, src_name, src_namelen, dest_loc_id, dest_name, dest_namelen, &
lcpl_id_default, lapl_id_default)
END SUBROUTINE h5lcopy_f
!>
!! \ingroup FH5L
!!
!! \brief Removes a link from a group.
!!
!! \param loc_id Identifier of the file or group containing the object.
!! \param name Name of the link to delete.
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Ldelete()
!!
SUBROUTINE h5ldelete_f(loc_id, name, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTERFACE
INTEGER(C_INT) FUNCTION H5Ldelete(loc_id, name, lapl_id_default) BIND(C,name='H5Ldelete')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER(HID_T), VALUE :: lapl_id_default
END FUNCTION h5ldelete
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = INT(H5Ldelete(loc_id, c_name, lapl_id_default))
END SUBROUTINE h5ldelete_f
!>
!! \ingroup FH5L
!!
!! \brief Asynchronously removes a link from a group.
!!
!! \param loc_id Identifier of the file or group containing the object.
!! \param name Name of the link to delete.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Ldelete_async()
!!
SUBROUTINE h5ldelete_async_f(loc_id, name, es_id, hdferr, lapl_id, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , OPTIONAL, INTENT(IN) :: line
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Ldelete_async(file, func, line, loc_id, name, lapl_id_default, es_id) &
BIND(C,name='H5Ldelete_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER(HID_T), VALUE :: lapl_id_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Ldelete_async
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Ldelete_async(file_default, func_default, line_default, &
loc_id, c_name, lapl_id_default, es_id))
END SUBROUTINE h5ldelete_async_f
!>
!! \ingroup FH5L
!!
!! \brief Creates a soft link to an object.
!!
!! \param target_path Path to the target object, which is not required to exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Lcreate_soft()
!!
SUBROUTINE h5lcreate_soft_f(target_path, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: target_path
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(target_path) +1,KIND=C_CHAR) :: c_target_path
CHARACTER(LEN=LEN_TRIM(link_name)+1,KIND=C_CHAR) :: c_link_name
INTERFACE
INTEGER(C_INT) FUNCTION H5Lcreate_soft(target_path, link_loc_id, link_name, &
lcpl_id_default, lapl_id_default ) BIND(C,NAME='H5Lcreate_soft')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: target_path
INTEGER(HID_T), VALUE :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: link_name
INTEGER(HID_T), VALUE :: lcpl_id_default
INTEGER(HID_T), VALUE :: lapl_id_default
END FUNCTION H5Lcreate_soft
END INTERFACE
c_target_path = TRIM(target_path)//C_NULL_CHAR
c_link_name = TRIM(link_name)//C_NULL_CHAR
lcpl_id_default = H5P_DEFAULT_F
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = INT(H5Lcreate_soft(c_target_path, link_loc_id, c_link_name, &
lcpl_id_default, lapl_id_default))
END SUBROUTINE h5lcreate_soft_f
!>
!! \ingroup FH5L
!!
!! \brief Asynchronously creates a soft link to an object.
!!
!! \param target_path Path to the target object, which is not required to exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Lcreate_soft_async()
!!
SUBROUTINE h5lcreate_soft_async_f(target_path, link_loc_id, link_name, es_id, hdferr,&
lcpl_id, lapl_id, file, func, line)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: target_path
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(target_path) +1,KIND=C_CHAR) :: c_target_path
CHARACTER(LEN=LEN_TRIM(link_name)+1,KIND=C_CHAR) :: c_link_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Lcreate_soft_async(file, func, line, target_path, link_loc_id, link_name, &
lcpl_id_default, lapl_id_default, es_id) BIND(C,NAME='H5Lcreate_soft_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: target_path
INTEGER(HID_T), VALUE :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: link_name
INTEGER(HID_T), VALUE :: lcpl_id_default
INTEGER(HID_T), VALUE :: lapl_id_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Lcreate_soft_async
END INTERFACE
c_target_path = TRIM(target_path)//C_NULL_CHAR
c_link_name = TRIM(link_name)//C_NULL_CHAR
lcpl_id_default = H5P_DEFAULT_F
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Lcreate_soft_async(file_default, func_default, line_default,&
c_target_path, link_loc_id, c_link_name, lcpl_id_default, lapl_id_default, es_id))
END SUBROUTINE h5lcreate_soft_async_f
!>
!! \ingroup FH5L
!!
!! \brief Creates a hard link to an object.
!!
!! \param obj_loc_id The file or group identifier for the target object.
!! \param obj_name Name of the target object, which must already exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Lcreate_hard()
!!
SUBROUTINE h5lcreate_hard_f(obj_loc_id, obj_name, link_loc_id, link_name, hdferr, &
lcpl_id, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_loc_id
CHARACTER(LEN=*), INTENT(IN) :: obj_name
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(obj_name) +1,KIND=C_CHAR) :: c_obj_name
CHARACTER(LEN=LEN_TRIM(link_name)+1,KIND=C_CHAR) :: c_link_name
INTERFACE
INTEGER(C_INT) FUNCTION H5Lcreate_hard(obj_loc_id, obj_name, &
link_loc_id, link_name, lcpl_id_default, lapl_id_default) BIND(C,NAME='H5Lcreate_hard')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: obj_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: obj_name
INTEGER(HID_T), VALUE :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: link_name
INTEGER(HID_T), VALUE :: lcpl_id_default
INTEGER(HID_T), VALUE :: lapl_id_default
END FUNCTION H5Lcreate_hard
END INTERFACE
c_obj_name = TRIM(obj_name)//C_NULL_CHAR
c_link_name = TRIM(link_name)//C_NULL_CHAR
lcpl_id_default = H5P_DEFAULT_F
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = INT(H5Lcreate_hard(obj_loc_id, c_obj_name, &
link_loc_id, c_link_name, lcpl_id_default, lapl_id_default))
END SUBROUTINE h5lcreate_hard_f
!>
!! \ingroup FH5L
!!
!! \brief Asynchronously creates a hard link to an object.
!!
!! \param obj_loc_id The file or group identifier for the target object.
!! \param obj_name Name of the target object, which must already exist.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Lcreate_hard_async()
!!
SUBROUTINE h5lcreate_hard_async_f(obj_loc_id, obj_name, link_loc_id, link_name, es_id, hdferr, &
lcpl_id, lapl_id, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: obj_loc_id
CHARACTER(LEN=*), INTENT(IN) :: obj_name
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(obj_name) +1,KIND=C_CHAR) :: c_obj_name
CHARACTER(LEN=LEN_TRIM(link_name)+1,KIND=C_CHAR) :: c_link_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Lcreate_hard_async(file, func, line, obj_loc_id, obj_name, &
link_loc_id, link_name, lcpl_id_default, lapl_id_default, es_id) BIND(C,NAME='H5Lcreate_hard_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: obj_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: obj_name
INTEGER(HID_T), VALUE :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: link_name
INTEGER(HID_T), VALUE :: lcpl_id_default
INTEGER(HID_T), VALUE :: lapl_id_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Lcreate_hard_async
END INTERFACE
c_obj_name = TRIM(obj_name)//C_NULL_CHAR
c_link_name = TRIM(link_name)//C_NULL_CHAR
lcpl_id_default = H5P_DEFAULT_F
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
IF (PRESENT(file)) file_default = file
IF (PRESENT(func)) func_default = func
IF (PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Lcreate_hard_async(file_default, func_default, line_default, obj_loc_id, c_obj_name, &
link_loc_id, c_link_name, lcpl_id_default, lapl_id_default, es_id))
END SUBROUTINE h5lcreate_hard_async_f
!>
!! \ingroup FH5L
!!
!! \brief Creates a soft link to an object in a different file.
!!
!! \param file_name Name of the file containing the target object. Neither the file nor the target object is
!! required to exist. May be the file the link is being created in.
!! \param obj_name Path within the target file to the target object.
!! \param link_loc_id The file or group identifier for the new link.
!! \param link_name The name of the new link.
!! \param hdferr \fortran_error
!! \param lcpl_id Link creation property list identifier.
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Lcreate_external()
!!
SUBROUTINE h5lcreate_external_f(file_name, obj_name, link_loc_id, link_name, hdferr, lcpl_id, lapl_id)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: file_name
CHARACTER(LEN=*), INTENT(IN) :: obj_name
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lcpl_id
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: file_namelen
INTEGER(SIZE_T) :: obj_namelen
INTEGER(SIZE_T) :: link_namelen
INTERFACE
INTEGER FUNCTION h5lcreate_external_c(file_name, file_namelen, obj_name, obj_namelen, &
link_loc_id, link_name, link_namelen, lcpl_id_default, lapl_id_default) BIND(C,NAME='h5lcreate_external_c')
IMPORT :: c_char
IMPORT :: HID_T, SIZE_T
IMPLICIT NONE
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: file_name
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: obj_name
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: link_name
INTEGER(SIZE_T) :: file_namelen
INTEGER(SIZE_T) :: obj_namelen
INTEGER(SIZE_T) :: link_namelen
INTEGER(HID_T) :: lcpl_id_default
INTEGER(HID_T) :: lapl_id_default
END FUNCTION h5lcreate_external_c
END INTERFACE
file_namelen = LEN(file_name)
obj_namelen = LEN(obj_name)
link_namelen = LEN(link_name)
lcpl_id_default = H5P_DEFAULT_F
IF(PRESENT(lcpl_id)) lcpl_id_default = lcpl_id
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = h5lcreate_external_c(file_name, file_namelen, obj_name, obj_namelen, &
link_loc_id, link_name, link_namelen, lcpl_id_default, lapl_id_default)
END SUBROUTINE h5lcreate_external_f
!>
!! \ingroup FH5L
!!
!! \brief Removes the nth link in a group.
!!
!! \param loc_id File or group identifier specifying location of subject group.
!! \param group_name Name of subject group.
!! \param index_field Type of index; Possible values are:
!! \li H5_INDEX_UNKNOWN_F = -1 - Unknown index type
!! \li H5_INDEX_NAME_F - Index on names
!! \li H5_INDEX_CRT_ORDER_F - Index on creation order
!! \li H5_INDEX_N_F - Number of indices defined
!! \param order Order within field or index; Possible values are:
!! \li H5_ITER_UNKNOWN_F - Unknown order
!! \li H5_ITER_INC_F - Increasing order
!! \li H5_ITER_DEC_F - Decreasing order
!! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest
!! \li H5_ITER_N_F - Number of iteration orders
!! \param n Link for which to retrieve information.
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!!
!! See C API: @ref H5Ldelete_by_idx()
!!
SUBROUTINE h5ldelete_by_idx_f(loc_id, group_name, index_field, order, n, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: group_name
INTEGER, INTENT(IN) :: index_field
INTEGER, INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(IN) :: n
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(group_name)+1,KIND=C_CHAR) :: c_group_name
INTERFACE
INTEGER(C_INT) FUNCTION H5Ldelete_by_idx(loc_id, group_name, index_field, order, n, lapl_id_default) &
BIND(C,NAME='H5Ldelete_by_idx')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T, HSIZE_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: group_name
INTEGER(C_INT), VALUE :: index_field
INTEGER(C_INT), VALUE :: order
INTEGER(HSIZE_T), VALUE :: n
INTEGER(HID_T), VALUE :: lapl_id_default
END FUNCTION H5Ldelete_by_idx
END INTERFACE
c_group_name = TRIM(group_name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = INT(H5Ldelete_by_idx(loc_id, c_group_name, INT(index_field,C_INT), INT(order, C_INT), n, lapl_id_default))
END SUBROUTINE h5ldelete_by_idx_f
!>
!! \ingroup FH5L
!!
!! \brief Asynchronously removes the nth link in a group.
!!
!! \param loc_id File or group identifier specifying location of subject group.
!! \param group_name Name of subject group.
!! \param index_field Type of index; Possible values are:
!! \li H5_INDEX_UNKNOWN_F = -1 - Unknown index type
!! \li H5_INDEX_NAME_F - Index on names
!! \li H5_INDEX_CRT_ORDER_F - Index on creation order
!! \li H5_INDEX_N_F - Number of indices defined
!! \param order Order within field or index; Possible values are:
!! \li H5_ITER_UNKNOWN_F - Unknown order
!! \li H5_ITER_INC_F - Increasing order
!! \li H5_ITER_DEC_F - Decreasing order
!! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest
!! \li H5_ITER_N_F - Number of iteration orders
!! \param n Link for which to retrieve information.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Ldelete_by_idx_async()
!!
SUBROUTINE h5ldelete_by_idx_async_f(loc_id, group_name, index_field, order, n, es_id, hdferr, &
lapl_id, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: group_name
INTEGER, INTENT(IN) :: index_field
INTEGER, INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(IN) :: n
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(group_name)+1,KIND=C_CHAR) :: c_group_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Ldelete_by_idx_async(file, func, line, loc_id, group_name, index_field, order, n, &
lapl_id_default, es_id) BIND(C,NAME='H5Ldelete_by_idx_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T, HSIZE_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: group_name
INTEGER(C_INT), VALUE :: index_field
INTEGER(C_INT), VALUE :: order
INTEGER(HSIZE_T), VALUE :: n
INTEGER(HID_T), VALUE :: lapl_id_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Ldelete_by_idx_async
END INTERFACE
c_group_name = TRIM(group_name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Ldelete_by_idx_async(file_default, func_default, line_default, &
loc_id, c_group_name, INT(index_field,C_INT), INT(order, C_INT), n, lapl_id_default, es_id))
END SUBROUTINE h5ldelete_by_idx_async_f
!>
!! \ingroup FH5L
!!
!! \brief Check if a link with a particular name exists in a group.
!!
!! \param loc_id Identifier of the file or group to query.
!! \param name Link name to check.
!! \param link_exists Link exists status (.TRUE.,.FALSE.).
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!!
!! See C API: @ref H5Lexists()
!!
SUBROUTINE h5lexists_f(loc_id, name, link_exists, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
LOGICAL, INTENT(OUT) :: link_exists
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(C_INT) :: link_exists_c
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
INTERFACE
INTEGER(C_INT) FUNCTION H5Lexists(loc_id, name, lapl_id_default) BIND(C,NAME='H5Lexists')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
INTEGER(HID_T), VALUE :: lapl_id_default
END FUNCTION H5Lexists
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
link_exists_c = H5Lexists(loc_id, c_name, lapl_id_default)
link_exists = .FALSE.
IF(link_exists_c.GT.0_C_INT) link_exists = .TRUE.
hdferr = 0
IF(link_exists_c.LT.0_C_INT) hdferr = -1
hdferr = 0
IF(link_exists_c.LT.0) hdferr = -1
END SUBROUTINE h5lexists_f
!>
!! \ingroup FH5L
!!
!! \brief Asynchronously checks if a link with a particular name exists in a group.
!!
!! \param loc_id Identifier of the file or group to query.
!! \param name Link name to check.
!! \param link_exists Pointer to link exists status. It should be declared INTEGER(C_INT) and initialized
!! to zero (false) for portability. It will return one when true. LOGICAL(C_BOOL) is also
!! acceptable but may encounter atypical anomalies. It should be initialized to false when used.
!! \param es_id \fortran_es_id
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list identifier.
!! \param file \fortran_file
!! \param func \fortran_func
!! \param line \fortran_line
!!
!! See C API: @ref H5Lexists_async()
!!
SUBROUTINE h5lexists_async_f(loc_id, name, link_exists, es_id, hdferr, lapl_id, file, func, line)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: name
TYPE(C_PTR) , INTENT(IN) :: link_exists
INTEGER(HID_T), INTENT(IN) :: es_id
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: file
TYPE(C_PTR), OPTIONAL, INTENT(IN) :: func
INTEGER , INTENT(IN), OPTIONAL :: line
INTEGER(HID_T) :: lapl_id_default
CHARACTER(LEN=LEN_TRIM(name)+1,KIND=C_CHAR) :: c_name
TYPE(C_PTR) :: file_default = C_NULL_PTR
TYPE(C_PTR) :: func_default = C_NULL_PTR
INTEGER(KIND=C_INT) :: line_default = 0
INTERFACE
INTEGER(C_INT) FUNCTION H5Lexists_async(file, func, line, &
loc_id, name, exists, lapl_id_default, es_id) BIND(C,NAME='H5Lexists_async')
IMPORT :: C_CHAR, C_INT, C_PTR
IMPORT :: HID_T
IMPLICIT NONE
TYPE(C_PTR), VALUE :: file
TYPE(C_PTR), VALUE :: func
INTEGER(C_INT), VALUE :: line
INTEGER(HID_T), VALUE :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*) :: name
TYPE(C_PTR) , VALUE :: exists
INTEGER(HID_T), VALUE :: lapl_id_default
INTEGER(HID_T), VALUE :: es_id
END FUNCTION H5Lexists_async
END INTERFACE
c_name = TRIM(name)//C_NULL_CHAR
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
IF(PRESENT(file)) file_default = file
IF(PRESENT(func)) func_default = func
IF(PRESENT(line)) line_default = INT(line, C_INT)
hdferr = INT(H5Lexists_async(file_default, func_default, line_default, loc_id, c_name, &
link_exists, lapl_id_default, es_id))
END SUBROUTINE h5lexists_async_f
!>
!! \ingroup FH5L
!!
!! \brief Returns information about a link.
!!
!! \param link_loc_id File or group identifier.
!! \param link_name Name of the link for which information is being sought.
!! NOTE: In C these are contained in the structure H5L_info_t
!! \param cset Indicates the character set used for link's name.
!! \param corder Specifies the link's creation order position.
!! \param f_corder_valid Indicates whether the value in corder is valid.
!! \param link_type Specifies the link class:
!! \li H5L_TYPE_HARD_F - Hard link
!! \li H5L_TYPE_SOFT_F - Soft link
!! \li H5L_TYPE_EXTERNAL_F - External link
!! \li H5L_TYPE_ERROR_ F - Error
!! \param token If the link is a hard link, token specifies the object token that the link points to.
!! \param val_size If the link is a symbolic link, val_size will be the length of the link value, e.g.,
!! the length of the name of the pointed-to object with a null terminator.
!! \param hdferr \fortran_error
!! \param lapl_id Link access property list.
!!
!! See C API: @ref H5Lget_info2()
!!
SUBROUTINE h5lget_info_f(link_loc_id, link_name, &
cset, corder, f_corder_valid, link_type, token, val_size, &
hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(LEN=*), INTENT(IN) :: link_name
INTEGER, INTENT(OUT) :: cset
INTEGER, INTENT(OUT) :: corder
LOGICAL, INTENT(OUT) :: f_corder_valid
INTEGER, INTENT(OUT) :: link_type
TYPE(H5O_TOKEN_T_F), INTENT(OUT), TARGET :: token
INTEGER(SIZE_T), INTENT(OUT) :: val_size
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER(SIZE_T) :: link_namelen
INTEGER(HID_T) :: lapl_id_default
INTEGER :: corder_valid
INTERFACE
INTEGER FUNCTION h5lget_info_c(link_loc_id, link_name, link_namelen, &
cset, corder, corder_valid, link_type, token, val_size, &
lapl_id_default) BIND(C,NAME='h5lget_info_c')
IMPORT :: c_char
IMPORT :: HID_T, SIZE_T, H5O_TOKEN_T_F
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: link_loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: link_name
INTEGER, INTENT(OUT) :: cset
INTEGER, INTENT(OUT) :: corder
INTEGER, INTENT(OUT) :: link_type
TYPE(H5O_TOKEN_T_F), INTENT(OUT) :: token
INTEGER(SIZE_T), INTENT(OUT) :: val_size
INTEGER(HID_T) :: lapl_id_default
INTEGER(SIZE_T) :: link_namelen
INTEGER :: corder_valid
END FUNCTION h5lget_info_c
END INTERFACE
link_namelen = LEN(link_name)
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = h5lget_info_c(link_loc_id, link_name, link_namelen, cset, &
corder, corder_valid, link_type, token, val_size, lapl_id_default)
f_corder_valid =.FALSE.
IF(corder_valid .EQ. 1) f_corder_valid =.TRUE.
END SUBROUTINE h5lget_info_f
!>
!! \ingroup FH5L
!!
!! \brief Retrieves metadata for a link in a group, according to the order within a field or index.
!!
!! \param loc_id File or group identifier specifying location of subject group.
!! \param group_name Name of subject group.
!! \param index_field Index or field which determines the order:
!! \li H5_INDEX_UNKNOWN_F = -1 - Unknown index type
!! \li H5_INDEX_NAME_F - Index on names
!! \li H5_INDEX_CRT_ORDER_F - Index on creation order
!! \li H5_INDEX_N_F - Number of indices defined
!! \param order Order within field or index:
!! \li H5_ITER_UNKNOWN_F - Unknown order
!! \li H5_ITER_INC_F - Increasing order
!! \li H5_ITER_DEC_F - Decreasing order
!! \li H5_ITER_NATIVE_F - No particular order, whatever is fastest
!! \li H5_ITER_N_F - Number of iteration orders
!! \param n Link for which to retrieve information.
!! NOTE: In C these are defined as a structure: H5L_info_t
!! \param link_type Specifies the link class:
!! \li H5L_TYPE_HARD_F - Hard link
!! \li H5L_TYPE_SOFT_F - Soft link
!! \li H5L_TYPE_EXTERNAL_F - External link
!! \li H5L_TYPE_ERROR _F - Error
!! \param f_corder_valid Indicates whether the creation order data is valid for this attribute.
!! \param corder Is a positive integer containing the creation order of the attribute.
!! \param cset Indicates the character set used for the attribute's name.
!! \param token If the link is a hard link, token specifies the object token that the link points to.
!! \param val_size If the link is a symbolic link, val_size will be the length of the link value, e.g.,
!! the length of the name of the pointed-to object with a null terminator.
!! \param hdferr \fortran_error
!!
!! \param lapl_id Link access property list.
!!
!! See C API: @ref H5Lget_info_by_idx2()
!!
SUBROUTINE h5lget_info_by_idx_f(loc_id, group_name, index_field, order, n, &
link_type, f_corder_valid, corder, cset, token, val_size, hdferr, lapl_id)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: group_name
INTEGER, INTENT(IN) :: index_field
INTEGER, INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(IN) :: n
INTEGER, INTENT(OUT) :: link_type
LOGICAL, INTENT(OUT) :: f_corder_valid
INTEGER, INTENT(OUT) :: corder
INTEGER, INTENT(OUT) :: cset
TYPE(H5O_TOKEN_T_F), INTENT(OUT), TARGET :: token
INTEGER(SIZE_T), INTENT(OUT) :: val_size
INTEGER, INTENT(OUT) :: hdferr
INTEGER(HID_T), INTENT(IN), OPTIONAL :: lapl_id
INTEGER :: corder_valid
INTEGER(SIZE_T) :: group_namelen
INTEGER(HID_T) :: lapl_id_default
INTERFACE
INTEGER FUNCTION h5lget_info_by_idx_c(loc_id, group_name, group_namelen, index_field, order, n, &
link_type, corder_valid, corder, cset, token, val_size, lapl_id_default) &
BIND(C,NAME='h5lget_info_by_idx_c')
IMPORT :: c_char
IMPORT :: HID_T, SIZE_T, HSIZE_T, H5O_TOKEN_T_F
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id
CHARACTER(KIND=C_CHAR), DIMENSION(*), INTENT(IN) :: group_name
INTEGER(SIZE_T) :: group_namelen
INTEGER, INTENT(IN) :: index_field
INTEGER, INTENT(IN) :: order
INTEGER(HSIZE_T), INTENT(IN) :: n
INTEGER, INTENT(OUT) :: link_type
INTEGER :: corder_valid
INTEGER, INTENT(OUT) :: corder
INTEGER, INTENT(OUT) :: cset
TYPE(H5O_TOKEN_T_F), INTENT(OUT) :: token
INTEGER(SIZE_T), INTENT(OUT) :: val_size
INTEGER(HID_T) :: lapl_id_default
END FUNCTION h5lget_info_by_idx_c
END INTERFACE
group_namelen = LEN(group_name)
lapl_id_default = H5P_DEFAULT_F
IF(PRESENT(lapl_id)) lapl_id_default = lapl_id
hdferr = h5lget_info_by_idx_c(loc_id, group_name, group_namelen, index_field, order, n, &
link_type, corder_valid, corder, cset, token, val_size, lapl_id_default)
f_corder_valid =.FALSE.
IF (corder_valid .EQ. 1) f_corder_valid =.TRUE.
END SUBROUTINE h5lget_info_by_idx_f
!>
!! \ingroup FH5L
!!