H5Aget_info
(
hid_t attr_id
,
H5A_info_t *ainfo
)
H5Aget_info
retrieves attribute information,
locating the attribute with an attribute identifier,
attr_id
, which is the identifier returned by
H5Aopen
or
H5Aopen_by_idx
.
The attribute information is returned in the ainfo
struct.
The ainfo
struct is defined as follows:
typedef struct { hbool_t corder_valid; H5O_msg_crt_idx_t corder; H5T_cset_t cset; hsize_t data_size; } H5A_info_t;
corder_valid
indicates whether the creation order data
is valid for this attribute. Note that if creation order is not being tracked,
no creation order data will be valid. Valid values are TRUE
and FALSE
.
corder
is a positive integer containing the creation order
of the attribute. This value is 0-based, so, for example,
the third attribute created will have a corder
value of
2
.
cset
indicates the character set used for the attribute’s
name; valid values are defined in H5Tpublic.h
and
include the following:
H5T_CSET_ASCII
| US ASCII | |
H5T_CSET_UTF8
| UTF-8 Unicode encoding |
H5Pset_char_encoding
.
data_size
indicates the size, in the number of characters,
of the attribute.
hid_t attr_id
|
IN: Attribute identifier |
H5A_info_t *ainfo
|
OUT: Attribute information struct |
SUBROUTINE h5aget_info_f(attr_id, f_corder_valid, corder, cset, data_size,hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: attr_id ! Attribute identifier 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 END SUBROUTINE h5aget_info_f
Release | C |
1.8.0 | Function introduced in this release. |