Class H5D

Inheritance

System.Object

H5D

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5D : object

Fields

| Improve this Doc View Source

CACHE_NBYTES_DEFAULT

Declaration

public readonly System.IntPtr CACHE_NBYTES_DEFAULT

Field Value

Type	Description
System.IntPtr

| Improve this Doc View Source

CACHE_NSLOTS_DEFAULT

Declaration

public readonly System.IntPtr CACHE_NSLOTS_DEFAULT

Field Value

Type	Description
System.IntPtr

| Improve this Doc View Source

CACHE_W0_DEFAULT

Declaration

public const float CACHE_W0_DEFAULT = null

Field Value

Type	Description
System.Single

| Improve this Doc View Source

DONT_FILTER_PARTIAL_CHUNKS

Bit flags for the H5Pset_chunk_opts() and H5Pget_chunk_opts()

Declaration

public const uint DONT_FILTER_PARTIAL_CHUNKS = null

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

XFER_DIRECT_CHUNK_WRITE_DATASIZE_NAME

Declaration

public const string XFER_DIRECT_CHUNK_WRITE_DATASIZE_NAME = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

XFER_DIRECT_CHUNK_WRITE_FILTERS_NAME

Declaration

public const string XFER_DIRECT_CHUNK_WRITE_FILTERS_NAME = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

XFER_DIRECT_CHUNK_WRITE_FLAG_NAME

Declaration

public const string XFER_DIRECT_CHUNK_WRITE_FLAG_NAME = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

XFER_DIRECT_CHUNK_WRITE_OFFSET_NAME

Declaration

public const string XFER_DIRECT_CHUNK_WRITE_OFFSET_NAME = null

Field Value

Type	Description
System.String

Methods

close(System.Int64)

Closes the specified dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Close

Declaration

