H5A_ITERATE

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
Calls a user’s function for each attribute on an object.

HTML Wrap

class	hdf-rm-content-block

Hdf rm anchor

AnchorName	procedure

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 H5Aiterate(
                hid_t loc_id,
                unsigned * idx,
                H5A_operator_t op,
                void *op_data )
            
 
            herr_t H5Aiterate(
                hid_t obj_id, 
                H5_index_t idx_type, 
                H5_iter_order_t order, 
                hsize_t *n, 
                H5A_operator2_t op, 
                void *op_data ) 
            

</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: None. </code></pre>

HTML Wrap

class	hdf-togglebox hdf-cxx hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-cxx

HTML
<pre><code class="language-cpp">Replace this text with the C++ Function Signature</code></pre>

HTML Wrap

class	hdf-togglebox hdf-java hdf-togglebox-hidden

HTML Add Class

	hdf-togglebutton-visible
	hdf-togglebutton-visible
selector	.hdf-togglebutton.hdf-java

HTML
<pre><code class="language-java">Replace this text with the JAVA Function Signature</code></pre>

Hdf rm anchor

AnchorName	parameters

Parameters:

HTML Wrap

class	hdf-rm-section

See H5Aiterate1 or H5Aiterate2.

Hdf rm anchor

AnchorName	description

Description:

HTML Wrap

class	hdf-rm-section

H5Aiterate is a macro that is mapped to either H5Aiterate1 or H5Aiterate2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For example:

The H5Aiterate macro will be mapped to H5Aiterate1 and will use the H5Aiterate1 syntax (first signature above) if an application is coded for HDF5 Release 1.6.x.
The H5Aiterate macro mapped to H5Aiterate2 and will use the H5Aiterate2 syntax (second signature above) if an application is coded for HDF5 Release 1.8.x.

Macro use and mappings are fully described in “API Compatibility Macros in HDF5”; we urge you to read that document closely.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Aiterate is mapped to the most recent version of the function, currently H5Aiterate2. If the library and/or application is compiled for Release 1.6 emulation, H5Aiterate will be mapped to H5Aiterate1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility setting	`H5Aiterate` mapping
Global settings
No compatibility flag	`H5Aiterate2`
Enable deprecated symbols	`H5Aiterate2`
Disable deprecated symbols	`H5Aiterate2`
Emulate Release 1.6 interface	`H5Aiterate1`
Function-level macros
`H5Aiterate_vers = 2`	`H5Aiterate2`
`H5Aiterate_vers = 1`	`H5Aiterate1`

Interface history: Signature [1] above is the original H5Aiterate interface and the only interface available prior to HDF5 Release 1.8.0. This signature and the corresponding function are now deprecated but will remain directly callable as H5Aiterate1.

Signature [2] above was introduced with HDF5 Release 1.8.0 and is the recommended and default interface. It is directly callable as H5Aiterate2.

See “API Compatibility Macros in HDF5” for circumstances under which either of these functions might not be available in an installed instance of the HDF5 Library.

Hdf rm anchor

AnchorName	returns

Returns:

HTML Wrap

class	hdf-rm-section

Replace this text with a description of the function's return values.

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/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

HTML Wrap

class	hdf-togglebox hdf-cxx hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	c++/examples/create.cpp
showLineNumbers	true
lineStart	33
progLang	cpp
lineEnd	43
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap

class	hdf-togglebox hdf-java hdf-togglebox-hidden

Bitbucket Server file

repoSlug	hdf5
branchId	refs/heads/1.10/master
projectKey	HDFFV
filepath	java/examples/datasets/H5Ex_D_Chunk.java
showLineNumbers	true
lineStart	32
progLang	java
lineEnd	42
applicationLink	5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor

AnchorName	history

History:

HTML Wrap

class	hdf-rm-section

Release	C
1.8.0	The function `H5Aiterate` renamed to `H5Aiterate1` and deprecated in this release. The macro `H5Aiterate` and the functions `H5Aiterate2` and `H5Aiterate_by_name` introduced in this release.

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Signature:

Parameters:

Description:

Returns:

Example:

History:

The HDF Group

Site

Resources

Connect