Detailed Description

See also: Datasets (H5D), C-API; HDF5 Datasets, User Guide

Functions/Subroutines
subroutine	h5dcreate_f (loc_id, name, type_id, space_id, dset_id, hdferr, dcpl_id, lcpl_id, dapl_id)
	Creates a dataset at the specified location. More...

subroutine	h5dcreate_async_f (loc_id, name, type_id, space_id, dset_id, es_id, hdferr, dcpl_id, lcpl_id, dapl_id, file, func, line)
	Asynchronously creates a dataset at the specified location. More...

subroutine	h5dopen_f (loc_id, name, dset_id, hdferr, dapl_id)
	Opens an existing dataset. More...

subroutine	h5dopen_async_f (loc_id, name, dset_id, es_id, hdferr, dapl_id, file, func, line)
	Asynchronously opens an existing dataset. More...

subroutine	h5dclose_f (dset_id, hdferr)
	Closes a dataset. More...

subroutine	h5dclose_async_f (dset_id, es_id, hdferr, file, func, line)
	Asynchronously closes a dataset. More...

subroutine	h5dget_type_f (dataset_id, datatype_id, hdferr)
	Returns an identifier for a copy of the datatype for a dataset. More...

subroutine	h5dset_extent_f (dataset_id, fsize, hdferr)
	Extends a dataset with unlimited dimension. More...

subroutine	h5dset_extent_async_f (dataset_id, fsize, es_id, hdferr, file, func, line)
	Asynchronously extends a dataset with unlimited dimension. More...

subroutine	h5dget_create_plist_f (dataset_id, plist_id, hdferr)
	Returns an identifier for a copy of the dataset creation property list for a dataset. More...

subroutine	h5dget_storage_size_f (dataset_id, size, hdferr)
	Returns the amount of storage requires by a dataset. More...

subroutine	h5dvlen_get_max_len_f (dataset_id, type_id, space_id, len, hdferr)
	Returns maximum length of the VL array elements. More...

subroutine	h5dget_space_status_f (dset_id, flag, hdferr)
	Returns the status of data space allocation. More...

subroutine	h5dcreate_anon_f (loc_id, type_id, space_id, dset_id, hdferr, dcpl_id, dapl_id)
	Creates a dataset in a file without linking it into the file structure. More...

subroutine	h5dread_vl_f (dset_id, mem_type_id, buf, dims, len, hdferr, mem_space_id, file_space_id, xfer_prp)
	Reads variable-length data. F2003 API h5dread_f should be used instead. More...

subroutine	h5dwrite_vl_f (dset_id, mem_type_id, buf, dims, len, hdferr, mem_space_id, file_space_id, xfer_prp)
	Writes variable-length data. F2003 API h5dwrite_f should be used instead. More...

subroutine	h5dget_offset_f (dset_id, offset, hdferr)
	Returns dataset address in file. More...

subroutine	h5dget_space_f (dataset_id, dataspace_id, hdferr)
	Returns an identifier for a copy of the dataspace for a dataset. More...

subroutine	h5dget_space_async_f (dataset_id, dataspace_id, es_id, hdferr, file, func, line)
	Asynchronously returns an identifier for a copy of the dataspace for a dataset. More...

subroutine	h5dget_access_plist_f (dset_id, plist_id, hdferr)
	Returns a copy of the dataset creation property list. More...

subroutine	h5dvlen_reclaim_f (type_id, space_id, plist_id, buf, hdferr)
	Reclaims VL datatype memory buffers. More...

subroutine	h5dread_async_f (dset_id, mem_type_id, buf, es_id, hdferr, mem_space_id, file_space_id, xfer_prp, file, func, line)
	Asynchronously reads raw data from a dataset into a buffer. More...

subroutine	h5dwrite_async_f (dset_id, mem_type_id, buf, es_id, hdferr, mem_space_id, file_space_id, xfer_prp, file, func, line)
	Asynchronously writes raw data from a buffer to a dataset. More...

subroutine	h5dwrite_f (dset_id, mem_type_id, buf, hdferr, mem_space_id, file_space_id, xfer_prp)
	Writes raw data from a buffer to a dataset. More...

subroutine	h5dread_f (dset_id, mem_type_id, buf, hdferr, mem_space_id, file_space_id, xfer_prp)
	Reads raw data from a dataset into a buffer (Passes Pointer). More...

subroutine	h5dwrite_f___f90_version (dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, file_space_id, xfer_prp)
	There is no direct Fortran90 counterpart for the C function H5Dwrite. Instead, that functionality is provided by two Fortran90 subroutines: More...

subroutine	h5dread_f___f90_version (dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, file_space_id, xfer_prp)
	There is no direct Fortran90 counterpart for the C function H5Dread. Instead, that functionality is provided by two Fortran90 subroutines: More...

subroutine	h5dfill_f (fill_value, space_id, buf, hdferr)
	Fills dataspace elements with a fill value in a memory buffer. Only INTEGER, CHARACTER, REAL and DOUBLE PRECISION datatypes of the fillvalues and buffers are supported. Buffer and fillvalue are assumed to have the same datatype. Only one-dimesional buffers are supported. More...

subroutine	h5dfill_f (fill_value, fill_type_id, buf, buf_type_id, space_id, hdferr)
	Fills dataspace elements with a fill value in a memory buffer. More...

Variables
integer	h5d_compact_f
	H5D_COMPACT. More...

integer	h5d_contiguous_f
	H5D_CONTIGUOUS. More...

integer	h5d_chunked_f
	H5D_CHUNKED. More...

integer	h5d_alloc_time_error_f
	H5D_ALLOC_TIME_ERROR. More...

integer	h5d_alloc_time_default_f
	H5D_ALLOC_TIME_DEFAULT. More...

integer	h5d_alloc_time_early_f
	H5D_ALLOC_TIME_EARLY. More...

integer	h5d_alloc_time_late_f
	H5D_ALLOC_TIME_LATE. More...

integer	h5d_alloc_time_incr_f
	H5D_ALLOC_TIME_INCR. More...

integer	h5d_space_sts_error_f
	H5D_SPACE_STS_ERROR. More...

integer	h5d_space_sts_not_allocated_f
	H5D_SPACE_STS_NOT_ALLOCATED. More...

integer	h5d_space_sts_part_allocated_f
	H5D_SPACE_STS_PART_ALLOCATED. More...

integer	h5d_space_sts_allocated_f
	H5D_SPACE_STS_ALLOCATED. More...

integer	h5d_fill_time_error_f
	H5D_FILL_TIME_ERROR. More...

integer	h5d_fill_time_alloc_f
	H5D_FILL_TIME_ALLOC. More...

integer	h5d_fill_time_never_f
	H5D_FILL_TIME_NEVER. More...

integer	h5d_fill_value_error_f
	H5D_FILL_VALUE_ERROR. More...

integer	h5d_fill_value_undefined_f
	H5D_FILL_VALUE_UNDEFINED. More...

integer	h5d_fill_value_default_f
	H5D_FILL_VALUE_DEFAULT. More...

integer	h5d_fill_value_user_defined_f
	H5D_FILL_VALUE_USER_DEFINED. More...

integer(size_t)	h5d_chunk_cache_nslots_dflt_f
	H5D_CHUNK_CACHE_NSLOTS_DEFAULT. More...

integer(size_t)	h5d_chunk_cache_nbytes_dflt_f
	H5D_CHUNK_CACHE_NBYTES_DEFAULT. More...

integer	h5d_chunk_cache_w0_dflt_f
	H5D_CHUNK_CACHE_W0_DEFAULT. More...

integer	h5d_mpio_no_collective_f
	H5D_MPIO_NO_COLLECTIVE. More...

integer	h5d_mpio_chunk_independent_f
	H5D_MPIO_CHUNK_INDEPENDENT. More...

integer	h5d_mpio_chunk_collective_f
	H5D_MPIO_CHUNK_COLLECTIVE. More...

integer	h5d_mpio_chunk_mixed_f
	H5D_MPIO_CHUNK_MIXED. More...

integer	h5d_mpio_contig_collective_f
	H5D_MPIO_CONTIGUOUS_COLLECTIVE. More...

integer	h5d_vds_error_f
	H5D_VDS_ERROR. More...

integer	h5d_vds_first_missing_f
	H5D_VDS_FIRST_MISSING. More...

integer	h5d_vds_last_available_f
	H5D_VDS_LAST_AVAILABLE. More...

integer	h5d_virtual_f
	H5D_VIRTUAL. More...

integer	h5d_selection_io_mode_default_f
	H5D_SELECTION_IO_MODE_DEFAULT_F. More...

integer	h5d_selection_io_mode_off_f
	H5D_SELECTION_IO_MODE_OFF_F. More...

integer	h5d_selection_io_mode_on_f
	H5D_SELECTION_IO_MODE_ON_F. More...

Function/Subroutine Documentation

◆ h5dclose_async_f()

subroutine h5d::h5dclose_async_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously closes a dataset.

Parameters

dset_id	Dataset identifier
es_id

◆ h5dclose_f()

subroutine h5d::h5dclose_f	(	integer(hid_t), intent(in)	dset_id,
		integer, intent(out)	hdferr
	)

Closes a dataset.

Parameters

dset_id	Dataset identifier
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dclose()

◆ h5dcreate_anon_f()

subroutine h5d::h5dcreate_anon_f	(	integer(hid_t), intent(in)	loc_id,
		integer(hid_t), intent(in)	type_id,
		integer(hid_t), intent(in)	space_id,
		integer(hid_t), intent(out)	dset_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	dcpl_id,
		integer(hid_t), intent(in), optional	dapl_id
	)

Creates a dataset in a file without linking it into the file structure.

Parameters

loc_id	Identifier of the file or group within which to create the dataset.
type_id	Identifier of the datatype to use when creating the dataset.
space_id	Identifier of the dataspace to use when creating the dataset.
dset_id	Dataset identifier.
hdferr	Returns 0 if successful and -1 if it fails.
dcpl_id	Dataset creation property list identifier.
dapl_id	Dataset access property list identifier.

See C API: H5Dcreate_anon()

◆ h5dcreate_async_f()

subroutine h5d::h5dcreate_async_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(in)	type_id,
		integer(hid_t), intent(in)	space_id,
		integer(hid_t), intent(out)	dset_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	dcpl_id,
		integer(hid_t), intent(in), optional	lcpl_id,
		integer(hid_t), intent(in), optional	dapl_id,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously creates a dataset at the specified location.

Parameters

loc_id	File or group identifier
name	Dataset name
type_id	Dataset datatype identifier
space_id	Dataset dataspace identifier
dset_id	Dataset identifier
es_id

◆ h5dcreate_f()

subroutine h5d::h5dcreate_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(in)	type_id,
		integer(hid_t), intent(in)	space_id,
		integer(hid_t), intent(out)	dset_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	dcpl_id,
		integer(hid_t), intent(in), optional	lcpl_id,
		integer(hid_t), intent(in), optional	dapl_id
	)

Creates a dataset at the specified location.

Parameters

loc_id	File or group identifier
name	Dataset name
type_id	Dataset datatype identifier
space_id	Dataset dataspace identifier
dset_id	Dataset identifier
hdferr	Returns 0 if successful and -1 if it fails.
dcpl_id	Dataset creation property list
lcpl_id	Link creation property list
dapl_id	Dataset access property list

See C API: H5Dcreate2()

◆ h5dfill_f() [1/2]

subroutine h5d::h5dfill_f	(	type(c_ptr)	fill_value,
		integer(hid_t), intent(in)	fill_type_id,
		type(c_ptr)	buf,
		integer(hid_t), intent(in)	buf_type_id,
		integer(hid_t), intent(in)	space_id,
			hdferr
	)

Fills dataspace elements with a fill value in a memory buffer.

Attention: The preferred API, Fortran 2003 version.

Parameters

