H5Lcreate_soft
(
const char *target_path
,
hid_t link_loc_id
,
const char *link_name
,
hid_t lcpl_id
,
hid_t lapl_id
)
H5Lcreate_soft
creates a new soft link
to an object in an HDF5 file.
The new link may be one of many that point to that object.
target_path
specifies the path to the target object,
i.e., the object that the new soft link points to.
target_path
can be anything and is interpreted at
lookup time. This path may be absolute in the file or relative
to link_loc_id
.
link_loc_id
and link_name
specify the
location and name, respectively, of the new soft link.
link_name
is interpreted relative to
link_loc_id
lcpl_id
and lapl_id
are the
link creation and access property lists associated with the
new link.
For instance, if
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.
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.
The HDF5 library does not keep a count of soft links as it
does of hard links.
target_path
is ./foo
,
link_loc_id
specifies ./x/y/bar
,
and the name of the new link is new_link
, then
a subsequent request for ./x/y/bar/new_link
will
return same the object as would be found at ./foo
.
H5Lcreate_soft
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
H5Lcreate_external
to create an external link.
const char *
target_path
IN: Path to the target object,
which is not required to exist.
hid_t
link_loc_id
IN: The file or group identifier for the
new link.
const char *
link_name
IN: The name of the new link.
hid_t
lcpl_id
IN: Link creation property list identifier.
hid_t
lapl_id
IN: Link access property list identifier.
SUBROUTINE h5lcreate_soft_f(target_path, link_loc_id, link_name, hdferr, &
lcpl_id, lapl_id)
IMPLICIT NONE
CHARACTER(LEN=*), INTENT(IN) :: target_path
! Path to the target object,
! which is not required to exist.
INTEGER(HID_T), INTENT(IN) :: link_loc_id
! The file or group identifier for the new link.
CHARACTER(LEN=*), INTENT(IN) :: link_name
! The name of the new link.
INTEGER, INTENT(OUT) :: hdferr ! Error code:
! 0 on success and -1 on failure
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lcpl_id
! Link creation property list identifier.
INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id
! Link access property list identifier.
END SUBROUTINE h5lcreate_soft_f
Release
C
1.8.0
Function introduced in this release.