Fortran Object (H5O) Interface

Detailed Description

h5o_token_t_f derived type

See also

Objects (H5O), C-API

HDF5 Objects, User Guide

Modules
module	h5o
	This module contains Fortran interfaces for H5O functions.

Data Types
type	h5o_token_t_f

Functions/Subroutines
subroutine	h5olink_f (object_id, new_loc_id, new_link_name, hdferr, lcpl_id, lapl_id)
	Creates a hard link to an object in an HDF5 file.
subroutine	h5oopen_f (loc_id, name, obj_id, hdferr, lapl_id)
	Opens an object in an HDF5 file by location identifier and path name.
subroutine	h5oopen_async_f (loc_id, name, obj_id, es_id, hdferr, lapl_id, file, func, line)
	Asynchronously opens an object in an HDF5 file by location identifier and path name.
subroutine	h5oclose_f (object_id, hdferr)
	Closes an object in an HDF5 file.
subroutine	h5oclose_async_f (object_id, es_id, hdferr, file, func, line)
	Asynchronously closes an object in an HDF5 file.
subroutine	h5oopen_by_token_f (loc_id, token, obj_id, hdferr)
	Opens an object using its token within an HDF5 file.
subroutine	h5ocopy_f (src_loc_id, src_name, dst_loc_id, dst_name, hdferr, ocpypl_id, lcpl_id)
	Copies an object in an HDF5 file.
subroutine	h5ocopy_async_f (src_loc_id, src_name, dst_loc_id, dst_name, es_id, hdferr, ocpypl_id, lcpl_id, file, func, line)
	Asynchronously copies an object in an HDF5 file.
subroutine	h5odecr_refcount_f (object_id, hdferr)
	Decrements an object reference count.
subroutine	h5oexists_by_name_f (loc_id, name, link_exists, hdferr, lapl_id)
	Determines whether a link resolves to an actual object.
subroutine	h5oget_comment_f (obj_id, comment, hdferr, bufsize)
	Retrieves comment for specified object.
subroutine	h5oget_comment_by_name_f (loc_id, name, comment, hdferr, bufsize, lapl_id)
	Retrieves comment for specified object.
subroutine	h5oincr_refcount_f (obj_id, hdferr)
	Increments an object reference count.
subroutine	h5oopen_by_idx_f (loc_id, group_name, index_type, order, n, obj_id, hdferr, lapl_id)
	Open the nth object in a group.
subroutine	h5oopen_by_idx_async_f (loc_id, group_name, index_type, order, n, obj_id, es_id, hdferr, lapl_id, file, func, line)
	Asynchronously open the nth object in a group.
subroutine	h5oset_comment_f (obj_id, comment, hdferr)
	Sets comment for specified object.
subroutine	h5oset_comment_by_name_f (loc_id, name, comment, hdferr, lapl_id)
	Sets comment for specified object.
subroutine	h5ovisit_f (object_id, index_type, order, op, op_data, return_value, hdferr, fields)
	Recursively visits all objects starting from a specified object.
subroutine	h5oget_info_by_name_f (loc_id, name, object_info, hdferr, lapl_id, fields)
	Retrieves the metadata for an object, identifying the object by location and relative name.
subroutine	h5oget_info_by_name_async_f (loc_id, name, object_info, es_id, hdferr, lapl_id, fields, file, func, line)
	Asynchronously retrieves the metadata for an object, identifying the object by location and relative name.
subroutine	h5oget_info_f (object_id, object_info, hdferr, fields)
	Retrieves the metadata for an object specified by an identifier.
subroutine	h5oget_info_by_idx_f (loc_id, group_name, index_field, order, n, object_info, hdferr, lapl_id, fields)
	Retrieves the metadata for an object, identifying the object by an index position.
subroutine	h5ovisit_by_name_f (loc_id, object_name, index_type, order, op, op_data, return_value, hdferr, lapl_id, fields)
	Recursively visits all objects starting from a specified object.
subroutine	h5otoken_cmp_f (loc_id, token1, token2, cmp_value, hdferr)
	Compare two tokens, which must be from the same file / containers.

Variables
integer(c_int8_t), dimension(1:h5o_token_buf_len)	token
integer	h5o_copy_shallow_hierarchy_f
	H5O_COPY_SHALLOW_HIERARCHY_FLAG.
integer	h5o_copy_expand_soft_link_f
	H5O_COPY_EXPAND_SOFT_LINK_FLAG.
integer	h5o_copy_expand_ext_link_f
	H5O_COPY_EXPAND_EXT_LINK_FLAG.
integer	h5o_copy_expand_reference_f
	H5O_COPY_EXPAND_REFERENCE_FLAG.
integer	h5o_copy_without_attr_flag_f
	H5O_COPY_WITHOUT_ATTR_FLAG.
integer	h5o_copy_preserve_null_flag_f
	H5O_COPY_PRESERVE_NULL_FLAG.
integer	h5o_copy_all_f
	H5O_COPY_ALL.
integer	h5o_shmesg_none_flag_f
	H5O_SHMESG_NONE_FLAG.
integer	h5o_shmesg_sdspace_flag_f
	H5O_SHMESG_SDSPACE_FLAG.
integer	h5o_shmesg_dtype_flag_f
	H5O_SHMESG_DTYPE_FLAG.
integer	h5o_shmesg_fill_flag_f
	H5O_SHMESG_FILL_FLAG.
integer	h5o_shmesg_pline_flag_f
	H5O_SHMESG_PLINE_FLAG.
integer	h5o_shmesg_attr_flag_f
	H5O_SHMESG_ATTR_FLAG.
integer	h5o_shmesg_all_flag_f
	H5O_SHMESG_ALL_FLAG.
integer	h5o_hdr_chunk0_size_f
	H5O_HDR_CHUNK0_SIZE.
integer	h5o_hdr_attr_crt_order_track_f
integer	h5o_hdr_attr_crt_order_index_f
integer	h5o_hdr_attr_store_phase_cha_f
integer	h5o_hdr_store_times_f
	H5O_HDR_STORE_TIMES.
integer	h5o_hdr_all_flags_f
	H5O_HDR_ALL_FLAGS.
integer	h5o_shmesg_max_nindexes_f
	H5O_SHMESG_MAX_NINDEXES.
integer	h5o_shmesg_max_list_size_f
	H5O_SHMESG_MAX_LIST_SIZE.
integer	h5o_type_unknown_f
	H5O_TYPE_UNKNOWN.
integer	h5o_type_group_f
	H5O_TYPE_GROUP.
integer	h5o_type_dataset_f
	H5O_TYPE_DATASET.
integer	h5o_type_named_datatype_f
	H5O_TYPE_NAMED_DATATYPE.
integer	h5o_type_ntypes_f
	H5O_TYPE_NTYPES.
integer	h5o_info_all_f
	H5O_INFO_ALL.
integer	h5o_info_basic_f
	H5O_INFO_BASIC.
integer	h5o_info_time_f
	H5O_INFO_TIME.
integer	h5o_info_num_attrs_f
	H5O_INFO_NUM_ATTRS.
integer	h5o_info_hdr_f
	H5O_INFO_HDR.
integer	h5o_info_meta_size_f
	H5O_INFO_META_SIZE.

Function/Subroutine Documentation

h5oclose_async_f()

