Page tree

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

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Retrieves attribute information, by attribute identifier

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5A_GET_INFO ( attr_id, ainfo )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Aget_info(
            hid_t attr_id, 
            H5A_info_t *ainfo
    )
  </code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran90 Interface: h5aget_info_f
    
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
	</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
hid_t attr_idIN: Attribute identifier
H5A_info_t *ainfo    OUT: Attribute information struct

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5A_GET_INFO retrieves attribute information, locating the attribute with an attribute identifier, attr_id, which is the identifier returned by H5A_OPEN or H5A_OPEN_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_ASCIIUS ASCII
    H5T_CSET_UTF8    UTF-8 Unicode encoding

This value is set with H5P_SET_CHAR_ENCODING.

data_size indicates the size, in the number of characters, of the attribute.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section

Coming Soon!

Comment (Hide)
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathexamples/h5_subset.c
showLineNumberstrue
lineStart32
progLangcpp
lineEnd42
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5
branchIdrefs/heads/1.10/master
projectKeyHDFFV
filepathfortran/examples/compound.f90
showLineNumberstrue
lineStart25
progLangplain
lineEnd35
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
C
Release    Change
1.8.0Function introduced in this release.