fill_value	Pointer to the fill value to be used.
fill_type_id	Fill value datatype identifier,
buf	Pointer to the memory buffer containing the selection to be filled.
buf_type_id	Datatype of dataspace elements to be filled.
space_id	Dataspace identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dfill()

◆ h5dfill_f() [2/2]

subroutine h5d::h5dfill_f	(	type(type), intent(in)	fill_value,
		integer(hid_t), intent(in)	space_id,
		type(type), dimension(*), intent(out)	buf,
		integer, intent(out)	hdferr
	)

Fills dataspace elements with a fill value in a memory buffer. Only INTEGER, CHARACTER, REAL and DOUBLE PRECISION datatypes of the fillvalues and buffers are supported. Buffer and fillvalue are assumed to have the same datatype. Only one-dimesional buffers are supported.

Attention: Obsolete API, use the Fortran 2003 version instead.

Parameters

fill_value	Fill value.
space_id	Identifier of the memory datatype.
buf	Buffer to receive data read from file.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dfill()

◆ h5dget_access_plist_f()

subroutine h5d::h5dget_access_plist_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(out)	plist_id,
		integer, intent(out)	hdferr
	)

Returns a copy of the dataset creation property list.

Parameters

dset_id	Dataset identifier.
plist_id	Dataset access property list identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_access_plist()

◆ h5dget_create_plist_f()

subroutine h5d::h5dget_create_plist_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hid_t), intent(out)	plist_id,
		integer, intent(out)	hdferr
	)

Returns an identifier for a copy of the dataset creation property list for a dataset.

Parameters

dataset_id	Dataset identifier
plist_id	Creation property list identifier
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_create_plist()

◆ h5dget_offset_f()

subroutine h5d::h5dget_offset_f	(	integer(hid_t), intent(in)	dset_id,
		integer(haddr_t), intent(out)	offset,
		integer, intent(out)	hdferr
	)

Returns dataset address in file.

Parameters

dset_id	Dataset identifier.
offset	The offset in bytes.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_offset()

◆ h5dget_space_async_f()

subroutine h5d::h5dget_space_async_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hid_t), intent(out)	dataspace_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously returns an identifier for a copy of the dataspace for a dataset.

Parameters

dataset_id	Dataset identifier.
dataspace_id	Dataspace identifier.
es_id

◆ h5dget_space_f()

subroutine h5d::h5dget_space_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hid_t), intent(out)	dataspace_id,
		integer, intent(out)	hdferr
	)

Returns an identifier for a copy of the dataspace for a dataset.

Parameters

dataset_id	Dataset identifier.
dataspace_id	Dataspace identifier.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_space()

◆ h5dget_space_status_f()

subroutine h5d::h5dget_space_status_f	(	integer(hid_t), intent(in)	dset_id,
		integer, intent(out)	flag,
		integer, intent(out)	hdferr
	)

Returns the status of data space allocation.

Parameters

dset_id	Dataset identifier
flag	Status; may have one of the following values: H5D_SPACE_STS_ERROR_F H5D_SPACE_STS_NOT_ALLOCATED_F H5D_SPACE_STS_PART_ALLOCATED_F H5D_SPACE_STS_ALLOCATED_F
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_space_status()

◆ h5dget_storage_size_f()

subroutine h5d::h5dget_storage_size_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hsize_t), intent(out)	size,
		integer, intent(out)	hdferr
	)

Returns the amount of storage requires by a dataset.

Parameters

dataset_id	Dataset identifier
size	Datastorage size
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_storage_size()

◆ h5dget_type_f()

subroutine h5d::h5dget_type_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hid_t), intent(out)	datatype_id,
		integer, intent(out)	hdferr
	)

Returns an identifier for a copy of the datatype for a dataset.

Parameters

dataset_id	Dataset identifier
datatype_id	Dataspace identifier
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dget_type()

◆ h5dopen_async_f()

subroutine h5d::h5dopen_async_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	dset_id,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	dapl_id,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously opens an existing dataset.

Parameters

loc_id	File or group identifier
name	Dataset name
dset_id	Dataset identifier
es_id

◆ h5dopen_f()