subroutine h5oclose_async_f	(	integer(hid_t), intent(in)	object_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		type(c_ptr), intent(in), optional	file,
		type(c_ptr), intent(in), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously closes an object in an HDF5 file.

Parameters

object_id	Object identifier
es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.
file	Pointer to filename the async subroutine is being called from, filename must be null character terminated
func	Pointer to function name the async subroutine is being called in, func must be null character terminated
line	Line number the async subroutine is being called at

See C API: H5Oclose_async()

h5oclose_f()

subroutine h5oclose_f	(	integer(hid_t), intent(in)	object_id,
		integer, intent(out)	hdferr
	)

Closes an object in an HDF5 file.

Parameters

object_id	Object identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oclose()

h5ocopy_async_f()

subroutine h5ocopy_async_f	(	integer(hid_t), intent(in)	src_loc_id,
		character(len=*), intent(in)	src_name,
		integer(hid_t), intent(in)	dst_loc_id,
		character(len=*), intent(in)	dst_name,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	ocpypl_id,
		integer(hid_t), intent(in), optional	lcpl_id,
		type(c_ptr), intent(in), optional	file,
		type(c_ptr), intent(in), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously copies an object in an HDF5 file.

Parameters

src_loc_id	Object identifier indicating the location of the source object to be copied.
src_name	Name of the source object to be copied.
dst_loc_id	Location identifier specifying the destination.
dst_name	Name to be assigned to the new copy.
ocpypl_id	Object copy property list.
lcpl_id	Link creation property list for the new hard link.
es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.
file	Pointer to filename the async subroutine is being called from, filename must be null character terminated
func	Pointer to function name the async subroutine is being called in, func must be null character terminated
line	Line number the async subroutine is being called at

See C API: H5Ocopy_async()

h5ocopy_f()

subroutine h5ocopy_f	(	integer(hid_t), intent(in)	src_loc_id,
		character(len=*), intent(in)	src_name,
		integer(hid_t), intent(in)	dst_loc_id,
		character(len=*), intent(in)	dst_name,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	ocpypl_id,
		integer(hid_t), intent(in), optional	lcpl_id
	)

Copies an object in an HDF5 file.

Parameters

src_loc_id	Object identifier indicating the location of the source object to be copied.
src_name	Name of the source object to be copied.
dst_loc_id	Location identifier specifying the destination.
dst_name	Name to be assigned to the new copy.
ocpypl_id	Object copy property list.
lcpl_id	Link creation property list for the new hard link.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Ocopy()

h5odecr_refcount_f()

subroutine h5odecr_refcount_f	(	integer(hid_t), intent(in)	object_id,
		integer, intent(out)	hdferr
	)

Decrements an object reference count.

Parameters

object_id	Object identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Odecr_refcount()

h5oexists_by_name_f()

subroutine h5oexists_by_name_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		logical, intent(out)	link_exists,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id
	)

Determines whether a link resolves to an actual object.

Parameters

loc_id	IdeIdentifier of the file or group to query.
name	TheThe name of the link to check.
lapl_id	Link access property list identifier.
link_exists	Existing link resolves to an object.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oexists_by_name()

h5oget_comment_by_name_f()

subroutine h5oget_comment_by_name_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		character(len=*), intent(out)	comment,
		integer, intent(out)	hdferr,
		integer(size_t), intent(out), optional	bufsize,
		integer(hid_t), intent(in), optional	lapl_id
	)

Retrieves comment for specified object.

Parameters

loc_id	Identifier of a file, group, dataset, or named datatype.
name	Name of the object whose comment is to be retrieved, specified as a path relative to loc_id.
comment	The comment.
hdferr	Returns 0 if successful and -1 if it fails.
bufsize	Size of the comment buffer.
lapl_id	File access property list identifier.

See C API: H5Oget_comment_by_name()

h5oget_comment_f()

subroutine h5oget_comment_f	(	integer(hid_t), intent(in)	obj_id,
		character(len=*), intent(out)	comment,
		integer, intent(out)	hdferr,
		integer(hssize_t), intent(out), optional	bufsize
	)

Retrieves comment for specified object.

Parameters

obj_id	Identifier for the target object.
bufsize	Size of the comment buffer.
comment	The comment.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oget_comment()

h5oget_info_by_idx_f()

subroutine h5oget_info_by_idx_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	group_name,
		integer, intent(in)	index_field,
		integer, intent(in)	order,
		integer(hsize_t), intent(in)	n,
		type(h5o_info_t), intent(out), target	object_info,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		integer, intent(in), optional	fields
	)

Retrieves the metadata for an object, identifying the object by an index position.

Parameters

loc_id	File or group identifier specifying location of group in which object is located.
group_name	Name of group in which object is located.
index_field	Index or field that determines the order.
order	Order within field or index.
n	Object for which information is to be returned.
object_info	Buffer in which to return object information.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list. (Not currently used.).
fields	Flags specifying the fields to include in object_info.

See C API: H5Oget_info_by_idx3()

h5oget_info_by_name_async_f()

subroutine h5oget_info_by_name_async_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		type(c_ptr), intent(in)	object_info,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		integer, intent(in), optional	fields,
		type(c_ptr), intent(in), optional	file,
		type(c_ptr), intent(in), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously retrieves the metadata for an object, identifying the object by location and relative name.

Parameters

loc_id	File or group identifier specifying location of group in which object is located.
name	Name of group, relative to loc_id.
object_info	Pointer to buffer returning object information, points to variable of datatype TYPE(C_H5O_INFO_T).
es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list.
fields	Flags specifying the fields to include in object_info.
file	Pointer to filename the async subroutine is being called from, filename must be null character terminated
func	Pointer to function name the async subroutine is being called in, func must be null character terminated
line	Line number the async subroutine is being called at

