HDF5 Library Java H5Callbacks

Detailed Description

Functions
int	callback (long loc_id, String name, H5A_info_t info, H5A_iterate_t op_data)
int	callback (long dataset_id, long[] cur_dims, H5D_append_t op_data)
int	callback (byte[] elem, long elem_type, int ndim, long[] point, H5D_iterate_t op_data)
int	callback (int nidx, H5E_error2_t info, H5E_walk_t op_data)
int	callback (long loc_id, String name, H5L_info_t info, H5L_iterate_opdata_t op_data)
int	callback (long loc_id, String name, H5O_info_t info, H5O_iterate_opdata_t op_data)
int	callback (long prop_id, H5P_cls_close_func_t close_data)
int	callback (long new_prop_id, long old_prop_id, H5P_cls_copy_func_t copy_data)
int	callback (long prop_id, H5P_cls_create_func_t create_data)
int	callback (long plist, String name, H5P_iterate_t op_data)
int	callback (String name, long size, byte[] value)
int	callback (byte[] value1, byte[] value2, long size)
int	callback (String name, long size, byte[] value)
int	callback (String name, long size, byte[] value)
int	callback (long prop_id, String name, long size, byte[] value)
int	callback (long prop_id, String name, long size, byte[] value)
int	callback (long prop_id, String name, long size, byte[] value)

Function Documentation

callback() [1/17]

int callback	(	long	loc_id,
		String	name,
		H5A_info_t	info,
		H5A_iterate_t	op_data )

application callback for each attribute

Parameters

loc_id	the ID for the group or dataset being iterated over
name	the name of the current attribute about the object
info	the attribute's "info" struct
op_data	the operator data passed in to H5Aiterate

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.

callback() [2/17]

int callback	(	long	dataset_id,
		long[]	cur_dims,
		H5D_append_t	op_data )

application callback for each dataset access property list

Parameters

dataset_id	the ID for the dataset being iterated over
cur_dims	the dimension sizes for determining boundary
op_data	the operator data passed in to H5Pset/get_append_flush

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.

callback() [3/17]

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

application callback for each dataset element

Parameters

elem	the pointer to the element in memory containing the current point
elem_type	the datatype ID for the elements stored in elem
ndim	the number of dimensions for POINT array
point	the array containing the location of the element within the original dataspace
op_data	the 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.

callback() [4/17]

int callback	(	int	nidx,
		H5E_error2_t	info,
		H5E_walk_t	op_data )

application callback for each error stack element

Parameters

nidx	the index of the current error stack element
info	the error stack "info" struct
op_data	the operator data passed in to H5Ewalk

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.

callback() [5/17]

int callback	(	long	loc_id,
		String	name,
		H5L_info_t	info,
		H5L_iterate_opdata_t	op_data )

application callback for each group

Parameters

loc_id	the ID for the group being iterated over
name	the name of the current link
info	the link's "info" struct
op_data	the operator data passed in to H5Literate

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.

callback() [6/17]

int callback	(	long	loc_id,
		String	name,
		H5O_info_t	info,
		H5O_iterate_opdata_t	op_data )

application callback for each group

Parameters

loc_id	the ID for the group or dataset being iterated over
name	the name of the current object
info	the object's "info" struct
op_data	the operator data passed in to H5Oiterate

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.

callback() [7/17]

int callback	(	long	prop_id,
		H5P_cls_close_func_t	close_data )

application callback for each property list

Parameters

prop_id	the ID for the property list class being iterated over
close_data	the function to call when a property list is closed

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.

callback() [8/17]

int callback	(	long	new_prop_id,
		long	old_prop_id,
		H5P_cls_copy_func_t	copy_data )

application callback for each property list

Parameters

new_prop_id	the ID for the property list copy
old_prop_id	the ID for the property list class being copied
copy_data	the function to call when each property list in this class is copied

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.

callback() [9/17]

int callback	(	long	prop_id,
		H5P_cls_create_func_t	create_data )

application callback for each property list

Parameters

prop_id	the ID for the property list class being iterated over
create_data	the function to call when each property list in this class is created

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.

callback() [10/17]

int callback	(	long	plist,
		String	name,
		H5P_iterate_t	op_data )

application callback for each property list

Parameters

plist	the ID for the property list being iterated over
name	the name of the current property list
op_data	the operator data passed in to H5Piterate

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.

callback() [11/17]

int callback	(	String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

name	the name of the property being closed
size	the size of the property value
value	the value of the property being closed

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.

callback() [12/17]

int callback	(	byte[]	value1,
		byte[]	value2,
		long	size )

application callback for each property list

Parameters

value1	the value of the first property being compared
value2	the value of the second property being compared
size	the size of the property value

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.

callback() [13/17]

int callback	(	String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

name	the name of the property being copied
size	the size of the property value
value	the value of the property being copied

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.

callback() [14/17]

int callback	(	String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

name	the name of the property list being created
size	the size of the property value
value	the initial value for the property being created

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.

callback() [15/17]

int callback	(	long	prop_id,
		String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

prop_id	the ID of the property list the property is deleted from
name	the name of the property being deleted
size	the size of the property value
value	the value of the property being deleted

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.

callback() [16/17]

int callback	(	long	prop_id,
		String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

prop_id	the ID for the property list being queried
name	the name of the property being queried
size	the size of the property value
value	the value being retrieved for the property

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.

callback() [17/17]

int callback	(	long	prop_id,
		String	name,
		long	size,
		byte[]	value )

application callback for each property list

Parameters

prop_id	the ID for the property list being modified
name	the name of the property being modified
size	the size of the property value
value	the value being set for the property

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.