H5A_READ

Reads an attribute

Procedure:

H5A_READ(attr_id, mem_type_id, buf)

Signature:

herr_t H5Aread
(
    hid_t attr_id,
    hid_t mem_type_id,
    void *buf
)

Fortran90:

  SUBROUTINE h5aread_f(attr_id, memtype_id, buf, dims, hdferr) 
    INTEGER(HID_T)  , INTENT(IN)               :: attr_id
    INTEGER(HID_T)  , INTENT(IN)               :: memtype_id
    TYPE            , INTENT(INOUT)            :: buf
    INTEGER(HSIZE_T), INTENT(IN), DIMENSION(*) :: dims
    INTEGER         , INTENT(OUT)              :: hdferr

Fortran2003:

 SUBROUTINE h5aread_f(attr_id, memtype_id, buf, hdferr) 
    INTEGER(HID_T)  , INTENT(IN)    :: attr_id
    INTEGER(HID_T)  , INTENT(IN)    :: memtype_id
    TYPE(C_PTR)     , INTENT(INOUT) :: buf
    INTEGER         , INTENT(OUT)   :: hdferr

Parameters:

hid_t `attr_id`	IN: Identifier of an attribute to read
hid_t `mem_type_id`	IN: Identifier of the attribute datatype (in memory)
void * `buf`	OUT: Buffer for data to be read

Description:

H5A_READ reads an attribute, specified with attr_id . The attribute's memory datatype is specified with mem_type_id . The entire attribute is read into buf from the file.

Datatype conversion takes place at the time of a read or write and is automatic. See the “Data Transfer: Datatype Conversion and Selection” section in the “HDF5 Datatypes” chapter of the HDF5 User’s Guide for a discussion of data conversion.

Returns:

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

Example:

History:

Release	Change
1.8.8	Fortran updated to Fortran2003.
1.4.2	The `dims` parameter was added to the Fortran API in this release.

--- Last Modified: October 23, 2020 | 02:45 PM

Page tree