subroutine h5d::h5dopen_f	(	integer(hid_t), intent(in)	loc_id,
		character(len=*), intent(in)	name,
		integer(hid_t), intent(out)	dset_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	dapl_id
	)

Opens an existing dataset.

Parameters

loc_id	File or group identifier
name	Dataset name
dset_id	Dataset identifier
hdferr	Returns 0 if successful and -1 if it fails.
dapl_id	Dataset access property list

See C API: H5Dopen2()

◆ h5dread_async_f()

subroutine h5d::h5dread_async_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(c_ptr), intent(inout)	buf,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously reads raw data from a dataset into a buffer.

Parameters

dset_id	Identifier of the dataset read from.
mem_type_id	Identifier of the memory datatype.
buf	Buffer to receive data read from file.
es_id

◆ h5dread_f()

subroutine h5d::h5dread_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(c_ptr), intent(inout)	buf,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

Reads raw data from a dataset into a buffer (Passes Pointer).

Attention: The preferred API, Fortran 2003 version.

Parameters

dset_id	Identifier of the dataset read from.
mem_type_id	Identifier of the memory datatype.
buf	Buffer to receive data read from file.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Identifier of the memory dataspace.
file_space_id	Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F)
xfer_prp	Identifier of a transfer property list for this I/O operation.

See C API: H5Dread()

◆ h5dread_f___f90_version()

subroutine h5d::h5dread_f___f90_version	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(type), intent(inout)	buf,
		integer(hsize_t), dimension(*), intent(in)	dims,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

There is no direct Fortran90 counterpart for the C function H5Dread. Instead, that functionality is provided by two Fortran90 subroutines:

h5dread_f Purpose: Reads data other than variable-length data, uses DIMENSION argument and buf is not a pointer.
h5dread_vl_f Purpose: Reads variable-length data.

Attention: Obsolete API, use the Fortran 2003 version instead.

Parameters

dset_id	Identifier of the dataset read from.
mem_type_id	Identifier of the memory datatype.
buf	Buffer to receive data read from file, may be a scalar or an array.
dims	Array to hold corresponding dimension sizes of data buffer buf. dim(k) has value of the k-th. dimension of buffer buf. Values are ignored if buf is a scalar.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Identifier of the memory dataspace. (Default: H5S_ALL_F)
file_space_id	Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F)
xfer_prp	Identifier of a transfer property list for this I/O operation. (Default: H5P_DEFAULT_F)

◆ h5dread_vl_f()

subroutine h5d::h5dread_vl_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(type), dimension(dims(1),dims(2)), intent(inout)	buf,
		integer(hsize_t), dimension(2), intent(in)	dims,
		integer(size_t), dimension(*), intent(inout)	len,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

Reads variable-length data. F2003 API h5dread_f should be used instead.

Parameters

dset_id	Dataset identifier.
mem_type_id	Memory datatype identifier.
buf	Data buffer; may be a scalar or an array, TYPE(TYPE) must be one of the following: INTEGER REAL CHARACTER
dims	Array to hold corresponding dimension sizes of data buffer buf, dim(k) has value of the k-th dimension of buffer buf. Values are ignored if buf is a scalar.
len	Array to store length of each element.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Memory dataspace identifier, default value is H5S_ALL_F.
file_space_id	File dataspace identifier, default value is H5S_ALL_F.
xfer_prp	Transfer property list identifier, default value is H5P_DEFAULT_F.

◆ h5dset_extent_async_f()

subroutine h5d::h5dset_extent_async_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hsize_t), dimension(*), intent(in)	fsize,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously extends a dataset with unlimited dimension.

Parameters

dataset_id	Dataset identifier
fsize	Array containing the new magnitude of each dimension
es_id

◆ h5dset_extent_f()

subroutine h5d::h5dset_extent_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hsize_t), dimension(*), intent(in)	fsize,
		integer, intent(out)	hdferr
	)

Extends a dataset with unlimited dimension.

Parameters

dataset_id	Dataset identifier
fsize	Array containing the new magnitude of each dimension
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dset_extent()

◆ h5dvlen_get_max_len_f()

