H5L_ITERATE_BY_NAME2

Content Layer

id	1195548671

Content Column

width	50.00001%
id	1195578110
class	rm_pagetree_col mobile-hide

Content Block

id	1195578111

Content Column

width	50.00001%
id	1195548673
class	hdf-rm-main-column

Content Block

id	1195548672

Include Content

render-without-blocks	true
page	.rm-navbar

HTML Wrap

class	hdf-print-only

Page Title

HTML Wrap

class	hdf-rm-summary-block

Hdf rm anchor

AnchorName	summary

Excerpt
Iterates through links in a group

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5L_ITERATE_BY_NAME2 ( loc_id, group_name, idx_type, order, idx_p, op, op_data, lapl_id )

Hdf rm anchor

AnchorName	signature

Signature:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-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 H5Literate_by_name2 ( hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order,              
            hsize_t *idx_p, H5L_iterate2_t op, void *op_data, 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

Fortran2003:

HTML

<pre><code class="language-fortran">  SUBROUTINE h5literate_by_name_f(loc_id, group_name, index_type, &
            order, idx, op, op_data, return_value, hdferr, lapl_id)
    INTEGER(HID_T), INTENT(IN) :: loc_id
    CHARACTER(LEN=*) :: group_name 
    INTEGER, INTENT(IN) :: index_type
    INTEGER, INTENT(IN) :: order
    INTEGER(HSIZE_T), INTENT(INOUT) :: idx

    TYPE(C_FUNPTR):: op  
    TYPE(C_PTR)   :: op_data

    INTEGER, INTENT(OUT) :: return_value

    INTEGER, INTENT(OUT) :: hdferr
    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: lapl_id</code></pre>

Note

Programming Note for Fortran Developers:

The integer type of the callback function must match the C integer type. Therefore, for portability, all Fortran callback functions used by h5literate_by_name_f should be declared as INTEGER(KIND=C_INT).

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `loc_id`	IN: Location identifier of subject group; may be a file, group, dataset, named datatype or attribute identifier
const char *`group_name`	IN: Name of subject group
H5_index_t `idx_type`	IN: Type of index which determines the order
H5_iter_order_t `order`	IN: Order within index
hsize_t *`idx_p`	IN: Iteration position at which to start OUT: Position at which an interrupted iteration may be restarted
H5L_iterate2_t `op`	IN: Callback function passing data regarding the link to the calling application
void *`op_data`	IN: User-defined pointer to data required by the application for its processing of the link
hid_t `lapl_id`	IN: Link access property list

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5L_ITERATE_BY_NAME2 iterates through the links in a group, specified by loc_id and group_name, in the order of the specified index, idx_type, using a user-defined callback routine op. H5L_ITERATE_BY_NAME2 does not recursively follow links into subgroups of the specified group.

idx_type specifies the index to be used. If the links have not been indexed by the index type, they will first be sorted by that index then the iteration will begin; if the links have been so indexed, the sorting step will be unnecessary, so the iteration may begin more quickly. Valid values include the following:

`H5_INDEX_NAME`	Alpha-numeric index on name
`H5_INDEX_CRT_ORDER`	Index on creation order

order specifies the order in which objects are to be inspected along the index specified in idx_type. Valid values include the following:

`H5_ITER_INC`	Increasing order
`H5_ITER_DEC`	Decreasing order
`H5_ITER_NATIVE`	Fastest available order

idx_p allows an interrupted iteration to be resumed; it is passed in by the application with a starting point and returned by the library with the point at which the iteration stopped.

H5L_ITERATE_BY_NAME2 is not recursive. In particular, if a member of group_name is found to be a group, call it subgroup_a, H5L_ITERATE_BY_NAME2 does not examine the members of subgroup_a. When recursive iteration is required, the application must handle the recursion, explicitly calling H5L_ITERATE_BY_NAME2 on discovered subgroups.

H5L_ITERATE_BY_NAME2 assumes that the membership of the group being iterated over remains unchanged through the iteration; if any of the links in the group change during the iteration, the function’s behavior is undefined. Note, however, that objects pointed to by the links can be modified.

H5L_ITERATE_BY_NAME2 is the same as H5L_ITERATE2, except that H5L_ITERATE2 always proceeds in alphanumeric order.

Note

Programming Note for C++ Developers Using C Functions:

If a C routine that takes a function pointer as an argument is called from within C++ code, the C routine should be returned from normally.

Examples of this kind of routine include callbacks such as H5P_SET_ELINK_CB and H5P_SET_TYPE_CONV_CB and functions such as H5T_CONVERT and H5E_WALK2.

Exiting the routine in its normal fashion allows the HDF5 C library to clean up its work properly. In other words, if the C++ application jumps out of the routine back to the C++ “catch” statement, the library is not given the opportunity to close any temporary data structures that were set up when the routine was called. The C++ application should save some state as the routine is started so that any problem that occurs might be diagnosed.

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

On success, returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.

On failure, returns a negative value if something goes wrong within the library, or the first negative value returned by an operator.

Hdf rm anchor

AnchorName	example

Example:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	examples/h5_group.c
showLineNumbers	true
lineStart	151
progLang	plain
lineEnd	155
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Comment

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

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	Change
1.12.0	Function was introduced in this release.

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Procedure:

Signature:

Fortran2003:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect