Class H5T

Inheritance

System.Object

H5T

Namespace: HDF.PInvoke

Assembly: HDF.PInvoke.dll

Syntax

public sealed class H5T : object

Fields

H5T_NSTR

num H5T_str_t types actually defined

Declaration

public const H5T.str_t H5T_NSTR = default(H5T.str_t)

Field Value

Type	Description
H5T.str_t

NCSET

Number of character sets actually defined

Declaration

public const H5T.cset_t NCSET = default(H5T.cset_t)

Field Value

Type	Description
H5T.cset_t

OPAQUE_TAG_MAX

Maximum length of an opaque tag

Declaration

public const int OPAQUE_TAG_MAX = null

Field Value

Type	Description
System.Int32

VARIABLE

Indicate that a string is variable length (null-terminated in C, instead of fixed length)

Declaration

public static readonly IntPtr VARIABLE

Field Value

Type	Description
IntPtr

Properties

ALPHA_B16

Declaration

public static System.Int64 ALPHA_B16 { get; }

Property Value

Type	Description
System.Int64

ALPHA_B32

Declaration

public static System.Int64 ALPHA_B32 { get; }

Property Value

Type	Description
System.Int64

ALPHA_B64

Declaration

public static System.Int64 ALPHA_B64 { get; }

Property Value

Type	Description
System.Int64

ALPHA_B8

Declaration

public static System.Int64 ALPHA_B8 { get; }

Property Value

Type	Description
System.Int64

ALPHA_F32

Declaration

public static System.Int64 ALPHA_F32 { get; }

Property Value

Type	Description
System.Int64

ALPHA_F64

Declaration

public static System.Int64 ALPHA_F64 { get; }

Property Value

Type	Description
System.Int64

ALPHA_I16

Declaration

public static System.Int64 ALPHA_I16 { get; }

Property Value

Type	Description
System.Int64

ALPHA_I32

Declaration

public static System.Int64 ALPHA_I32 { get; }

Property Value

Type	Description
System.Int64

ALPHA_I64

Declaration

public static System.Int64 ALPHA_I64 { get; }

Property Value

Type	Description
System.Int64

ALPHA_I8

Declaration

public static System.Int64 ALPHA_I8 { get; }

Property Value

Type	Description
System.Int64

ALPHA_U16

Declaration

public static System.Int64 ALPHA_U16 { get; }

Property Value

Type	Description
System.Int64

ALPHA_U32

Declaration

public static System.Int64 ALPHA_U32 { get; }

Property Value

Type	Description
System.Int64

ALPHA_U64

Declaration

public static System.Int64 ALPHA_U64 { get; }

Property Value

Type	Description
System.Int64

ALPHA_U8

Declaration

public static System.Int64 ALPHA_U8 { get; }

Property Value

Type	Description
System.Int64

C_S1

Declaration

public static System.Int64 C_S1 { get; }

Property Value

Type	Description
System.Int64

FORTRAN_S1

Declaration

public static System.Int64 FORTRAN_S1 { get; }

Property Value

Type	Description
System.Int64

IEEE_F32BE

Declaration

public static System.Int64 IEEE_F32BE { get; }

Property Value

Type	Description
System.Int64

IEEE_F32LE

Declaration

public static System.Int64 IEEE_F32LE { get; }

Property Value

Type	Description
System.Int64

IEEE_F64BE

Declaration

public static System.Int64 IEEE_F64BE { get; }

Property Value

Type	Description
System.Int64

IEEE_F64LE

Declaration

public static System.Int64 IEEE_F64LE { get; }

Property Value

Type	Description
System.Int64

INTEL_B16

Declaration

public static System.Int64 INTEL_B16 { get; }

Property Value

Type	Description
System.Int64

INTEL_B32

Declaration

public static System.Int64 INTEL_B32 { get; }

Property Value

Type	Description
System.Int64

INTEL_B64

Declaration

public static System.Int64 INTEL_B64 { get; }

Property Value

Type	Description
System.Int64

INTEL_B8

Declaration

public static System.Int64 INTEL_B8 { get; }

Property Value

Type	Description
System.Int64

INTEL_F32

Declaration

public static System.Int64 INTEL_F32 { get; }

Property Value

Type	Description
System.Int64

INTEL_F64

Declaration

public static System.Int64 INTEL_F64 { get; }

Property Value

Type	Description
System.Int64

INTEL_I16

Declaration

public static System.Int64 INTEL_I16 { get; }

Property Value

Type	Description
System.Int64

INTEL_I32

Declaration

public static System.Int64 INTEL_I32 { get; }

Property Value

Type	Description
System.Int64

INTEL_I64

Declaration

public static System.Int64 INTEL_I64 { get; }

Property Value

Type	Description
System.Int64

INTEL_I8

Declaration

public static System.Int64 INTEL_I8 { get; }

Property Value

Type	Description
System.Int64

INTEL_U16

Declaration

public static System.Int64 INTEL_U16 { get; }

Property Value

Type	Description
System.Int64

INTEL_U32

Declaration

public static System.Int64 INTEL_U32 { get; }

Property Value

Type	Description
System.Int64

INTEL_U64

Declaration

public static System.Int64 INTEL_U64 { get; }

Property Value

Type	Description
System.Int64

INTEL_U8

Declaration

public static System.Int64 INTEL_U8 { get; }

Property Value

Type	Description
System.Int64

MIPS_B16

Declaration

public static System.Int64 MIPS_B16 { get; }

Property Value

Type	Description
System.Int64

MIPS_B32

Declaration

public static System.Int64 MIPS_B32 { get; }

Property Value

Type	Description
System.Int64

MIPS_B64

Declaration

public static System.Int64 MIPS_B64 { get; }

Property Value

Type	Description
System.Int64

MIPS_B8

Declaration

public static System.Int64 MIPS_B8 { get; }

Property Value

Type	Description
System.Int64

MIPS_F32

Declaration

public static System.Int64 MIPS_F32 { get; }

Property Value

Type	Description
System.Int64

MIPS_F64

Declaration

public static System.Int64 MIPS_F64 { get; }

Property Value

Type	Description
System.Int64

MIPS_I16

Declaration

public static System.Int64 MIPS_I16 { get; }

Property Value

Type	Description
System.Int64

MIPS_I32

Declaration

public static System.Int64 MIPS_I32 { get; }

Property Value

Type	Description
System.Int64

MIPS_I64

Declaration

public static System.Int64 MIPS_I64 { get; }

Property Value

Type	Description
System.Int64

MIPS_I8

Declaration

public static System.Int64 MIPS_I8 { get; }

Property Value

Type	Description
System.Int64

MIPS_U16

Declaration

public static System.Int64 MIPS_U16 { get; }

Property Value

Type	Description
System.Int64

MIPS_U32

Declaration

public static System.Int64 MIPS_U32 { get; }

Property Value

Type	Description
System.Int64

MIPS_U64

Declaration

public static System.Int64 MIPS_U64 { get; }

Property Value

Type	Description
System.Int64

MIPS_U8

Declaration

public static System.Int64 MIPS_U8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_B16

Declaration

public static System.Int64 NATIVE_B16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_B32

Declaration

public static System.Int64 NATIVE_B32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_B64

Declaration

public static System.Int64 NATIVE_B64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_B8

Declaration

public static System.Int64 NATIVE_B8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_CHAR

Declaration

public static System.Int64 NATIVE_CHAR { get; }

Property Value

Type	Description
System.Int64

NATIVE_DOUBLE

Declaration

public static System.Int64 NATIVE_DOUBLE { get; }

Property Value

Type	Description
System.Int64

NATIVE_FLOAT

Declaration

public static System.Int64 NATIVE_FLOAT { get; }

Property Value

Type	Description
System.Int64

NATIVE_HADDR

Declaration

public static System.Int64 NATIVE_HADDR { get; }

Property Value

Type	Description
System.Int64

NATIVE_HBOOL

Declaration

public static System.Int64 NATIVE_HBOOL { get; }

Property Value

Type	Description
System.Int64

NATIVE_HERR

Declaration

public static System.Int64 NATIVE_HERR { get; }

Property Value

Type	Description
System.Int64

NATIVE_HSIZE

Declaration

public static System.Int64 NATIVE_HSIZE { get; }

Property Value

Type	Description
System.Int64

NATIVE_HSSIZE

Declaration