subroutine h5d::h5dvlen_get_max_len_f	(	integer(hid_t), intent(in)	dataset_id,
		integer(hid_t), intent(in)	type_id,
		integer(hid_t), intent(in)	space_id,
		integer(size_t), intent(out)	len,
		integer, intent(out)	hdferr
	)

Returns maximum length of the VL array elements.

Parameters

dataset_id	Dataset identifier
type_id	Datatype identifier
space_id	Dataspace identifier
len	Buffer size
hdferr	Returns 0 if successful and -1 if it fails.

◆ h5dvlen_reclaim_f()

subroutine h5d::h5dvlen_reclaim_f	(	integer(hid_t), intent(in)	type_id,
		integer(hid_t), intent(in)	space_id,
		integer(hid_t), intent(in)	plist_id,
		type(c_ptr), intent(inout)	buf,
		integer, intent(out)	hdferr
	)

Reclaims VL datatype memory buffers.

Parameters

type_id	Identifier of the datatype.
space_id	Identifier of the dataspace.
plist_id	Identifier of the property list used to create the buffer.
buf	Pointer to the buffer to be reclaimed.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Dvlen_reclaim()

◆ h5dwrite_async_f()

subroutine h5d::h5dwrite_async_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(c_ptr), intent(in)	buf,
		integer(hid_t), intent(in)	es_id,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp,
		type(c_ptr), optional	file,
		type(c_ptr), optional	func,
		integer, intent(in), optional	line
	)

Asynchronously writes raw data from a buffer to a dataset.

Parameters

dset_id	Identifier of the dataset to write to.
mem_type_id	Identifier of the memory datatype.
buf	Buffer with data to be written to the file.
es_id

◆ h5dwrite_f()

subroutine h5d::h5dwrite_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(c_ptr), intent(in)	buf,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

Writes raw data from a buffer to a dataset.

Attention: The preferred API, Fortran 2003 version.

Parameters

dset_id	Identifier of the dataset to write to.
mem_type_id	Identifier of the memory datatype.
buf	Buffer with data to be written to the file.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Identifier of the memory dataspace.
file_space_id	Identifier of the dataset's dataspace in the file.
xfer_prp	Identifier of a transfer property list for this I/O operation.

See C API: H5Dwrite()

◆ h5dwrite_f___f90_version()

subroutine h5d::h5dwrite_f___f90_version	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(type), intent(in)	buf,
		intent(in)	dims,
			hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

There is no direct Fortran90 counterpart for the C function H5Dwrite. Instead, that functionality is provided by two Fortran90 subroutines:

h5dwrite_f Purpose: Writes data other than variable-length data.
h5dwrite_vl_f Purpose: Writes variable-length data.

Attention: Obsolete API, use the Fortran 2003 version instead.

Parameters

dset_id	Identifier of the dataset to write to.
mem_type_id	Identifier of the memory datatype.
buf	Data buffer; may be a scalar or an array.
dims	Array to hold corresponding dimension sizes of data buffer buf; dim(k) has value. of the k-th dimension of buffer buf; values are ignored if buf is a scalar.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Identifier of the memory dataspace. Default value is H5S_ALL_F.
file_space_id	Identifier of the dataset's dataspace in the file. Default value is H5S_ALL_F.
xfer_prp	Identifier of a transfer property list for this I/O operation. Default value is H5P_DEFAULT_F.

◆ h5dwrite_vl_f()

subroutine h5d::h5dwrite_vl_f	(	integer(hid_t), intent(in)	dset_id,
		integer(hid_t), intent(in)	mem_type_id,
		type(type), dimension(dims(1),dims(2)), intent(in)	buf,
		integer(hsize_t), dimension(2), intent(in)	dims,
		integer(size_t), dimension(*), intent(in)	len,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	mem_space_id,
		integer(hid_t), intent(in), optional	file_space_id,
		integer(hid_t), intent(in), optional	xfer_prp
	)

Writes variable-length data. F2003 API h5dwrite_f should be used instead.

Parameters

dset_id	Dataset identifier.
mem_type_id	Memory datatype identifier.
buf	Data buffer; may be a scalar or an array, TYPE(TYPE) must be one of the following: INTEGER REAL CHARACTER
dims	Array to hold corresponding dimension sizes of data buffer buf, dim(k) has value of the k-th dimension of buffer buf. Values are ignored if buf is a scalar.
len	Array to store length of each element.
hdferr	Returns 0 if successful and -1 if it fails.
mem_space_id	Memory dataspace identifier, default value is H5S_ALL_F.
file_space_id	File dataspace identifier, default value is H5S_ALL_F.
xfer_prp	Transfer property list identifier, default value is H5P_DEFAULT_F.

Variable Documentation

◆ h5d_alloc_time_default_f

integer h5d_alloc_time_default_f

H5D_ALLOC_TIME_DEFAULT.

◆ h5d_alloc_time_early_f

integer h5d_alloc_time_early_f

H5D_ALLOC_TIME_EARLY.

◆ h5d_alloc_time_error_f

integer h5d_alloc_time_error_f

H5D_ALLOC_TIME_ERROR.

◆ h5d_alloc_time_incr_f

integer h5d_alloc_time_incr_f

H5D_ALLOC_TIME_INCR.

◆ h5d_alloc_time_late_f

integer h5d_alloc_time_late_f

H5D_ALLOC_TIME_LATE.

◆ h5d_chunk_cache_nbytes_dflt_f

integer(size_t) h5d_chunk_cache_nbytes_dflt_f

H5D_CHUNK_CACHE_NBYTES_DEFAULT.

◆ h5d_chunk_cache_nslots_dflt_f

integer(size_t) h5d_chunk_cache_nslots_dflt_f

H5D_CHUNK_CACHE_NSLOTS_DEFAULT.

◆ h5d_chunk_cache_w0_dflt_f

integer h5d_chunk_cache_w0_dflt_f

H5D_CHUNK_CACHE_W0_DEFAULT.

◆ h5d_chunked_f

integer h5d_chunked_f

H5D_CHUNKED.

◆ h5d_compact_f

integer h5d_compact_f

H5D_COMPACT.

◆ h5d_contiguous_f

integer h5d_contiguous_f

H5D_CONTIGUOUS.

◆ h5d_fill_time_alloc_f

integer h5d_fill_time_alloc_f

H5D_FILL_TIME_ALLOC.

◆ h5d_fill_time_error_f

integer h5d_fill_time_error_f

H5D_FILL_TIME_ERROR.

◆ h5d_fill_time_never_f

integer h5d_fill_time_never_f

H5D_FILL_TIME_NEVER.

◆ h5d_fill_value_default_f

integer h5d_fill_value_default_f

H5D_FILL_VALUE_DEFAULT.

◆ h5d_fill_value_error_f

integer h5d_fill_value_error_f

H5D_FILL_VALUE_ERROR.

◆ h5d_fill_value_undefined_f

integer h5d_fill_value_undefined_f

H5D_FILL_VALUE_UNDEFINED.

◆ h5d_fill_value_user_defined_f

integer h5d_fill_value_user_defined_f

H5D_FILL_VALUE_USER_DEFINED.

◆ h5d_mpio_chunk_collective_f

integer h5d_mpio_chunk_collective_f

H5D_MPIO_CHUNK_COLLECTIVE.

◆ h5d_mpio_chunk_independent_f

integer h5d_mpio_chunk_independent_f

H5D_MPIO_CHUNK_INDEPENDENT.

◆ h5d_mpio_chunk_mixed_f

integer h5d_mpio_chunk_mixed_f

H5D_MPIO_CHUNK_MIXED.

◆ h5d_mpio_contig_collective_f

integer h5d_mpio_contig_collective_f

H5D_MPIO_CONTIGUOUS_COLLECTIVE.

◆ h5d_mpio_no_collective_f

integer h5d_mpio_no_collective_f

H5D_MPIO_NO_COLLECTIVE.

◆ h5d_selection_io_mode_default_f

integer h5d_selection_io_mode_default_f