public static System.Int32 close(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to close access to.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

create(System.Int64, Byte[], System.Int64, System.Int64, System.Int64, System.Int64, System.Int64)

Creates a new dataset and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Create2

Declaration

public static System.Int64 create(System.Int64 loc_id, byte[] name, System.Int64 type_id, System.Int64 space_id, System.Int64 lcpl_id = null, System.Int64 dcpl_id = null, System.Int64 dapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Location identifier
System.Byte[]	name	Dataset name
System.Int64	type_id	Datatype identifier
System.Int64	space_id	Dataspace identifier
System.Int64	lcpl_id	Link creation property list
System.Int64	dcpl_id	Dataset creation property list
System.Int64	dapl_id	Dataset access property list

Returns

Type	Description
System.Int64	Returns a dataset identifier if successful; otherwise returns a negative value.

create(System.Int64, String, System.Int64, System.Int64, System.Int64, System.Int64, System.Int64)

Creates a new dataset and links it into the file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Create2

Declaration

public static System.Int64 create(System.Int64 loc_id, string name, System.Int64 type_id, System.Int64 space_id, System.Int64 lcpl_id = null, System.Int64 dcpl_id = null, System.Int64 dapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Location identifier
System.String	name	Dataset name
System.Int64	type_id	Datatype identifier
System.Int64	space_id	Dataspace identifier
System.Int64	lcpl_id	Link creation property list
System.Int64	dcpl_id	Dataset creation property list
System.Int64	dapl_id	Dataset access property list

Returns

Type	Description
System.Int64	Returns a dataset identifier if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

create_anon(System.Int64, System.Int64, System.Int64, System.Int64, System.Int64)

Creates a dataset in a file without linking it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-CreateAnon

Declaration

public static System.Int64 create_anon(System.Int64 file_id, System.Int64 type_id, System.Int64 space_id, System.Int64 dcpl_id = null, System.Int64 dapl_id = null)

Parameters

Type	Name	Description
System.Int64	file_id	Identifier of the file or group within which to create the dataset.
System.Int64	type_id	Identifier of the datatype to use when creating the dataset.
System.Int64	space_id	Identifier of the dataspace to use when creating the dataset.
System.Int64	dcpl_id	Dataset creation property list identifier.
System.Int64	dapl_id	Dataset access property list identifier.

Returns

Type	Description
System.Int64	Returns a dataset identifier if successful; otherwise returns a negative value.

fill(IntPtr, System.Int64, IntPtr, System.Int64, System.Int64)

Fills dataspace elements with a fill value in a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Fill

Declaration

public static System.Int32 fill(IntPtr fill, System.Int64 fill_type, IntPtr buf, System.Int64 buf_type, System.Int64 space)

Parameters

Type	Name	Description
IntPtr	fill	Pointer to the fill value to be used.
System.Int64	fill_type	Fill value datatype identifier.
IntPtr	buf	Pointer to the memory buffer containing the selection to be filled.
System.Int64	buf_type	Datatype of dataspace elements to be filled.
System.Int64	space	Dataspace describing memory buffer and containing the selection to be filled.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

flush(System.Int64)

Flushes all buffers associated with a dataset to disk. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Dflush.htm

Declaration

public static System.Int32 flush(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to be flushed.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

format_convert(System.Int64)

Declaration

public static System.Int32 format_convert(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to be flushed.

Returns

Type	Description
System.Int32

gather(System.Int64, IntPtr, System.Int64, System.IntPtr, IntPtr, H5D.gather_func_t, IntPtr)

Gathers data from a selection within a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Gather

Declaration

public static System.Int32 gather(System.Int64 src_space_id, IntPtr src_buf, System.Int64 type_id, System.IntPtr dst_buf_size, IntPtr dst_buf, H5D.gather_func_t op, IntPtr op_data)

Parameters

Type	Name	Description
System.Int64	src_space_id	Identifier for the dataspace describing both the dimensions of the source buffer and the selection within the source buffer to gather data from.
IntPtr	src_buf	Source buffer which the data will be gathered from.
System.Int64	type_id	Identifier for the datatype describing the data in both the source and definition buffers. This is only used to calculate the element size.
System.IntPtr	dst_buf_size	Size in bytes of `dst_buf`.
IntPtr	dst_buf	Destination buffer where the gathered data will be placed.
H5D.gather_func_t	op	Callback function which handles the gathered data. Optional if `dst_buf` is large enough to hold all of the gathered data; required otherwise.
IntPtr	op_data	User-defined pointer to data required by `op`.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_access_plist(System.Int64)

Returns the dataset access property list associated with a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetAccessPlist

Declaration

public static System.Int64 get_access_plist(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to get access property list of.

Returns

Type	Description
System.Int64	Returns a dataset access property list identifier if Ssuccessful; otherwise returns a negative value.

get_chunk_index_type(System.Int64, ref H5D.chunk_index_t)

Declaration

public static System.Int32 get_chunk_index_type(System.Int64 did, ref H5D.chunk_index_t idx_type)

Parameters

Type	Name	Description
System.Int64	did
H5D.chunk_index_t	idx_type

Returns

Type	Description
System.Int32

get_chunk_info(System.Int64, System.Int64, System.UInt64, System.UInt64*, ref System.UInt32, ref System.UInt64, ref System.UInt64)

Retrieves information about a chunk specified by the chunk index.

Declaration

public static System.Int32 get_chunk_info(System.Int64 dset_id, System.Int64 fspace_id, System.UInt64 index, System.UInt64*offset, ref System.UInt32 filter_mask, ref System.UInt64 addr, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.Int64	fspace_id	File dataspace selection identifier.
System.UInt64	index	Chunk index in the selection.
System.UInt64*	offset	Pointer to a one-dimensional array with a size equal to the dataset’s rank.
System.UInt32	filter_mask	Filter mask that indicates which filters were used with the chunk when written.
System.UInt64	addr	Chunk address in the file.
System.UInt64	size	Chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_info(System.Int64, System.Int64, System.UInt64, System.UInt64[], ref System.UInt32, ref System.UInt64, ref System.UInt64)

Retrieves information about a chunk specified by the chunk index.

Declaration

public static System.Int32 get_chunk_info(System.Int64 dset_id, System.Int64 fspace_id, System.UInt64 index, System.UInt64[] offset, ref System.UInt32 filter_mask, ref System.UInt64 addr, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.Int64	fspace_id	File dataspace selection identifier.
System.UInt64	index	Chunk index in the selection.
System.UInt64[]	offset	Reference to a one-dimensional array with a size equal to the dataset’s rank.
System.UInt32	filter_mask	Filter mask that indicates which filters were used with the chunk when written.
System.UInt64	addr	Chunk address in the file.
System.UInt64	size	Chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_info_by_coord(System.Int64, System.UInt64*, ref System.UInt32, ref System.UInt64, ref System.UInt64)

Retrieves information about a chunk specified by its coordinates

Declaration

public static System.Int32 get_chunk_info_by_coord(System.Int64 dset_id, System.UInt64*offset, ref System.UInt32 filter_mask, ref System.UInt64 addr, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.UInt64*	offset	Pointer to a one-dimensional array with a size equal to the dataset’s rank.
System.UInt32	filter_mask	Filter mask that indicates which filters were used with the chunk when written.
System.UInt64	addr	Chunk address in the file.
System.UInt64	size	Chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_info_by_coord(System.Int64, System.UInt64[], ref System.UInt32, ref System.UInt64, ref System.UInt64)

Retrieves information about a chunk specified by its coordinates

Declaration

public static System.Int32 get_chunk_info_by_coord(System.Int64 dset_id, System.UInt64[] offset, ref System.UInt32 filter_mask, ref System.UInt64 addr, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.UInt64[]	offset	Reference to a one-dimensional array with a size equal to the dataset’s rank.
System.UInt32	filter_mask	Filter mask that indicates which filters were used with the chunk when written.
System.UInt64	addr	Chunk address in the file.
System.UInt64	size	Chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_storage_size(System.Int64, System.UInt64*, ref System.UInt64)

Determines the storage size (in bytes) of a chunk.

Declaration

public static System.Int32 get_chunk_storage_size(System.Int64 dset_id, System.UInt64*offset, ref System.UInt64 chunk_bytes)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.
System.UInt64*	offset	Logical position of the chunk’s first element in the dataspace
System.UInt64	chunk_bytes	The chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_chunk_storage_size(System.Int64, System.UInt64[], ref System.UInt64)

Determines the storage size (in bytes) of a chunk.

Declaration

public static System.Int32 get_chunk_storage_size(System.Int64 dset_id, System.UInt64[] offset, ref System.UInt64 chunk_bytes)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.
System.UInt64[]	offset	Logical position of the chunk’s first element in the dataspace
System.UInt64	chunk_bytes	The chunk size in bytes.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_create_plist(System.Int64)

Returns an identifier for a copy of the dataset creation property list for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetCreatePlist

Declaration

public static System.Int64 get_create_plist(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.

Returns

Type	Description
System.Int64	Returns a dataset creation property list identifier if successful; otherwise returns a negative value.

get_num_chunks(System.Int64, System.Int64, ref System.UInt64)

Retrieves number of chunks that have nonempty intersection with a specified selection. See https://portal.hdfgroup.org/display/HDF5/H5D_GET_NUM_CHUNKS

Declaration

public static System.Int64 get_num_chunks(System.Int64 dset_id, System.Int64 fspace_id, ref System.UInt64 nchunks)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.Int64	fspace_id	File dataspace selection identifier.
System.UInt64	nchunks	Number of chunks in the selection.

Returns

Type	Description
System.Int64	Returns a non-negative value if successful; otherwise returns a negative value.

get_offset(System.Int64)

Returns dataset address in file. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetOffset

Declaration

public static System.UInt64 get_offset(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.

Returns

Type	Description
System.UInt64	Returns the offset in bytes; otherwise returns `HADDR_UNDEF` , a negative value.

get_space(System.Int64)

Returns an identifier for a copy of the dataspace for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetSpace

Declaration

public static System.Int64 get_space(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.

Returns

Type	Description
System.Int64	Returns a dataspace identifier if successful; otherwise returns a negative value.

get_space_status(System.Int64, ref H5D.space_status_t)

Determines whether space has been allocated for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetSpaceStatus

Declaration

public static System.Int32 get_space_status(System.Int64 dset_id, ref H5D.space_status_t allocation)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.
H5D.space_status_t	allocation	Space allocation status.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

get_storage_size(System.Int64)

Returns the amount of storage allocated for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetStorageSize

Declaration

public static System.UInt64 get_storage_size(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.

Returns

Type	Description
System.UInt64	Returns the amount of storage space, in bytes, allocated for the dataset, not counting metadata; otherwise returns 0 (zero).

get_type(System.Int64)

Returns an identifier for a copy of the datatype for a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-GetType

Declaration

public static System.Int64 get_type(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to query.

Returns

Type	Description
System.Int64	Returns a datatype identifier if successful; otherwise returns a negative value.

iterate(IntPtr, System.Int64, System.Int64, H5D.operator_t, IntPtr)

Iterates over all selected elements in a dataspace. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Iterate

Declaration

public static System.Int32 iterate(IntPtr buf, System.Int64 type_id, System.Int64 space_id, H5D.operator_t op, IntPtr op_data)

Parameters

Type	Name	Description
IntPtr	buf	Pointer to the buffer in memory containing the elements to iterate over
System.Int64	type_id	Datatype identifier for the elements stored in `buf`
System.Int64	space_id	Dataspace identifier for `buf`
H5D.operator_t	op	Function pointer to the routine to be called for each element in buf iterated over
IntPtr	op_data	Pointer to any user-defined data associated with the operation

Returns

Type	Description
System.Int32	Returns the return value of the last operator if it was non-zero, or zero if all elements have been processed. Otherwise returns a negative value.

open(System.Int64, Byte[], System.Int64)

Opens an existing dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Open2

Declaration

public static System.Int64 open(System.Int64 file_id, byte[] name, System.Int64 dapl_id = null)

Parameters

Type	Name	Description
System.Int64	file_id	Location identifier
System.Byte[]	name	Dataset name
System.Int64	dapl_id	Dataset access property list

Returns

Type	Description
System.Int64	Returns a dataset identifier if successful; otherwise returns a negative value.

open(System.Int64, String, System.Int64)

Opens an existing dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Open2

Declaration

public static System.Int64 open(System.Int64 file_id, string name, System.Int64 dapl_id = null)

Parameters

Type	Name	Description
System.Int64	file_id	Location identifier
System.String	name	Dataset name
System.Int64	dapl_id	Dataset access property list

Returns

Type	Description
System.Int64	Returns a dataset identifier if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

read(System.Int64, System.Int64, System.Int64, System.Int64, System.Int64, IntPtr)

Reads raw data from a dataset into a buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Read

Declaration

public static System.Int32 read(System.Int64 dset_id, System.Int64 mem_type_id, System.Int64 mem_space_id, System.Int64 file_space_id, System.Int64 plist_id, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset read from.
System.Int64	mem_type_id	Identifier of the memory datatype.
System.Int64	mem_space_id	Identifier of the memory dataspace.
System.Int64	file_space_id	Identifier of the dataset's dataspace in the file.
System.Int64	plist_id	Identifier of a transfer property list for this I/O operation.
IntPtr	buf	Buffer to receive data read from file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

read_chunk(System.Int64, System.Int64, ref System.UInt64, ref System.UInt32, IntPtr)

Reads a raw data chunk directly from a dataset in a file into a buffer. See https://support.hdfgroup.org/HDF5/doc/HL/RM_HDF5Optimized.html#H5DOread_chunk

Declaration

public static System.Int32 read_chunk(System.Int64 dset_id, System.Int64 dxpl_id, ref System.UInt64 offset, ref System.UInt32 filter_mask, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier for the dataset to be read
System.Int64	dxpl_id	Transfer property list identifier for this I/O operation
System.UInt64	offset	Logical position of the chunk’s first element in the dataspace
System.UInt32	filter_mask	Mask for identifying the filters used with the chunk
IntPtr	buf	Buffer containing the chunk read from the dataset

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

refresh(System.Int64)

Refreshes all buffers associated with a dataset. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Drefresh.htm

Declaration

public static System.Int32 refresh(System.Int64 dset_id)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to be refreshed.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

scatter(H5D.scatter_func_t, IntPtr, System.Int64, System.Int64, IntPtr)

Scatters data into a selection within a memory buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Scatter

Declaration

public static System.Int32 scatter(H5D.scatter_func_t op, IntPtr op_data, System.Int64 type_id, System.Int64 dst_space_id, IntPtr dst_buf)

Parameters

Type	Name	Description
H5D.scatter_func_t	op	Callback function which provides data to be scattered.
IntPtr	op_data	User-defined pointer to data required by op.
System.Int64	type_id	Identifier for the datatype describing the data in both the source and definition buffers. This is only used to calculate the element size.
System.Int64	dst_space_id	Identifier for the dataspace describing both the dimensions of the destination buffer and the selection within the destination buffer that data will be scattered to.
IntPtr	dst_buf	Destination buffer which the data will be scattered to.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_extent(System.Int64, System.UInt64*)

Changes the sizes of a dataset’s dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-SetExtent

Declaration

public static System.Int32 set_extent(System.Int64 dset_id, System.UInt64*size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier
System.UInt64*	size	Array containing the new magnitude of each dimension of the dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

set_extent(System.Int64, System.UInt64[])

Changes the sizes of a dataset’s dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-SetExtent

Declaration

public static System.Int32 set_extent(System.Int64 dset_id, System.UInt64[] size)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier
System.UInt64[]	size	Array containing the new magnitude of each dimension of the dataset.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

vlen_get_buf_size(System.Int64, System.Int64, System.Int64, ref System.UInt64)

Determines the number of bytes required to store variable-length (VL) data. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-VLGetBuf

Declaration

public static System.Int32 vlen_get_buf_size(System.Int64 dataset_id, System.Int64 type_id, System.Int64 space_id, ref System.UInt64 size)

Parameters

Type	Name	Description
System.Int64	dataset_id	Identifier of the dataset to query.
System.Int64	type_id	Datatype identifier.
System.Int64	space_id	Dataspace identifier.
System.UInt64	size	The size in bytes of the memory buffer required to store the VL data.

Returns

Type	Description
System.Int32	Returns non-negative value if successful; otherwise returns a negative value.

vlen_reclaim(System.Int64, System.Int64, System.Int64, IntPtr)

Reclaims variable-length (VL) datatype memory buffers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-VLReclaim

Declaration

public static System.Int32 vlen_reclaim(System.Int64 type_id, System.Int64 space_id, System.Int64 plist_id, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	type_id	Identifier of the datatype.
System.Int64	space_id	Identifier of the dataspace.
System.Int64	plist_id	Identifier of the property list used to create the buffer.
IntPtr	buf	Pointer to the buffer to be reclaimed.

Returns

Type	Description
System.Int32	Returns non-negative value if successful; otherwise returns a negative value.

write(System.Int64, System.Int64, System.Int64, System.Int64, System.Int64, IntPtr)

Writes raw data from a buffer to a dataset. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5D.html#Dataset-Write

Declaration

public static System.Int32 write(System.Int64 dset_id, System.Int64 mem_type_id, System.Int64 mem_space_id, System.Int64 file_space_id, System.Int64 plist_id, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier of the dataset to write to.
System.Int64	mem_type_id	Identifier of the memory datatype.
System.Int64	mem_space_id	Identifier of the memory dataspace.
System.Int64	file_space_id	Identifier of the dataset's dataspace in the file.
System.Int64	plist_id	Identifier of a transfer property list for this I/O operation.
IntPtr	buf	Buffer with data to be written to the file.

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.

write_chunk(System.Int64, System.Int64, System.UInt32, ref System.UInt64, System.IntPtr, IntPtr)

Writes a raw data chunk from a buffer directly to a dataset. See https://www.hdfgroup.org/HDF5/doc/HL/RM_HDF5Optimized.html

Declaration

public static System.Int32 write_chunk(System.Int64 dset_id, System.Int64 dxpl_id, System.UInt32 filter_mask, ref System.UInt64 offset, System.IntPtr data_size, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	dset_id	Identifier for the dataset to write to
System.Int64	dxpl_id	UNUSED
System.UInt32	filter_mask	Mask for identifying the filters in use
System.UInt64	offset	Logical position of the chunk’s first element in the dataspace
System.IntPtr	data_size	Size of the actual data to be written in bytes
IntPtr	buf	Buffer containing data to be written to the file

Returns

Type	Description
System.Int32	Returns a non-negative value if successful; otherwise returns a negative value.