H5L_COPY copies the link specified by
src_name from the file or group specified by
src_loc_id to the file or group specified by
dest_loc_id. The new copy of the link is created with the name
dest_loc_id is a file identifier,
dest_name will be interpreted relative to that file’s root group.
The new link is created with the creation and access property lists specified by
lapl_id. The interpretation of
lcpl_id is limited in the manner described in the next paragraph.
H5L_COPY retains the creation time and the target of the original link. However, since the link may be renamed, the character encoding is that specified in
lcpl_id rather than that of the original link. Other link creation properties are ignored.
If the link is a soft link, also known as a symbolic link, its target is interpreted relative to the location of the copy.
Several properties are available to govern the behavior of H5L_COPY. These properties are set in the link creation and access property lists,
lapl_id, respectively. The property controlling creation of missing intermediate groups is set in the link creation property list with H5P_SET_CREATE_INTERMEDIATE_GROUP; 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 H5P_SET_CHAR_ENCODING, H5P_SET_NLINKS, and H5P_SET_ELINK_PREFIX.
H5L_COPY does not affect the object that the link points to.
H5L_COPY 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 H5O_COPY.