Creates a link of the specified type from current_name to new_name
Procedure:
H5G_LINK2(curr_loc_id, current_name, link_type, new_loc_id, new_name)
Signature:
herr_t H5Glink2( hid_t curr_loc_id, const char *current_name, H5G_link_t link_type, hid_t new_loc_id, const char *new_name )
SUBROUTINE h5glink2_f(cur_loc_id, cur_name, link_type, new_loc_id, new_name, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: cur_loc_id ! File or group location identifier
CHARACTER(LEN=*), INTENT(IN) :: cur_name ! Name of the existing object
! is relative to cur_loc_id
! Can be anything for the soft link
INTEGER, INTENT(IN) :: link_type ! Link type, possible values are:
! H5G_LINK_HARD_F
! H5G_LINK_SOFT_F
INTEGER(HID_T), INTENT(IN) :: new_loc_id ! New location identifier
CHARACTER(LEN=*), INTENT(IN) :: new_name ! New object name
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5glink2_f
Parameters:
hid_t curr_loc_id | IN: The file or group identifier for the original object |
const char * current_name | IN: Name of the existing object if link is a hard link. Can be anything for the soft link |
H5G_link_t link_type | IN: Link type. Possible values are H5G_LINK_HARD and H5G_LINK_SOFT |
hid_t new_loc_id | IN: The file or group identifier for the new link |
const char * new_name | IN: New name for the object |
Description:
H5G_LINK2 creates a new name for an object that has some current name, possibly one of many names it currently has.
If link_type is H5G_LINK_HARD, then current_name must specify the name of an existing object. In this case, current_name and new_name are interpreted relative to curr_loc_id and new_loc_id, respectively, which are either file or group identifiers.
If link_type is H5G_LINK_SOFT, then current_name can be anything and is interpreted at lookup time relative to the group which contains the final component of new_name. For instance, if current_name is ./foo, new_name is ./x/y/bar, and a request is made for ./x/y/bar, then the actual object looked up is ./x/y/./foo.
Returns:
Returns a non-negative value if successful; otherwise returns a negative value.
Example:
History:
| Release | Change |
|---|
| 1.8.0 | Function deprecated in this release. |
--- Last Modified: April 25, 2019 | 11:37 AM
