Class H5DO

Inheritance

System.Object

H5DO

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5DO : object

Methods

append(System.Int64, System.Int64, UInt32, System.IntPtr, System.Int64, IntPtr)

Appends data to a dataset along a specified dimension. See https://www.hdfgroup.org/HDF5/docNewFeatures/SWMR/H5DOappend.htm

Declaration

public static System.Int32 append(System.Int64 dset_id, System.Int64 dxpl_id, uint axis, System.IntPtr num_elem, System.Int64 memtype, IntPtr buf)

Parameters

Type	Name	Description
System.Int64	dset_id	Dataset identifier.
System.Int64	dxpl_id	Dataset transfer property list identifier.
System.UInt32	axis	Dimension number (0-based).
System.IntPtr	num_elem	Number of elements to add along the dimension.
System.Int64	memtype	Memory type identifier.
IntPtr	buf	Data buffer.

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.

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.