H5D_SELECTION_IO_MODE_DEFAULT_F.

◆ h5d_selection_io_mode_off_f

integer h5d_selection_io_mode_off_f

H5D_SELECTION_IO_MODE_OFF_F.

◆ h5d_selection_io_mode_on_f

integer h5d_selection_io_mode_on_f

H5D_SELECTION_IO_MODE_ON_F.

◆ h5d_space_sts_allocated_f

integer h5d_space_sts_allocated_f

H5D_SPACE_STS_ALLOCATED.

◆ h5d_space_sts_error_f

integer h5d_space_sts_error_f

H5D_SPACE_STS_ERROR.

◆ h5d_space_sts_not_allocated_f

integer h5d_space_sts_not_allocated_f

H5D_SPACE_STS_NOT_ALLOCATED.

◆ h5d_space_sts_part_allocated_f

integer h5d_space_sts_part_allocated_f

H5D_SPACE_STS_PART_ALLOCATED.

◆ h5d_vds_error_f

integer h5d_vds_error_f

H5D_VDS_ERROR.

◆ h5d_vds_first_missing_f

integer h5d_vds_first_missing_f

H5D_VDS_FIRST_MISSING.

◆ h5d_vds_last_available_f

integer h5d_vds_last_available_f

H5D_VDS_LAST_AVAILABLE.

◆ h5d_virtual_f

integer h5d_virtual_f

H5D_VIRTUAL.

Detailed Description

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ h5dclose_async_f()

◆ h5dclose_f()

◆ h5dcreate_anon_f()

◆ h5dcreate_async_f()

◆ h5dcreate_f()

◆ h5dfill_f() [1/2]

◆ h5dfill_f() [2/2]

◆ h5dget_access_plist_f()

◆ h5dget_create_plist_f()

◆ h5dget_offset_f()

◆ h5dget_space_async_f()

◆ h5dget_space_f()

◆ h5dget_space_status_f()

◆ h5dget_storage_size_f()

◆ h5dget_type_f()

◆ h5dopen_async_f()

◆ h5dopen_f()

◆ h5dread_async_f()

◆ h5dread_f()

◆ h5dread_f___f90_version()

◆ h5dread_vl_f()

◆ h5dset_extent_async_f()

◆ h5dset_extent_f()

◆ h5dvlen_get_max_len_f()

◆ h5dvlen_reclaim_f()

◆ h5dwrite_async_f()

◆ h5dwrite_f()

◆ h5dwrite_f___f90_version()

◆ h5dwrite_vl_f()

Variable Documentation

◆ h5d_alloc_time_default_f

◆ h5d_alloc_time_early_f

◆ h5d_alloc_time_error_f

◆ h5d_alloc_time_incr_f

◆ h5d_alloc_time_late_f

◆ h5d_chunk_cache_nbytes_dflt_f

◆ h5d_chunk_cache_nslots_dflt_f

◆ h5d_chunk_cache_w0_dflt_f

◆ h5d_chunked_f

◆ h5d_compact_f

◆ h5d_contiguous_f

◆ h5d_fill_time_alloc_f

◆ h5d_fill_time_error_f

◆ h5d_fill_time_never_f

◆ h5d_fill_value_default_f

◆ h5d_fill_value_error_f

◆ h5d_fill_value_undefined_f

◆ h5d_fill_value_user_defined_f

◆ h5d_mpio_chunk_collective_f

◆ h5d_mpio_chunk_independent_f

◆ h5d_mpio_chunk_mixed_f

◆ h5d_mpio_contig_collective_f

◆ h5d_mpio_no_collective_f

◆ h5d_selection_io_mode_default_f

◆ h5d_selection_io_mode_off_f

◆ h5d_selection_io_mode_on_f

◆ h5d_space_sts_allocated_f

◆ h5d_space_sts_error_f

◆ h5d_space_sts_not_allocated_f

◆ h5d_space_sts_part_allocated_f

◆ h5d_vds_error_f

◆ h5d_vds_first_missing_f

◆ h5d_vds_last_available_f

◆ h5d_virtual_f