Class H5

Inheritance

System.Object

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5 : object

Fields

| Improve this Doc View Source

HADDR_MAX

Declaration

public const System.UInt64 HADDR_MAX = null

Field Value

Type	Description
System.UInt64

| Improve this Doc View Source

HADDR_UNDEF

Declaration

public const System.UInt64 HADDR_UNDEF = null

Field Value

Type	Description
System.UInt64

| Improve this Doc View Source

HSIZE_UNDEF

Declaration

public const System.UInt64 HSIZE_UNDEF = null

Field Value

Type	Description
System.UInt64

Methods

allocate_memory(IntPtr, System.UInt32)

Allocates memory that will later be freed internally by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-AllocateMemory

Declaration

public static IntPtr allocate_memory(IntPtr size, System.UInt32 clear)

Parameters

Type	Name	Description
IntPtr	size	Specifies the size in bytes of the buffer to be allocated.
System.UInt32	clear	Specifies whether the new buffer is to be initialized to 0 (zero).

Returns

Type	Description
IntPtr	On success, returns pointer to newly allocated buffer or returns NULL if size is 0 (zero). Returns NULL on failure.

close()

Flushes all data to disk, closes all open identifiers, and cleans up memory. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Close

Declaration

public static System.Int32 close()

Returns

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

dont_atexit()

Instructs library not to install atexit cleanup routine. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-DontAtExit

Declaration

public static System.Int32 dont_atexit()

Returns

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

free_memory(IntPtr)

Frees memory allocated by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-FreeMemory

Declaration

public static System.Int32 free_memory(IntPtr buf)

Parameters

Type	Name	Description
IntPtr	buf	Buffer to be freed. Can be NULL.

Returns

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

garbage_collect()

Garbage collects on all free-lists of all types. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-GarbageCollect

Declaration

public static System.Int32 garbage_collect()

Returns

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

get_libversion(ref UInt32, ref UInt32, ref UInt32)

Returns the HDF library release number. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Version

Declaration

public static System.Int32 get_libversion(ref uint majnum, ref uint minnum, ref uint relnum)

Parameters

Type	Name	Description
System.UInt32	majnum	The major version of the library.
System.UInt32	minnum	The minor version of the library.
System.UInt32	relnum	The release number of the library.

Returns

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

is_library_threadsafe(ref System.UInt32)

Determine whether the HDF5 Library was built with the thread-safety feature enabled. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-IsLibraryThreadsafe

Declaration

public static System.Int32 is_library_threadsafe(ref System.UInt32 is_ts)

Parameters

Type	Name	Description
System.UInt32	is_ts	Boolean value indicating whether the library was built with thread-safety enabled.

Returns

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

open()

Initializes the HDF5 library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-Open

Declaration

public static System.Int32 open()

Returns

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

resize_memory(IntPtr, IntPtr)

Resizes and possibly re-allocates memory that will later be freed internally by the HDF5 Library. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-ResizeMemory

Declaration

public static IntPtr resize_memory(IntPtr mem, IntPtr size)

Parameters

Type	Name	Description
IntPtr	mem	Pointer to a buffer to be resized. May be NULL.
IntPtr	size	New size of the buffer, in bytes.

Returns

Type	Description
IntPtr	On success, returns pointer to resized or reallocated buffer or returns NULL if size is 0 (zero). Returns NULL on failure.

set_free_list_limits(Int32, Int32, Int32, Int32, Int32, Int32)

Sets free-list size limits. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-SetFreeListLimits

Declaration

public static System.Int32 set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)

Parameters

Type	Name	Description
System.Int32	reg_global_lim	The cumulative limit, in bytes, on memory used for all regular free lists. (Default: 1MB)
System.Int32	reg_list_lim	The limit, in bytes, on memory used for each regular free list. (Default: 64KB)
System.Int32	arr_global_lim	The cumulative limit, in bytes, on memory used for all array free lists.(Default: 4MB)
System.Int32	arr_list_lim	The limit, in bytes, on memory used for each array free list. (Default: 256KB)
System.Int32	blk_global_lim	The cumulative limit, in bytes, on memory used for all block free lists and, separately, for all factory free lists. (Default: 16MB)
System.Int32	blk_list_lim	The limit, in bytes, on memory used for each block or factory free list. (Default: 1MB)

Returns

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