Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5A_GET_INFO_BY_NAME

Retrieves attribute information, by attribute name

Procedure:

H5A_GET_INFO_BY_NAME ( loc_id, obj_name, attr_name, ainfo, lapl_id )

Signature:

herr_t H5Aget_info_by_name(
            hid_t loc_id, 
            const char *obj_name, 
            const char *attr_name, 
            H5A_info_t *ainfo, 
            hid_t lapl_id
    )
  

Fortran90 Interface: h5aget_info_by_name_f
    
SUBROUTINE h5aget_info_by_name_f(loc_id, obj_name, attr_name, &
     f_corder_valid, corder, cset, data_size, hdferr, lapl_id)
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: loc_id       ! Object identifier
  CHARACTER(LEN=*), INTENT(IN) :: obj_name   ! Name of object to which attribute 
                                             ! is attached
  CHARACTER(LEN=*), INTENT(IN) :: attr_name  ! Attribute name
  LOGICAL, INTENT(OUT) :: f_corder_valid     ! Indicates whether the creation 
                                             ! order data is valid for this 
                                             ! attribute 
  INTEGER, INTENT(OUT) :: corder             ! Is a positive integer containing 
                                             ! the creation order of the 
                                             ! attribute
  INTEGER, INTENT(OUT) :: cset               ! Indicates the character set used 
                                             ! for the attribute’s name
  INTEGER(HSIZE_T), INTENT(OUT) :: data_size ! Indicates the size, in the number
                                             ! of characters, of the attribute
  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
END SUBROUTINE h5aget_info_by_name_f
    

Parameters:
hid_t loc_idIN: Location identifier of object to which attribute is attached; may be a file, group, dataset, or named datatype
const char *obj_nameIN: Name of object to which attribute is attached, relative to location
const char *attr_name    IN: Attribute name
H5A_info_t *ainfoOUT: Struct containing returned attribute information
hid_t lapl_idIN: Link access property list

Description:

H5A_GET_INFO_BY_NAME retrieves information for an attribute, attr_name, that is attached to an object, specified by its location and name, loc_id and obj_name, respectively. The attribute information is returned in the ainfo struct.

If loc_id fully specifies the object to which the attribute is attached, obj_name should be '.' (a dot).

The ainfo struct is described in H5A_GET_INFO.

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 16, 2018 | 04:06 PM