public static System.Int64 NATIVE_HSSIZE { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT

Declaration

public static System.Int64 NATIVE_INT { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_FAST16

Declaration

public static System.Int64 NATIVE_INT_FAST16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_FAST32

Declaration

public static System.Int64 NATIVE_INT_FAST32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_FAST64

Declaration

public static System.Int64 NATIVE_INT_FAST64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_FAST8

Declaration

public static System.Int64 NATIVE_INT_FAST8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_LEAST16

Declaration

public static System.Int64 NATIVE_INT_LEAST16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_LEAST32

Declaration

public static System.Int64 NATIVE_INT_LEAST32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_LEAST64

Declaration

public static System.Int64 NATIVE_INT_LEAST64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT_LEAST8

Declaration

public static System.Int64 NATIVE_INT_LEAST8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT16

Declaration

public static System.Int64 NATIVE_INT16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT32

Declaration

public static System.Int64 NATIVE_INT32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT64

Declaration

public static System.Int64 NATIVE_INT64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_INT8

Declaration

public static System.Int64 NATIVE_INT8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_LDOUBLE

Declaration

public static System.Int64 NATIVE_LDOUBLE { get; }

Property Value

Type	Description
System.Int64

NATIVE_LLONG

Declaration

public static System.Int64 NATIVE_LLONG { get; }

Property Value

Type	Description
System.Int64

NATIVE_LONG

Declaration

public static System.Int64 NATIVE_LONG { get; }

Property Value

Type	Description
System.Int64

NATIVE_OPAQUE

Declaration

public static System.Int64 NATIVE_OPAQUE { get; }

Property Value

Type	Description
System.Int64

NATIVE_SCHAR

Declaration

public static System.Int64 NATIVE_SCHAR { get; }

Property Value

Type	Description
System.Int64

NATIVE_SHORT

Declaration

public static System.Int64 NATIVE_SHORT { get; }

Property Value

Type	Description
System.Int64

NATIVE_UCHAR

Declaration

public static System.Int64 NATIVE_UCHAR { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT

Declaration

public static System.Int64 NATIVE_UINT { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_FAST16

Declaration

public static System.Int64 NATIVE_UINT_FAST16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_FAST32

Declaration

public static System.Int64 NATIVE_UINT_FAST32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_FAST64

Declaration

public static System.Int64 NATIVE_UINT_FAST64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_FAST8

Declaration

public static System.Int64 NATIVE_UINT_FAST8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_LEAST16

Declaration

public static System.Int64 NATIVE_UINT_LEAST16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_LEAST32

Declaration

public static System.Int64 NATIVE_UINT_LEAST32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_LEAST64

Declaration

public static System.Int64 NATIVE_UINT_LEAST64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT_LEAST8

Declaration

public static System.Int64 NATIVE_UINT_LEAST8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT16

Declaration

public static System.Int64 NATIVE_UINT16 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT32

Declaration

public static System.Int64 NATIVE_UINT32 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT64

Declaration

public static System.Int64 NATIVE_UINT64 { get; }

Property Value

Type	Description
System.Int64

NATIVE_UINT8

Declaration

public static System.Int64 NATIVE_UINT8 { get; }

Property Value

Type	Description
System.Int64

NATIVE_ULLONG

Declaration

public static System.Int64 NATIVE_ULLONG { get; }

Property Value

Type	Description
System.Int64

NATIVE_ULONG

Declaration

public static System.Int64 NATIVE_ULONG { get; }

Property Value

Type	Description
System.Int64

NATIVE_USHORT

Declaration

public static System.Int64 NATIVE_USHORT { get; }

Property Value

Type	Description
System.Int64

STD_B16BE

Declaration

public static System.Int64 STD_B16BE { get; }

Property Value

Type	Description
System.Int64

STD_B16LE

Declaration

public static System.Int64 STD_B16LE { get; }

Property Value

Type	Description
System.Int64

STD_B32BE

Declaration

public static System.Int64 STD_B32BE { get; }

Property Value

Type	Description
System.Int64

STD_B32LE

Declaration

public static System.Int64 STD_B32LE { get; }

Property Value

Type	Description
System.Int64

STD_B64BE

Declaration

public static System.Int64 STD_B64BE { get; }

Property Value

Type	Description
System.Int64

STD_B64LE

Declaration

public static System.Int64 STD_B64LE { get; }

Property Value

Type	Description
System.Int64

STD_B8BE

Declaration

public static System.Int64 STD_B8BE { get; }

Property Value

Type	Description
System.Int64

STD_B8LE

Declaration

public static System.Int64 STD_B8LE { get; }

Property Value

Type	Description
System.Int64

STD_I16BE

Declaration

public static System.Int64 STD_I16BE { get; }

Property Value

Type	Description
System.Int64

STD_I16LE

Declaration

public static System.Int64 STD_I16LE { get; }

Property Value

Type	Description
System.Int64

STD_I32BE

Declaration

public static System.Int64 STD_I32BE { get; }

Property Value

Type	Description
System.Int64

STD_I32LE

Declaration

public static System.Int64 STD_I32LE { get; }

Property Value

Type	Description
System.Int64

STD_I64BE

Declaration

public static System.Int64 STD_I64BE { get; }

Property Value

Type	Description
System.Int64

STD_I64LE

Declaration

public static System.Int64 STD_I64LE { get; }

Property Value

Type	Description
System.Int64

STD_I8BE

Declaration

public static System.Int64 STD_I8BE { get; }

Property Value

Type	Description
System.Int64

STD_I8LE

Declaration

public static System.Int64 STD_I8LE { get; }

Property Value

Type	Description
System.Int64

STD_REF_DSETREG

Declaration

public static System.Int64 STD_REF_DSETREG { get; }

Property Value

Type	Description
System.Int64

STD_REF_OBJ

Declaration

public static System.Int64 STD_REF_OBJ { get; }

Property Value

Type	Description
System.Int64

STD_U16BE

Declaration

public static System.Int64 STD_U16BE { get; }

Property Value

Type	Description
System.Int64

STD_U16LE

Declaration

public static System.Int64 STD_U16LE { get; }

Property Value

Type	Description
System.Int64

STD_U32BE

Declaration

public static System.Int64 STD_U32BE { get; }

Property Value

Type	Description
System.Int64

STD_U32LE

Declaration

public static System.Int64 STD_U32LE { get; }

Property Value

Type	Description
System.Int64

STD_U64BE

Declaration

public static System.Int64 STD_U64BE { get; }

Property Value

Type	Description
System.Int64

STD_U64LE

Declaration

public static System.Int64 STD_U64LE { get; }

Property Value

Type	Description
System.Int64

STD_U8BE

Declaration

public static System.Int64 STD_U8BE { get; }

Property Value

Type	Description
System.Int64

STD_U8LE

Declaration

public static System.Int64 STD_U8LE { get; }

Property Value

Type	Description
System.Int64

UNIX_D32BE

Declaration

public static System.Int64 UNIX_D32BE { get; }

Property Value

Type	Description
System.Int64

UNIX_D32LE

Declaration

public static System.Int64 UNIX_D32LE { get; }

Property Value

Type	Description
System.Int64

UNIX_D64BE

Declaration

public static System.Int64 UNIX_D64BE { get; }

Property Value

Type	Description
System.Int64

UNIX_D64LE

Declaration

public static System.Int64 UNIX_D64LE { get; }

Property Value

Type	Description
System.Int64

VAX_F32

Declaration

public static System.Int64 VAX_F32 { get; }

Property Value

Type	Description
System.Int64

VAX_F64

Declaration

public static System.Int64 VAX_F64 { get; }

Property Value

Type	Description
System.Int64

Methods

array_create(System.Int64, UInt32, System.UInt64[])

Creates an array datatype object. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-ArrayCreate2

Declaration

public static System.Int64 array_create(System.Int64 base_type_id, uint rank, System.UInt64[] dims)

Parameters

Type	Name	Description
System.Int64	base_type_id	Datatype identifier for the array base datatype.
System.UInt32	rank	Rank of the array.
System.UInt64[]	dims	Size of each array dimension.

Returns

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

close(System.Int64)

Releases a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Close

Declaration

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

Parameters

Type	Name	Description
System.Int64	type_id	Identifier of datatype to release.

Returns

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

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

Commits a transient datatype, linking it into the file and creating a new named datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Commit2

Declaration

public static System.Int32 commit(System.Int64 loc_id, byte[] name, System.Int64 dtype_id, System.Int64 lcpl_id = null, System.Int64 tcpl_id = null, System.Int64 tapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Location identifier
System.Byte[]	name	Name given to committed datatype
System.Int64	dtype_id	Identifier of datatype to be committed and, upon function’s return, identifier for the committed datatype
System.Int64	lcpl_id	Link creation property list
System.Int64	tcpl_id	Datatype creation property list
System.Int64	tapl_id	Datatype access property list

Returns

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

commit(System.Int64, String, System.Int64, System.Int64, System.Int64, System.Int64)

Commits a transient datatype, linking it into the file and creating a new named datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Commit2

Declaration

public static System.Int32 commit(System.Int64 loc_id, string name, System.Int64 dtype_id, System.Int64 lcpl_id = null, System.Int64 tcpl_id = null, System.Int64 tapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	Location identifier
System.String	name	Name given to committed datatype
System.Int64	dtype_id	Identifier of datatype to be committed and, upon function’s return, identifier for the committed datatype
System.Int64	lcpl_id	Link creation property list
System.Int64	tcpl_id	Datatype creation property list
System.Int64	tapl_id	Datatype access property list

Returns

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

Remarks

ASCII strings ONLY!

commit_anon(System.Int64, System.Int64, System.Int64, System.Int64)

Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-CommitAnon

Declaration

public static System.Int32 commit_anon(System.Int64 loc_id, System.Int64 dtype_id, System.Int64 tcpl_id = null, System.Int64 tapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	A file or group identifier specifying the file in which the new named datatype is to be created.
System.Int64	dtype_id	A datatype identifier.
System.Int64	tcpl_id	A datatype creation property list identifier.
System.Int64	tapl_id	A datatype access property list identifier.

Returns

Type	Description
System.Int32

committed(System.Int64)

Determines whether a datatype is a named type or a transient type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Committed

Declaration

public static System.Int32 committed(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier.

Returns

Type	Description
System.Int32	When successful, returns a positive value, for TRUE , if the datatype has been committed, or 0 (zero), for FALSE , if the datatype has not been committed. Otherwise returns a negative value.

compiler_conv(System.Int64, System.Int64)

Check whether the library’s default conversion is hard conversion. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-CompilerConv

Declaration

public static System.Int32 compiler_conv(System.Int64 src_id, System.Int64 dst_id)

Parameters

Type	Name	Description
System.Int64	src_id	Identifier for the source datatype.
System.Int64	dst_id	Identifier for the destination datatype.

Returns

Type	Description
System.Int32	When successful, returns a positive value, for TRUE , if the datatype has been committed, or 0 (zero), for FALSE , if the datatype has not been committed. Otherwise returns a negative value.

convert(System.Int64, System.Int64, System.IntPtr, IntPtr, IntPtr, System.Int64)

Converts data from one specified datatype to another. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Convert

Declaration

public static System.Int32 convert(System.Int64 src_type_id, System.Int64 dest_type_id, System.IntPtr nelmts, IntPtr buf, IntPtr background, System.Int64 plist_id = null)

Parameters

Type	Name	Description
System.Int64	src_type_id	Identifier for the source datatype.
System.Int64	dest_type_id	Identifier for the destination datatype.
System.IntPtr	nelmts	Size of array buf.
IntPtr	buf	Array containing pre- and post-conversion values.
IntPtr	background	Optional background buffer.
System.Int64	plist_id	Dataset transfer property list identifier.

Returns

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

copy(System.Int64)

Copies an existing datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Copy

Declaration

public static System.Int64 copy(System.Int64 type_id)

Parameters

Type	Name	Description
System.Int64	type_id	Identifier of datatype to copy.

Returns

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

create(H5T.class_t, System.IntPtr)

Creates a new datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Create

Declaration

public static System.Int64 create(H5T.class_t cls, System.IntPtr size)

Parameters

Type	Name	Description
H5T.class_t	cls	Class of datatype to create.
System.IntPtr	size	Size, in bytes, of the datatype being created

Returns

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

decode(Byte[])

Decode a binary object description of datatype and return a new object handle. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Decode

Declaration

public static System.Int64 decode(byte[] buf)

Parameters

Type	Name	Description
System.Byte[]	buf	Buffer for the datatype object to be decoded.

Returns

Type	Description
System.Int64	Returns an object identifier (non-negative) if successful; otherwise returns a negative value.

detect_class(System.Int64, H5T.class_t)

Determines whether a datatype contains any datatypes of the given datatype class. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-DetectClass

Declaration

public static System.Int32 detect_class(System.Int64 dtype_id, H5T.class_t dtype_class)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier.
H5T.class_t	dtype_class	Datatype class.

Returns

Type	Description
System.Int32	Returns TRUE or FALSE if successful; otherwise returns a negative value.

encode(System.Int64, Byte[], ref System.IntPtr)

Encode a datatype object description into a binary buffer. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Encode

Declaration

public static System.Int32 encode(System.Int64 obj_id, byte[] buf, ref System.IntPtr nalloc)

Parameters

Type	Name	Description
System.Int64	obj_id	Identifier of the object to be encoded.
System.Byte[]	buf	Buffer for the object to be encoded into. If the provided buffer is NULL , only the size of buffer needed is returned through nalloc.
System.IntPtr	nalloc	The size of the buffer allocated or needed.

Returns

Type	Description
System.Int32

enum_create(System.Int64)

Creates a new enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumCreate

Declaration

public static System.Int64 enum_create(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the base datatype. Must be an integer datatype.

Returns

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

enum_insert(System.Int64, String, IntPtr)

Inserts a new enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumInsert

Declaration

public static System.Int32 enum_insert(System.Int64 dtype_id, string name, IntPtr value)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the enumeration datatype.
System.String	name	Name of the new member.
IntPtr	value	Pointer to the value of the new member.

Returns

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

Remarks

ASCII strings ONLY!

enum_nameof(System.Int64, IntPtr, StringBuilder, System.IntPtr)

Returns the symbol name corresponding to a specified member of an enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumNameOf

Declaration

public static System.Int32 enum_nameof(System.Int64 dtype_id, IntPtr value, StringBuilder name, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dtype_id	Enumeration datatype identifier.
IntPtr	value	Value of the enumeration datatype.
StringBuilder	name	Buffer for output of the symbol name.
System.IntPtr	size	The capacity of the buffer, in bytes (characters).

Returns

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

Remarks

ASCII strings ONLY!

enum_valueof(System.Int64, String, IntPtr)

Returns the value corresponding to a specified member of an enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-EnumValueOf

Declaration

public static System.Int32 enum_valueof(System.Int64 dtype_id, string name, IntPtr value)

Parameters

Type	Name	Description
System.Int64	dtype_id	Enumeration datatype identifier.
System.String	name	Symbol name of the enumeration datatype.
IntPtr	value	Buffer for output of the value of the enumeration datatype.

Returns

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

Remarks

ASCII strings ONLY!

equal(System.Int64, System.Int64)

Determines whether two datatype identifiers refer to the same datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Equal

Declaration

public static System.Int32 equal(System.Int64 type_id1, System.Int64 type_id2)

Parameters

Type	Name	Description
System.Int64	type_id1	Identifier of datatype to compare.
System.Int64	type_id2	Identifier of datatype to compare.

Returns

Type	Description
System.Int32	When successful, returns a positive value, for TRUE , if the datatype has been committed, or 0 (zero), for FALSE , if the datatype has not been committed. Otherwise returns a negative value.

find(System.Int64, System.Int64, ref H5T.cdata_t)

Finds a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Find

Declaration

public static H5T.conv_t find(System.Int64 src_id, System.Int64 dst_id, ref H5T.cdata_t pcdata)

Parameters

Type	Name	Description
System.Int64	src_id	Identifier for the source datatype.
System.Int64	dst_id	Identifier for the destination datatype.
H5T.cdata_t	pcdata	Pointer to type conversion data.

Returns

Type	Description
H5T.conv_t	Returns a pointer to a suitable conversion function if successful. Otherwise returns NULL .

flush(System.Int64)

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

Declaration

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

Parameters

Type	Name	Description
System.Int64	type_id	Identifier of the committed datatype to be flushed.

Returns

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

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

Retrieves sizes of array dimensions. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetArrayDims2

Declaration

public static int get_array_dims(System.Int64 adtype_id, System.UInt64[] dims)

Parameters

Type	Name	Description
System.Int64	adtype_id	Array datatype identifier.
System.UInt64[]	dims	Sizes of array dimensions.

Returns

Type	Description
System.Int32	Returns the non-negative number of dimensions of the array type if successful; otherwise returns a negative value.

get_array_ndims(System.Int64)

Returns the rank of an array datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetArrayNdims

Declaration

public static int get_array_ndims(System.Int64 adtype_id)

Parameters

Type	Name	Description
System.Int64	adtype_id	Array datatype identifier.

Returns

Type	Description
System.Int32	Returns the rank of the array if successful; otherwise returns a negative value.

get_class(System.Int64)

Returns the datatype class identifier. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetClass

Declaration

public static H5T.class_t get_class(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.class_t	Returns datatype class identifier if successful; otherwise H5T_NO_CLASS .

get_create_plist(System.Int64)

Returns a copy of a datatype creation property list. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetCreatePlist

Declaration

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

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier.

Returns

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

get_cset(System.Int64)

Retrieves the character set type of a string datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetCset

Declaration

public static H5T.cset_t get_cset(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.cset_t	Returns a valid character set type if successful; otherwise H5T.cset_t.CSET_ERROR .

get_ebias(System.Int64)

Retrieves the exponent bias of a floating-point type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetEbias

Declaration

public static System.IntPtr get_ebias(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
System.IntPtr	Returns the bias if successful; otherwise 0.

get_fields(System.Int64, ref System.IntPtr, ref System.IntPtr, ref System.IntPtr, ref System.IntPtr, ref System.IntPtr)

Retrieves floating point datatype bit field information. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetFields

Declaration

public static System.Int32 get_fields(System.Int64 dtype_id, ref System.IntPtr spos, ref System.IntPtr epos, ref System.IntPtr esize, ref System.IntPtr mpos, ref System.IntPtr msize)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
System.IntPtr	spos	Pointer to location to return floating-point sign bit.
System.IntPtr	epos	Pointer to location to return exponent bit-position.
System.IntPtr	esize	Pointer to location to return size of exponent in bits.
System.IntPtr	mpos	Pointer to location to return mantissa bit-position.
System.IntPtr	msize	Pointer to location to return size of mantissa in bits.

Returns

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

get_inpad(System.Int64)

Retrieves the internal padding type for unused bits in floating-point datatypes. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetInpad

Declaration

public static H5T.pad_t get_inpad(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.pad_t	Returns a valid padding type if successful; otherwise H5T.pad_t.ERROR .

get_member_class(System.Int64, UInt32)

Returns datatype class of compound datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberClass

Declaration

public static H5T.class_t get_member_class(System.Int64 cdtype_id, uint member_no)

Parameters

Type	Name	Description
System.Int64	cdtype_id	Datatype identifier of compound object.
System.UInt32	member_no	Compound type member number.

Returns

Type	Description
H5T.class_t	Returns the datatype class, a non-negative value, if successful; otherwise returns a negative value.

get_member_index(System.Int64, String)

Retrieves the index of a compound or enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberIndex

Declaration

public static int get_member_index(System.Int64 dtype_id, string field_name)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
System.String	field_name	Name of the field or member whose index is to be retrieved.

Returns

Type	Description
System.Int32	Returns a valid field or member index if successful; otherwise returns a negative value.

Remarks

ASCII strings ONLY!

get_member_name(System.Int64, UInt32)

Retrieves the name of a compound or enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberName

Declaration

public static IntPtr get_member_name(System.Int64 dtype_id, uint field_idx)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
System.UInt32	field_idx	Zero-based index of the field or element whose name is to be retrieved.

Returns

Type	Description
IntPtr	Returns a pointer to a string allocated in unmanaged memory if successful; otherwise returns NULL .

Remarks

The caller is responsible for freeing the allocated memory.

get_member_offset(System.Int64, UInt32)

Retrieves the offset of a field of a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberOffset

Declaration

public static System.IntPtr get_member_offset(System.Int64 dtype_id, uint memb_no)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
System.UInt32	memb_no	Number of the field whose offset is requested.

Returns

Type	Description
System.IntPtr

get_member_type(System.Int64, UInt32)

Returns the datatype of the specified member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberType

Declaration

public static System.Int64 get_member_type(System.Int64 dtype_id, uint field_idx)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
System.UInt32	field_idx	Field index (0-based) of the field type to retrieve.

Returns

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

get_member_value(System.Int64, UInt32, IntPtr)

Returns the value of an enumeration datatype member. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetMemberValue

Declaration

public static System.Int32 get_member_value(System.Int64 dtype_id, uint memb_no, IntPtr value)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the enumeration datatype.
System.UInt32	memb_no	Number of the enumeration datatype member.
IntPtr	value	Pointer to a buffer for output of the value of the enumeration datatype member.

Returns

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

get_native_type(System.Int64, H5T.direction_t)

Returns the native datatype of a specified datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNativeType

Declaration

public static System.Int64 get_native_type(System.Int64 dtype_id, H5T.direction_t direction)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the dataset datatype.
H5T.direction_t	direction	Direction of search.

Returns

Type	Description
System.Int64	Returns the native datatype identifier for the specified dataset datatype if successful; otherwise returns a negative value.

get_nmembers(System.Int64)

Retrieves the number of elements in a compound or enumeration datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNmembers

Declaration

public static int get_nmembers(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
System.Int32	Returns the number of elements if successful; otherwise returns a negative value.

get_norm(System.Int64)

Retrieves mantissa normalization of a floating-point datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNorm

Declaration

public static H5T.norm_t get_norm(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.norm_t	Returns a valid normalization type if successful; otherwise H5T.norm_t.ERROR .

get_offset(System.Int64)

Retrieves the bit offset of the first significant bit. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOffset

Declaration

public static int get_offset(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
System.Int32	Returns an offset value if successful; otherwise returns a negative value.

get_order(System.Int64)

Returns the byte order of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOrder

Declaration

public static H5T.order_t get_order(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.order_t	Returns a byte order constant if successful; otherwise H5T.order_t.ERROR .

get_pad(System.Int64, ref H5T.pad_t, ref H5T.pad_t)

Retrieves the padding type of the least and most-significant bit padding. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetPad

Declaration

public static System.Int32 get_pad(System.Int64 dtype_id, ref H5T.pad_t lsb, ref H5T.pad_t msb)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.
H5T.pad_t	lsb	Pointer to location to return least-significant bit padding type.
H5T.pad_t	msb	Pointer to location to return most-significant bit padding type.

Returns

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

get_precision(System.Int64)

Returns the precision of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetPrecision

Declaration

public static System.IntPtr get_precision(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
System.IntPtr	Returns the number of significant bits if successful; otherwise 0.

get_sign(System.Int64)

Retrieves the sign type for an integer type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSign

Declaration

public static H5T.sign_t get_sign(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.sign_t	Returns a valid sign type if successful; otherwise H5T.sign_t.ERROR .

get_size(System.Int64)

Returns the size of a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSize

Declaration

public static System.IntPtr get_size(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
System.IntPtr	Returns the size of the datatype in bytes if successful; otherwise 0.

get_strpad(System.Int64)

Retrieves the type of padding used for a string datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetStrpad

Declaration

public static H5T.str_t get_strpad(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to query.

Returns

Type	Description
H5T.str_t	Returns a valid string storage mechanism if successful; otherwise H5T.str_t.ERROR .

get_super(System.Int64)

Returns the base datatype from which a datatype is derived. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSuper

Declaration

public static System.Int64 get_super(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the derived datatype.

Returns

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

get_tag(System.Int64)

Gets the tag associated with an opaque datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetTag

Declaration

public static IntPtr get_tag(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the opaque datatype.

Returns

Type	Description
IntPtr	Returns a pointer to a string allocated in unmanaged memory if successful; otherwise returns NULL .

Remarks

The caller is responsible for freeing the allocated memory.

H5Trefresh(System.Int64)

Refreshes all buffers associated with a committed datatype. See https://www.hdfgroup.org/HDF5/docNewFeatures/FineTuneMDC/H5Trefresh.htm

Declaration

public static System.Int32 H5Trefresh(System.Int64 type_id)

Parameters

Type	Name	Description
System.Int64	type_id	Identifier of the committed datatype to be refreshed.

Returns

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

insert(System.Int64, String, System.IntPtr, System.Int64)

Adds a new member to a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Insert

Declaration

public static System.Int32 insert(System.Int64 dtype_id, string name, System.IntPtr offset, System.Int64 field_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of compound datatype to modify.
System.String	name	Name of the field to insert.
System.IntPtr	offset	Offset in memory structure of the field to insert.
System.Int64	field_id	Datatype identifier of the field to insert.

Returns

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

Remarks

ASCII strings ONLY!

is_variable_str(System.Int64)

Determines whether datatype is a variable-length string. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-IsVariableString

Declaration

public static System.Int32 is_variable_str(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier.

Returns

Type	Description
System.Int32	Returns TRUE or FALSE if successful; otherwise returns a negative value.

lock_datatype(System.Int64)

Locks a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Lock

Declaration

public static System.Int32 lock_datatype(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to lock.

Returns

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

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

Opens a committed (named) datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Open2

Declaration

public static System.Int64 open(System.Int64 loc_id, byte[] name, System.Int64 tapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	A file or group identifier.
System.Byte[]	name	A datatype name, defined within the file or group identified by loc_id.
System.Int64	tapl_id	Datatype access property list identifier.

Returns

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

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

Opens a committed (named) datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Open2

Declaration

public static System.Int64 open(System.Int64 loc_id, string name, System.Int64 tapl_id = null)

Parameters

Type	Name	Description
System.Int64	loc_id	A file or group identifier.
System.String	name	A datatype name, defined within the file or group identified by loc_id.
System.Int64	tapl_id	Datatype access property list identifier.

Returns

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

Remarks

ASCII strings ONLY!

pack(System.Int64)

Recursively removes padding from within a compound datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Pack

Declaration

public static System.Int32 pack(System.Int64 dtype_id)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to modify.

Returns

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

register(H5T.pers_t, String, System.Int64, System.Int64, H5T.conv_t)

Registers a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Register

Declaration

public static System.Int32 register(H5T.pers_t type, string name, System.Int64 src_id, System.Int64 dst_id, H5T.conv_t func)

Parameters

Type	Name	Description
H5T.pers_t	type	Conversion function type
System.String	name	Name displayed in diagnostic output
System.Int64	src_id	Identifier of source datatype
System.Int64	dst_id	Identifier of destination datatype
H5T.conv_t	func	Function to convert between source and destination datatypes

Returns

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

Remarks

ASCII strings ONLY!

set_cset(System.Int64, H5T.cset_t)

Sets character set to be used in a string or character datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetCset

Declaration

public static System.Int32 set_cset(System.Int64 dtype_id, H5T.cset_t cset)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to modify.
H5T.cset_t	cset	Character set type.

Returns

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

set_ebias(System.Int64, System.IntPtr)

Sets the exponent bias of a floating-point type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetEbias

Declaration

public static System.Int32 set_ebias(System.Int64 dtype_id, System.IntPtr ebias)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
System.IntPtr	ebias	Exponent bias value.

Returns

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

set_fields(System.Int64, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr, System.IntPtr)

Sets locations and sizes of floating point bit fields. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetFields

Declaration

public static System.Int32 set_fields(System.Int64 dtype_id, System.IntPtr spos, System.IntPtr epos, System.IntPtr esize, System.IntPtr mpos, System.IntPtr msize)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
System.IntPtr	spos	Sign position, i.e., the bit offset of the floating-point sign bit.
System.IntPtr	epos	Exponent bit position.
System.IntPtr	esize	Size of exponent in bits.
System.IntPtr	mpos	Mantissa bit position.
System.IntPtr	msize	Size of mantissa in bits.

Returns

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

set_inpad(System.Int64, H5T.pad_t)

Sets interal bit padding of floating point numbers. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetInpad

Declaration

public static System.Int32 set_inpad(System.Int64 dtype_id, H5T.pad_t inpad)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to modify.
H5T.pad_t	inpad	Padding type.

Returns

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

set_norm(System.Int64, H5T.norm_t)

Sets the mantissa normalization of a floating-point datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetNorm

Declaration

public static System.Int32 set_norm(System.Int64 dtype_id, H5T.norm_t norm)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
H5T.norm_t	norm	Mantissa normalization type.

Returns

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

set_offset(System.Int64, System.IntPtr)

Sets the bit offset of the first significant bit. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOffset

Declaration

public static System.Int32 set_offset(System.Int64 dtype_id, System.IntPtr offset)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
System.IntPtr	offset	Offset of first significant bit.

Returns

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

set_order(System.Int64, H5T.order_t)

Sets the byte order of a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetOrder

Declaration

public static System.Int32 set_order(System.Int64 dtype_id, H5T.order_t order)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
H5T.order_t	order	Byte order.

Returns

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

set_pad(System.Int64, H5T.pad_t, H5T.pad_t)

Sets the least and most-significant bits padding types. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPad

Declaration

public static System.Int32 set_pad(System.Int64 dtype_id, H5T.pad_t lsb, H5T.pad_t msb)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
H5T.pad_t	lsb	Padding type for least-significant bits.
H5T.pad_t	msb	Padding type for most-significant bits.

Returns

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

set_precision(System.Int64, System.IntPtr)

Sets the precision of an atomic datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetPrecision

Declaration

public static System.Int32 set_precision(System.Int64 dtype_id, System.IntPtr precision)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
System.IntPtr	precision	Number of bits of precision for datatype.

Returns

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

set_sign(System.Int64, H5T.sign_t)

Sets the sign property for an integer type. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetSign

Declaration

public static System.Int32 set_sign(System.Int64 dtype_id, H5T.sign_t sign)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to set.
H5T.sign_t	sign	Sign type.

Returns

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

set_size(System.Int64, System.IntPtr)

Sets the total size for a datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetSize

Declaration

public static System.Int32 set_size(System.Int64 dtype_id, System.IntPtr size)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype for which the size is being changed
System.IntPtr	size	New datatype size in bytes or VARIABLE

Returns

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

set_strpad(System.Int64, H5T.str_t)

Defines the type of padding used for character strings. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetStrpad

Declaration

public static System.Int32 set_strpad(System.Int64 dtype_id, H5T.str_t strpad)

Parameters

Type	Name	Description
System.Int64	dtype_id	Identifier of datatype to modify.
H5T.str_t	strpad	String padding type.

Returns

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

set_tag(System.Int64, String)

Tags an opaque datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-SetTag

Declaration

public static System.Int32 set_tag(System.Int64 dtype_id, string tag)

Parameters

Type	Name	Description
System.Int64	dtype_id	Datatype identifier for the opaque datatype to be tagged.
System.String	tag	Descriptive ASCII string with which the opaque datatype is to be tagged.

Returns

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

Remarks

tag is intended to provide a concise description; the maximum size is hard-coded in the HDF5 Library as 256 bytes

unregister(H5T.pers_t, String, System.Int64, System.Int64, H5T.conv_t)

Removes a conversion function. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-Unregister

Declaration

public static System.Int32 unregister(H5T.pers_t type, string name, System.Int64 src_id, System.Int64 dst_id, H5T.conv_t func)

Parameters

Type	Name	Description
H5T.pers_t	type	Conversion function type
System.String	name	Name displayed in diagnostic output.
System.Int64	src_id	Identifier of source datatype.
System.Int64	dst_id	Identifier of destination datatype.
H5T.conv_t	func	Function to convert between source and destination datatypes.

Returns

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

Remarks

ASCII strings ONLY!

vlen_create(System.Int64)

Creates a new variable-length array datatype. See https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-VLCreate

Declaration

public static System.Int64 vlen_create(System.Int64 base_type_id)

Parameters

Type	Name	Description
System.Int64	base_type_id	Base type of datatype to create.

Returns

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