See C API: H5Oget_info_by_name_async()

h5oget_info_by_name_f()

subroutine h5oget_info_by_name_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		type(h5o_info_t), intent(out), target	object_info,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		integer, intent(in), optional	fields
	)

Retrieves the metadata for an object, identifying the object by location and relative name.

Parameters

loc_id	File or group identifier specifying location of group in which object is located.
name	Name of group, relative to loc_id.
object_info	Buffer in which to return object information.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list.
fields	Flags specifying the fields to include in object_info.

See C API: H5Oget_info_by_name3()

h5oget_info_f()

subroutine h5oget_info_f	(	integer(hid_t), intent(in)	object_id,
		type(h5o_info_t), intent(out), target	object_info,
		integer, intent(out)	hdferr,
		integer, intent(in), optional	fields
	)

Retrieves the metadata for an object specified by an identifier.

Parameters

object_id	Identifier for target object.
object_info	Buffer in which to return object information.
hdferr	Returns 0 if successful and -1 if it fails.
fields	Flags specifying the fields to include in object_info.

See C API: H5Oget_info3()

h5oincr_refcount_f()

subroutine h5oincr_refcount_f	(	integer(hid_t), intent(in)	obj_id,
		integer, intent(out)	hdferr
	)

Increments an object reference count.

Parameters

obj_id	Object identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oincr_refcount()

h5olink_f()

subroutine h5olink_f	(	integer(hid_t), intent(in)	object_id,
		integer(hid_t), intent(in)	new_loc_id,
		character(len=*), intent(in)	new_link_name,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lcpl_id,
		integer(hid_t), intent(in), optional	lapl_id
	)

Creates a hard link to an object in an HDF5 file.

Parameters

object_id	Object to be linked.
new_loc_id	File or group identifier specifying location at which object is to be linked.
new_link_name	Name of link to be created, relative to new_loc_id.
hdferr	Returns 0 if successful and -1 if it fails.
lcpl_id	Link creation property list identifier.
lapl_id	Link access property list identifier.

See C API: H5Olink()

h5oopen_async_f()

subroutine h5oopen_async_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	obj_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		type(c_ptr), intent(in), optional	file,
		type(c_ptr), intent(in), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously opens an object in an HDF5 file by location identifier and path name.

Parameters

loc_id	File or group identifier.
name	Path to the object, relative to loc_id.
obj_id	Object identifier for the opened object.
es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Access property list identifier for the link pointing to the object.
file	Pointer to filename the async subroutine is being called from, filename must be null character terminated
func	Pointer to function name the async subroutine is being called in, func must be null character terminated
line	Line number the async subroutine is being called at

See C API: H5Oopen_async()

h5oopen_by_idx_async_f()

subroutine h5oopen_by_idx_async_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	group_name,
		integer, intent(in)	index_type,
		integer, intent(in)	order,
		integer(hsize_t), intent(in)	n,
		integer(hid_t), intent(out)	obj_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		type(c_ptr), intent(in), optional	file,
		type(c_ptr), intent(in), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously open the nth object in a group.

Parameters

loc_id	A file or group identifier.
group_name	Name of group, relative to loc_id, in which object is located.
index_type	Type of index by which objects are ordered.
order	Order of iteration within index, NOTE: zero-based.
n	Object to open.
obj_id	An object identifier for the opened object.
es_id	Event set identifier
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list.
file	Pointer to filename the async subroutine is being called from, filename must be null character terminated
func	Pointer to function name the async subroutine is being called in, func must be null character terminated
line	Line number the async subroutine is being called at

See C API: H5Oopen_by_idx_async()

h5oopen_by_idx_f()

subroutine h5oopen_by_idx_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	group_name,
		integer, intent(in)	index_type,
		integer, intent(in)	order,
		integer(hsize_t), intent(in)	n,
		integer(hid_t), intent(out)	obj_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id
	)

Open the nth object in a group.

Parameters

loc_id	A file or group identifier.
group_name	Name of group, relative to loc_id, in which object is located.
index_type	Type of index by which objects are ordered.
order	Order of iteration within index, NOTE: zero-based.
n	Object to open.
obj_id	An object identifier for the opened object.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list.

See C API: H5Oopen_by_idx()

h5oopen_by_token_f()

