Content Column |
---|
width | 50.00001% |
---|
id | 1195578110 |
---|
class | rm_pagetree_col mobile-hide |
---|
| |
Content Column |
---|
width | 50.00001% |
---|
id | 1195548673 |
---|
class | hdf-rm-main-column |
---|
| Content Block |
---|
| Include Content |
---|
render-without-blocks | true |
---|
page | .rm-navbar |
---|
|
HTML Wrap |
---|
class | hdf-rm-summary-block |
---|
| Excerpt |
---|
Gets an attribute name, by attribute index position |
|
HTML Wrap |
---|
class | hdf-rm-content-block |
---|
| Procedure: HTML Wrap |
---|
| HTML Wrap |
---|
| H5A_GET_NAME_BY_IDX ( loc_id, obj_name, idx_type, order, n, name, size, lapl_id ) |
|
Signature: HTML Wrap |
---|
| HTML Wrap |
---|
| HTML Add Class |
---|
| hdf-togglebutton-visible |
---|
| hdf-togglebutton-visible |
---|
selector | .hdf-togglebutton.hdf-c |
---|
|
HTML |
---|
<pre><code class="language-c">ssize_t H5Aget_name_by_idx(
hid_t loc_id,
const char *obj_name,
H5_index_t idx_type,
H5_iter_order_t order,
hsize_t n,
char *name,
size_t size,
hid_t lapl_id
)</code></pre> |
|
HTML Wrap |
---|
class | hdf-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_name_by_idx_f
SUBROUTINE h5aget_name_by_idx_f(loc_id, obj_name, idx_type, order, &
n, name, size, lapl_id, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! Identifer for object to which
! attribute is attached
CHARACTER(LEN=*), INTENT(IN) :: obj_name ! Name of object, relative to
! location,from which attribute is to
! be removed
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 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
! H5_ITER_N_F - Number of iteration orders
INTEGER(HSIZE_T), INTENT(IN) :: n
! Attribute’s position in index
CHARACTER(LEN=*), INTENT(OUT) :: name
! Attribute name
INTEGER(SIZE_T), INTENT(INOUT) :: size
! Buffer size
INTEGER(HID_T), INTENT(IN) :: lapl_id
! Link access property list
INTEGER, INTENT(OUT) :: hdferr
! Error code:
! Returns attribute name size,
! -1 if fail
END SUBROUTINE h5aget_name_by_idx_f
</code></pre> |
|
|
Parameters: HTML Wrap |
---|
| hid_t loc_id | IN: Location identifier of object to which attribute is attached; may be a file, group, dataset, or named datatype | const char *obj_name | IN: Name of object to which attribute is attached, relative to location | H5_index_t idx_type | IN: Type of index | H5_iter_order_t order | IN: Index traversal order | hsize_t n | IN: Attribute’s position in index | char *name | OUT: Attribute name | size_t size | IN: Size, in bytes, of attribute name | hid_t lapl_id | IN: Link access property list |
|
Description: HTML Wrap |
---|
| H5A_GET_NAME_BY_IDX retrieves the name of an attribute that is attached to an object, which is specified by its location and name, loc_id and obj_name , respectively. The attribute is located by its index position, the size of the name is specified in size , and the attribute name is returned in name . If loc_id fully specifies the object to which the attribute is attached, obj_name should be '.' (a dot). The attribute is located by means of 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. If the attribute name’s size is unknown, the values 0 and NULL can be passed in for the parameters size and name . The function’s return value will provide the correct value for size . 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: HTML Wrap |
---|
| Returns attribute name size, in bytes, if successful; otherwise returns a negative value. |
Example: HTML Wrap |
---|
| Coming Soon! Comment |
---|
HTML Wrap |
---|
| Bitbucket Server file |
---|
repoSlug | hdf5 |
---|
branchId | refs/heads/1.10/master |
---|
projectKey | HDFFV |
---|
filepath | examples/h5_subset.c |
---|
showLineNumbers | true |
---|
lineStart | 32 |
---|
progLang | cpp |
---|
lineEnd | 42 |
---|
applicationLink | 5ac7b370-7412-3c8c-ad20-807a68261336 |
---|
|
|
HTML Wrap |
---|
class | hdf-togglebox hdf-fortran hdf-togglebox-hidden |
---|
| Bitbucket Server file |
---|
repoSlug | hdf5 |
---|
branchId | refs/heads/1.10/master |
---|
projectKey | HDFFV |
---|
filepath | fortran/examples/compound.f90 |
---|
showLineNumbers | true |
---|
lineStart | 25 |
---|
progLang | plain |
---|
lineEnd | 35 |
---|
applicationLink | 5ac7b370-7412-3c8c-ad20-807a68261336 |
---|
|
|
|
|
History: HTML Wrap |
---|
| Release | CChange |
---|
1.8.0 | Function introduced in this release. |
|
|
|
|
|