Page tree

The license could not be verified: License Certificate has expired!

 

JAVA

FORTRAN

C++

C

 

Link

H5A_RENAME_BY_NAME

Renames an attribute

Procedure:

H5A_RENAME_BY_NAME(loc_id, obj_name, old_attr_name, new_attr_name, lapl_id)

Signature:

herr_t H5Arename_by_name
(
    hid_t       loc_id,
    const char *obj_name,
    const char *old_attr_name,
    const char *new_attr_name,
    hid_t       lapl_id
)

SUBROUTINE h5arename_by_name_f(loc_id, obj_name, old_attr_name, new_attr_name, &
     hdferr, lapl_id)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id  ! Object identifier 
  CHARACTER(LEN=*), INTENT(IN) :: obj_name 
                                        ! Name of object, relative to location, 
                                        ! whose attribute is to be renamed
  CHARACTER(LEN=*), INTENT(IN) :: old_attr_name 
                                        ! Prior attribute name
  CHARACTER(LEN=*), INTENT(IN) :: new_attr_name 
                                        ! New attribute name
  INTEGER, INTENT(OUT) :: hdferr        ! Error code:
                                        ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id 
                                        ! Link access property list identifier
END SUBROUTINE h5arename_by_name_f

Parameters:
hid_t loc_idIN: Location or object identifier; may be a file group, dataset, or named datatype
const char * obj_nameIN: Name of object, relative to location, whose attribute is to be renamed
const char * old_attr_name    IN: Prior attribute name
const char * new_attr_nameIN: New attribute name
hid_t lapl_idIN: Link access property list identifier

Description:

H5A_RENAME_BY_NAME  changes the name of attribute that is attached to the object specified by  loc_id  and obj_name . The attribute named  old_attr_name  is renamed  new_attr_name .

The link access property list, lapl_id, may provide information regarding the properties of links required to access the object, obj_name. See “Link Access Properties” in the H5P APIs.

Returns:

Returns a non-negative value if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    C
1.8.0Function introduced in this release.

--- Last Modified: April 17, 2018 | 12:33 PM