subroutine h5oopen_by_token_f	(	integer(hid_t), intent(in)	loc_id,
		type(h5o_token_t_f), intent(in)	token,
		integer(hid_t), intent(out)	obj_id,
		integer, intent(out)	hdferr
	)

Opens an object using its token within an HDF5 file.

Parameters

loc_id	File or group identifier.
token	Object's token in the file.
obj_id	Object identifier for the opened object.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oopen_by_token()

h5oopen_f()

subroutine h5oopen_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	obj_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id
	)

Opens an object in an HDF5 file by location identifier and path name.

Parameters

loc_id	File or group identifier.
name	Path to the object, relative to loc_id.
obj_id	Object identifier for the opened object.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Access property list identifier for the link pointing to the object.

See C API: H5Oopen()

h5oset_comment_by_name_f()

subroutine h5oset_comment_by_name_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	comment,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id
	)

Sets comment for specified object.

Parameters

loc_id	Identifier of a file, group, dataset, or named datatype.
name	Name of the object whose comment is to be set or reset, specified as a path relative to loc_id.
comment	The new comment.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list identifier.

See C API: H5Oset_comment_by_name()

h5oset_comment_f()

subroutine h5oset_comment_f	(	integer(hid_t), intent(in)	obj_id,
		character(len=*), intent(in)	comment,
		integer, intent(out)	hdferr
	)

Sets comment for specified object.

Parameters

obj_id	Identifier of the target object.
comment	The new comment.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Oset_comment()

h5otoken_cmp_f()

subroutine h5otoken_cmp_f	(	integer(hid_t), intent(in)	loc_id,
		type(h5o_token_t_f), intent(in)	token1,
		type(h5o_token_t_f), intent(in)	token2,
		integer, intent(out)	cmp_value,
		integer, intent(out)	hdferr
	)

Compare two tokens, which must be from the same file / containers.

Parameters

loc_id	Identifier of an object in the file / container.
token1	The first token to compare.
token2	The second token to compare.
cmp_value	Returns 0 if tokens are equal, non-zero for unequal tokens.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Otoken_cmp()

h5ovisit_by_name_f()

subroutine h5ovisit_by_name_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	object_name,
		integer, intent(in)	index_type,
		integer, intent(in)	order,
		type(c_funptr), intent(in)	op,
		type(c_ptr), intent(inout)	op_data,
		integer, intent(out)	return_value,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	lapl_id,
		integer, intent(in), optional	fields
	)

Recursively visits all objects starting from a specified object.

Parameters

loc_id	Identifier of a file or group.
object_name	Name of the object, generally relative to loc_id, that will serve as root of the iteration.
index_type	Type of index; valid values include: H5_INDEX_NAME_F H5_INDEX_CRT_ORDER_F
order	Order in which index is traversed; valid values include: H5_ITER_DEC_F H5_ITER_INC_F H5_ITER_NATIVE_F
op	Callback function passing data regarding the group to the calling application.
op_data	User-defined pointer to data required by the application for its processing of the group.
return_value	Returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
hdferr	Returns 0 if successful and -1 if it fails.
lapl_id	Link access property list identifier.
fields	Flags specifying the fields to include in object_info.

See C API: H5Ovisit_by_name3()

h5ovisit_f()

subroutine h5ovisit_f	(	integer(hid_t), intent(in)	object_id,
		integer, intent(in)	index_type,
		integer, intent(in)	order,
		type(c_funptr), intent(in)	op,
		type(c_ptr), intent(inout)	op_data,
		integer, intent(out)	return_value,
		integer, intent(out)	hdferr,
		integer, intent(in), optional	fields
	)

Recursively visits all objects starting from a specified object.

Parameters

object_id	Identifier of the object at which the recursive iteration begins.
index_type	Type of index; valid values include: H5_INDEX_NAME_F H5_INDEX_CRT_ORDER_F
order	Order in which index is traversed; valid values include: H5_ITER_DEC_F H5_ITER_INC_F H5_ITER_NATIVE_F
op	Callback function passing data regarding the group to the calling application.
op_data	User-defined pointer to data required by the application for its processing of the group.
return_value	Returns the return value of the first operator that returns a positive value, or zero if all members were processed with no operator returning non-zero.
hdferr	Returns 0 if successful and -1 if it fails.
fields	Flags specifying the fields to include in object_info.

