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

Opens the nth attribute attached to an object

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

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

H5A_OPEN_BY_IDX(loc_id, obj_name, idx_type, order, n, aapl_id, lapl_id)

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">hid_t H5Aopen_by_idx
(
    hid_t           loc_id,
    const char     *obj_name,
    H5_index_t      idx_type,
    H5_iter_order_t order,
    hsize_t         n,
    hid_t           aapl_id,
    hid_t           lapl_id
)</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">SUBROUTINE h5aopen_by_idx_f(loc_id, obj_name, idx_type, order, n, attr_id, &
     hdferr, aapl_id, 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
      
  INTEGER, INTENT(IN) :: idx_type      
                              ! Type of index; Possible values are:
                              !  H5_INDEX_UNKNOWN_F   - Unknown index type
                              !  H5_INDEX_NAME_F      - Index on names
                              !  H5_INDEX_CRT_ORDER_F - Index on creation order
                              !  H5_INDEX_N_F	      - Number of indices defined
  INTEGER, INTENT(IN) :: order              
                              ! Order in which to iterate over index:
                              !  H5_ITER_UNKNOWN_F  - Unknown order
                              !  H5_ITER_INC_F      - Increasing order
                              !  H5_ITER_DEC_F      - Decreasing order
                              !  H5_ITER_NATIVE_F   - No particular order, 
                              !                       whatever is fastest
                 
  INTEGER(HSIZE_T), INTENT(IN) :: n      
                              ! Attribute’s position in index
  INTEGER(HID_T), INTENT(OUT) :: attr_id  
                              ! Attribute identifier
  INTEGER, INTENT(OUT) :: hdferr          
                              ! Error code:
                              ! 0 on success and -1 on failure
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: aapl_id  
                              ! Attribute access property list
  INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id  
                              ! Link access property list
END SUBROUTINE h5aopen_by_idx_f</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
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
H5_index_t idx_typeIN: Type of index
H5_iter_order_t order    IN: Index traversal order
hsize_t nIN: Attribute’s position in index
hid_t aapl_idIN: Attribute access property list
hid_t lapl_idIN: Link access property list

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5A_OPEN_BY_IDX  opens an existing attribute that is attached to an object specified by location and name, loc_id  and  obj_name , respectively. If  loc_id  fully specifies the object to which the attribute is attached,  obj_name  should be  '.'  (a dot).

The attribute is identified by an index type, an index traversal order, and a position in the index, idx_type,order and n, respectively. These parameters and their valid values are discussed in the description of  H5A_ITERATE2.

The attribute access property list, aapl_id, is currently unused and should currently be H5P_DEFAULT.

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.

This function,  H5A_OPEN , or  H5A_OPEN_BY_NAME  must be called before an attribute can be accessed for any further purpose, including reading, writing, or any modification.

The attribute identifier returned by this function must be released with  H5A_CLOSE  or resource leaks will develop.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

Returns an attribute identifier 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.