Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
H5D_iterate_cb Interface Reference

Detailed Description

Information class for link callback for H5Diterate.

+ Inheritance diagram for H5D_iterate_cb:

Public Member Functions

int callback (byte[] elem, long elem_type, int ndim, long[] point, H5D_iterate_t op_data)
 

Member Function Documentation

◆ callback()

int callback ( byte[]  elem,
long  elem_type,
int  ndim,
long[]  point,
H5D_iterate_t  op_data 
)

application callback for each dataset element

Parameters
elemthe pointer to the element in memory containing the current point
elem_typethe datatype ID for the elements stored in elem
ndimthe number of dimensions for POINT array
pointthe array containing the location of the element within the original dataspace
op_datathe operator data passed in to H5Diterate
Returns
operation status A. Zero causes the iterator to continue, returning zero when all attributes have been processed. B. Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next attribute. C. Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next attribute.

The documentation for this interface was generated from the following file: