H5O_VISIT_BY_NAME3

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
Recursively visits all objects starting from a specified object

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

Procedure:

HTML Wrap

class	hdf-rm-section

HTML Wrap

class	hdf_procedure

H5O_VISIT_BY_NAME3 ( loc_id, obj_name, idx_type, order, op, op_data, fields, 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 H5Ovisit_by_name3 ( hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order, H5O_iterate2_t op, void *op_data, 
             unsigned fields, 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">SUBROUTINE h5ovisit_by_name_f(loc_id, object_name, index_type, order, &
       op, op_data, return_value, hdferr, lapl_id)
    USE, INTRINSIC :: ISO_C_BINDING
    IMPLICIT NONE
    INTEGER(HID_T)  , INTENT(IN)             :: loc_id
    CHARACTER(LEN=*), INTENT(IN)             :: object_name
    INTEGER         , INTENT(IN)             :: index_type 
    INTEGER         , INTENT(IN)             :: order

    TYPE(C_FUNPTR)                           :: op
    TYPE(C_PTR)                              :: op_data
    INTEGER         , INTENT(OUT)            :: return_value
    INTEGER         , INTENT(OUT)            :: hdferr
    INTEGER(HID_T)  , INTENT(IN) , OPTIONAL  :: lapl_id</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

hid_t `loc_id`	IN: Location identifier; may be a file, group, dataset, named datatype or attribute identifier
const char *`obj_name`	IN: Name of the object, generally relative to `loc_id`, that will serve as root of the iteration
H5_index_t `idx_type`	IN: Type of index; valid values include: `H5_INDEX_NAME` `H5_INDEX_CRT_ORDER`
H5_iter_order_t `order`	IN: Order in which index is traversed; valid values include: `H5_ITER_DEC` `H5_ITER_INC` `H5_ITER_NATIVE`
H5O_iterate2_t `op`	IN: Callback function passing data regarding the object to the calling application
void *`op_data`	IN: User-defined pointer to data required by the application for its processing of the object
unsigned `fields`	IN: Flags specifying the fields to be retrieved to the callback function `op`
hid_t `lapl_id`	IN: Link access property list identifier

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5O_VISIT_BY_NAME3 is a recursive iteration function to visit the object specified by the loc_id / obj_name parameter pair and, if that object is a group, all objects in and below it in an HDF5 file, thus providing a mechanism for an application to perform a common set of operations across all of those objects or a dynamically selected subset. For non-recursive iteration across the members of a group, see H5L_ITERATE2.

The object serving as the root of the iteration is specified by the loc_id / obj_name parameter pair. loc_id specifies a file or an object in a file; obj_name specifies either an object in the file (with an absolute name based in the file’s root group) or an object name relative to loc_id. If loc_id fully specifies the object that is to serve as the root of the iteration, obj_name should be '.' (a dot). (Note that when loc_id fully specifies the the object that is to serve as the root of the iteration, the user may wish to consider using H5O_VISIT3 instead of H5O_VISIT_BY_NAME3.)

Two parameters are used to establish the iteration: idx_type and order.

idx_type specifies the index to be used. If the links in a group 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 unnecesary, 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

Note that the index type passed in idx_type is a best effort setting. If the application passes in a value indicating iteration in creation order and a group is encountered that was not tracked in creation order, that group will be iterated over in alpha-numeric order by name, or name order. (Name order is the native order used by the HDF5 library and is always available.)

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

The prototype of the callback function op is as follows (as defined in the source code file H5Opublic.h):

typedef herr_t (*H5O_iterate2_t)(hid_t obj, const char *name, const H5O_info2_t *info, void *op_data);

The parameters of this callback function have the following values or meanings:

`obj`	Object that serves as root of the iteration
`name`	Name of object, relative to `obj`, being examined at current step of the iteration
`info`	H5O_info2_t struct containing information regarding that object
`op_data`	User-defined pointer to data required by the application in processing the object

The H5O_info2_t struct is defined (in H5Opublic.h) as follows :

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	src/H5Opublic.h
fileEncoding	US-ASCII
lineStart	129
progLang	plain
lineEnd	141
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

H5O_token_t is defined in H5public.h as follows:

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	src/H5public.h
fileEncoding	US-ASCII
lineStart	337
progLang	plain
lineEnd	341
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

The H5O_type_t enum indicates the object type and is defined (in H5Opublic.h) as follows:

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	src/H5Opublic.h
fileEncoding	US-ASCII
lineStart	101
progLang	plain
lineEnd	109
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

The H5O_VISIT_BY_NAME3 op_data parameter is a user-defined pointer to the data required to process objects in the course of the iteration. This pointer is passed back to each step of the iteration in the callback function’s op_data parameter.

lapl_id is a link access property list. In the general case, when default link access properties are acceptable, this can be passed in as H5P_DEFAULT. An example of a situation that requires a non-default link access property list is when the link is an external link; an external link may require that a link prefix be set in a link access property list (see H5P_SET_ELINK_PREFIX).

The fields parameter contains flags to determine which fields will be retrieved by the op callback function. These flags are defined in the H5Opublic.h file:

Flag	Purpose
H5O_INFO_BASIC	Fill in the fileno, addr, type, and rc fields
H5O_INFO_TIME	Fill in the atime, mtime, ctime, and btime fields
H5O_INFO_NUM_ATTRS	Fill in the num_attrs field
H5O_INFO_HDR	Fill in the hdr field
H5O_INFO_META_SIZE	Fill in the meta_size field
H5O_INFO_ALL	H5O_INFO_BASIC \| H5O_INFO_TIME \| H5O_INFO_NUM_ATTRS \| H5O_INFO_HDR \| H5O_INFO_META_SIZE

H5L_VISIT_BY_NAME2 and H5O_VISIT_BY_NAME3 are companion functions: one for examining and operating on links; the other for examining and operating on the objects that those links point to. Both functions ensure that by the time the function completes successfully, every link or object below the specified point in the file has been presented to the application for whatever processing the application requires.

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

Comment

Example:

HTML Wrap

class	hdf-togglebox hdf-c

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/hdf5_1_12
projectKey	HDFFV
filepath	test/links.c
showLineNumbers	true
lineStart	13057
progLang	plain
lineEnd	13060
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	The function was introduced in this release.

Page tree

Versions Compared

Old Version 7

New Version Current

Key

Procedure:

Signature:

Parameters:

Description:

Returns:

Example:

Example:

History:

The HDF Group

Site

Resources

Connect