Page tree

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

Calls a user’s function for each attribute on an object

.
Hdf rm anchor
AnchorName

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorName

procedure

signature

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">herr_t H5Aiterate
(
    hid_t          

hid_t

loc_id,
    unsigned      

unsigned

*

idx,
    

H5A_operator_t op,
    void          

void

*op_data
)

</code></pre>
HTML
<pre><code class="language-c">herr_t H5Aiterate
(
    hid_t           

hid_t

obj_id,
    

H5_index_t 

idx_type,

     idx_type,
    

H5_iter_order_t order,
    hsize_t        

hsize_t

*n,
    

H5A_operator2_t op,
    void           

void

*op_data
)

Hdf rm anchor
AnchorName
</code></pre>

Hdf rm anchor
AnchorName

parameters

description

Description:
HTML Wrap
classhdf-rm-section

H5Aiterate is

H5A_ITERATE is a macro that is mapped to

either H5Aiterate1 or H5Aiterate2

either  H5A_ITERATE1  or  H5A_ITERATE2, depending on the needs of the application.

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

The H5Aiterate macro

  • The H5A_ITERATE macro will be mapped

to H5Aiterate1 and

  • to H5A_ITERATE1 and will use

the H5Aiterate1 syntax

  • the H5A_ITERATE1 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

  • The H5A_ITERATE macro mapped to H5A_ITERATE2 and will use the H5A_ITERATE2 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

library and the application are built and installed with no specific compatibility flags,

H5Aiterate is

 H5A_ITERATE  is mapped to the most recent version of the function,

currently H5Aiterate2

currently H5A_ITERATE2. If the library and/or application is compiled for Release 1.6 emulation,

H5Aiterate will

 H5A_ITERATE  will be mapped

to H5Aiterate1

to H5A_ITERATE1. 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 settingH5Aiterate

mapping

 mapping

Global settings

 

No compatibility flag

H5Aiterate2

H5A_ITERATE2 
Enable deprecated symbols

H5Aiterate2

H5A_ITERATE2 
Disable deprecated symbols

H5Aiterate2

H5A_ITERATE2 
Emulate Release 1.6 interface    

H5Aiterate1

H5A_ITERATE1 

Function-level macros

 

H5Aiterate_vers = 2

H5Aiterate2

H5A_ITERATE2
H5Aiterate_vers = 1

H5Aiterate1

H5A_ITERATE1

 

Interface history:

 

   Signature [1] above is the

original

original H5Aiterate

interface

 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

as H5A_ITERATE1.

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

as H5Aiterate2

as H5A_ITERATE2.

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
AnchorNameexample

Hdf rm anchorAnchorName

library.

Hdf rm anchor
AnchorName

returns

history

History:
HTML Wrap
classhdf-rm-section
Release    

C

Change
1.8.0The

function

function H5Aiterate

renamed to

 renamed to H5Aiterate1

and

 and deprecated in this release. 
The

macro

macro H5Aiterate

and

 and the

functions

functions H5Aiterate2

and

 and H5Aiterate_by_name introduced in this release.