- Created by Barbara Jones, last modified on Nov 08, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 6 Next »
H5A_ITERATE
Calls a user’s function for each attribute on an object.
Signature:
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 )
Fortran90 Interface:
None.
Replace this text with the C++ Function Signature
Replace this text with the JAVA Function Signature
Description:
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
H5Aiteratemacro will be mapped toH5Aiterate1and will use theH5Aiterate1syntax (first signature above) if an application is coded for HDF5 Release 1.6.x. - The
H5Aiteratemacro mapped toH5Aiterate2and will use theH5Aiterate2syntax (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.
Returns:
Replace this text with a description of the function's return values.
Example:
int
main (void)
{
hsize_t dims[2], dimsm[2];
int data[DIM0][DIM1]; /* data to write */
int sdata[DIM0_SUB][DIM1_SUB]; /* subset to write */
int rdata[DIM0][DIM1]; /* buffer for read */
hid_t file_id, dataset_id; /* handles */
hid_t dataspace_id, memspace_id;
PROGRAM COMPOUNDEXAMPLE
USE HDF5 ! This module contains all necessary modules
IMPLICIT NONE
CHARACTER(LEN=11), PARAMETER :: filename = "compound.h5" ! File name
CHARACTER(LEN=8), PARAMETER :: dsetname = "Compound" ! Dataset name
INTEGER, PARAMETER :: dimsize = 6 ! Size of the dataset
INTEGER(HID_T) :: file_id ! File identifier
int main (void)
{
/*
* Data initialization.
*/
int i, j;
int data[NX][NY]; // buffer for data to write
for (j = 0; j < NX; j++)
{
for (i = 0; i < NY; i++)
public class H5Ex_D_Chunk {
private static String FILENAME = "H5Ex_D_Chunk.h5";
private static String DATASETNAME = "DS1";
private static final int DIM_X = 6;
private static final int DIM_Y = 8;
private static final int CHUNK_X = 4;
private static final int CHUNK_Y = 4;
private static final int RANK = 2;
private static final int NDIMS = 2;
History:
| 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. |
--- Last Modified: November 08, 2017 | 02:19 PM