See C API: H5Ovisit3()

Variable Documentation

h5o_copy_all_f

integer h5o_copy_all_f

H5O_COPY_ALL.

h5o_copy_expand_ext_link_f

integer h5o_copy_expand_ext_link_f

H5O_COPY_EXPAND_EXT_LINK_FLAG.

h5o_copy_expand_reference_f

integer h5o_copy_expand_reference_f

H5O_COPY_EXPAND_REFERENCE_FLAG.

h5o_copy_expand_soft_link_f

integer h5o_copy_expand_soft_link_f

H5O_COPY_EXPAND_SOFT_LINK_FLAG.

h5o_copy_preserve_null_flag_f

integer h5o_copy_preserve_null_flag_f

H5O_COPY_PRESERVE_NULL_FLAG.

h5o_copy_shallow_hierarchy_f

integer h5o_copy_shallow_hierarchy_f

H5O_COPY_SHALLOW_HIERARCHY_FLAG.

h5o_copy_without_attr_flag_f

integer h5o_copy_without_attr_flag_f

H5O_COPY_WITHOUT_ATTR_FLAG.

h5o_hdr_all_flags_f

integer h5o_hdr_all_flags_f

H5O_HDR_ALL_FLAGS.

h5o_hdr_attr_crt_order_index_f

integer h5o_hdr_attr_crt_order_index_f

h5o_hdr_attr_crt_order_track_f

integer h5o_hdr_attr_crt_order_track_f

h5o_hdr_attr_store_phase_cha_f

integer h5o_hdr_attr_store_phase_cha_f

h5o_hdr_chunk0_size_f

integer h5o_hdr_chunk0_size_f

H5O_HDR_CHUNK0_SIZE.

h5o_hdr_store_times_f

integer h5o_hdr_store_times_f

H5O_HDR_STORE_TIMES.

h5o_info_all_f

integer h5o_info_all_f

H5O_INFO_ALL.

h5o_info_basic_f

integer h5o_info_basic_f

H5O_INFO_BASIC.

h5o_info_hdr_f

integer h5o_info_hdr_f

H5O_INFO_HDR.

h5o_info_meta_size_f

integer h5o_info_meta_size_f

H5O_INFO_META_SIZE.

h5o_info_num_attrs_f

integer h5o_info_num_attrs_f

H5O_INFO_NUM_ATTRS.

h5o_info_time_f

integer h5o_info_time_f

H5O_INFO_TIME.

h5o_shmesg_all_flag_f

integer h5o_shmesg_all_flag_f

H5O_SHMESG_ALL_FLAG.

h5o_shmesg_attr_flag_f

integer h5o_shmesg_attr_flag_f

H5O_SHMESG_ATTR_FLAG.

h5o_shmesg_dtype_flag_f

integer h5o_shmesg_dtype_flag_f

H5O_SHMESG_DTYPE_FLAG.

h5o_shmesg_fill_flag_f

integer h5o_shmesg_fill_flag_f

H5O_SHMESG_FILL_FLAG.

h5o_shmesg_max_list_size_f

integer h5o_shmesg_max_list_size_f

H5O_SHMESG_MAX_LIST_SIZE.

h5o_shmesg_max_nindexes_f

integer h5o_shmesg_max_nindexes_f

H5O_SHMESG_MAX_NINDEXES.

h5o_shmesg_none_flag_f

integer h5o_shmesg_none_flag_f

H5O_SHMESG_NONE_FLAG.

h5o_shmesg_pline_flag_f

integer h5o_shmesg_pline_flag_f

H5O_SHMESG_PLINE_FLAG.

h5o_shmesg_sdspace_flag_f

integer h5o_shmesg_sdspace_flag_f

H5O_SHMESG_SDSPACE_FLAG.

h5o_type_dataset_f

integer h5o_type_dataset_f

H5O_TYPE_DATASET.

h5o_type_group_f

integer h5o_type_group_f

H5O_TYPE_GROUP.

h5o_type_named_datatype_f

integer h5o_type_named_datatype_f

H5O_TYPE_NAMED_DATATYPE.

h5o_type_ntypes_f

integer h5o_type_ntypes_f

H5O_TYPE_NTYPES.

h5o_type_unknown_f

integer h5o_type_unknown_f

H5O_TYPE_UNKNOWN.

token

integer(c_int8_t), dimension(1:h5o_token_buf_len) token