Please, help us to better know about our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5  1.8.23
C-API Reference
H5Tpublic.h File Reference
#include "H5public.h"
#include "H5Ipublic.h"

Data Structures

struct  H5T_cdata_t
 
struct  hvl_t
 

Macros

#define HOFFSET(S, M)   (offsetof(S, M))
 
#define H5T_NCSET   H5T_CSET_RESERVED_2 /*Number of character sets actually defined */
 
#define H5T_NSTR   H5T_STR_RESERVED_3 /*num H5T_str_t types actually defined */
 
#define H5T_VARIABLE   ((size_t)(-1))
 
#define H5T_OPAQUE_TAG_MAX   256
 
#define H5OPEN   H5open(),
 
#define H5T_IEEE_F32BE   (H5OPEN H5T_IEEE_F32BE_g)
 
#define H5T_IEEE_F32LE   (H5OPEN H5T_IEEE_F32LE_g)
 
#define H5T_IEEE_F64BE   (H5OPEN H5T_IEEE_F64BE_g)
 
#define H5T_IEEE_F64LE   (H5OPEN H5T_IEEE_F64LE_g)
 
#define H5T_STD_I8BE   (H5OPEN H5T_STD_I8BE_g)
 
#define H5T_STD_I8LE   (H5OPEN H5T_STD_I8LE_g)
 
#define H5T_STD_I16BE   (H5OPEN H5T_STD_I16BE_g)
 
#define H5T_STD_I16LE   (H5OPEN H5T_STD_I16LE_g)
 
#define H5T_STD_I32BE   (H5OPEN H5T_STD_I32BE_g)
 
#define H5T_STD_I32LE   (H5OPEN H5T_STD_I32LE_g)
 
#define H5T_STD_I64BE   (H5OPEN H5T_STD_I64BE_g)
 
#define H5T_STD_I64LE   (H5OPEN H5T_STD_I64LE_g)
 
#define H5T_STD_U8BE   (H5OPEN H5T_STD_U8BE_g)
 
#define H5T_STD_U8LE   (H5OPEN H5T_STD_U8LE_g)
 
#define H5T_STD_U16BE   (H5OPEN H5T_STD_U16BE_g)
 
#define H5T_STD_U16LE   (H5OPEN H5T_STD_U16LE_g)
 
#define H5T_STD_U32BE   (H5OPEN H5T_STD_U32BE_g)
 
#define H5T_STD_U32LE   (H5OPEN H5T_STD_U32LE_g)
 
#define H5T_STD_U64BE   (H5OPEN H5T_STD_U64BE_g)
 
#define H5T_STD_U64LE   (H5OPEN H5T_STD_U64LE_g)
 
#define H5T_STD_B8BE   (H5OPEN H5T_STD_B8BE_g)
 
#define H5T_STD_B8LE   (H5OPEN H5T_STD_B8LE_g)
 
#define H5T_STD_B16BE   (H5OPEN H5T_STD_B16BE_g)
 
#define H5T_STD_B16LE   (H5OPEN H5T_STD_B16LE_g)
 
#define H5T_STD_B32BE   (H5OPEN H5T_STD_B32BE_g)
 
#define H5T_STD_B32LE   (H5OPEN H5T_STD_B32LE_g)
 
#define H5T_STD_B64BE   (H5OPEN H5T_STD_B64BE_g)
 
#define H5T_STD_B64LE   (H5OPEN H5T_STD_B64LE_g)
 
#define H5T_STD_REF_OBJ   (H5OPEN H5T_STD_REF_OBJ_g)
 
#define H5T_STD_REF_DSETREG   (H5OPEN H5T_STD_REF_DSETREG_g)
 
#define H5T_UNIX_D32BE   (H5OPEN H5T_UNIX_D32BE_g)
 
#define H5T_UNIX_D32LE   (H5OPEN H5T_UNIX_D32LE_g)
 
#define H5T_UNIX_D64BE   (H5OPEN H5T_UNIX_D64BE_g)
 
#define H5T_UNIX_D64LE   (H5OPEN H5T_UNIX_D64LE_g)
 
#define H5T_C_S1   (H5OPEN H5T_C_S1_g)
 
#define H5T_FORTRAN_S1   (H5OPEN H5T_FORTRAN_S1_g)
 
#define H5T_INTEL_I8   H5T_STD_I8LE
 
#define H5T_INTEL_I16   H5T_STD_I16LE
 
#define H5T_INTEL_I32   H5T_STD_I32LE
 
#define H5T_INTEL_I64   H5T_STD_I64LE
 
#define H5T_INTEL_U8   H5T_STD_U8LE
 
#define H5T_INTEL_U16   H5T_STD_U16LE
 
#define H5T_INTEL_U32   H5T_STD_U32LE
 
#define H5T_INTEL_U64   H5T_STD_U64LE
 
#define H5T_INTEL_B8   H5T_STD_B8LE
 
#define H5T_INTEL_B16   H5T_STD_B16LE
 
#define H5T_INTEL_B32   H5T_STD_B32LE
 
#define H5T_INTEL_B64   H5T_STD_B64LE
 
#define H5T_INTEL_F32   H5T_IEEE_F32LE
 
#define H5T_INTEL_F64   H5T_IEEE_F64LE
 
#define H5T_ALPHA_I8   H5T_STD_I8LE
 
#define H5T_ALPHA_I16   H5T_STD_I16LE
 
#define H5T_ALPHA_I32   H5T_STD_I32LE
 
#define H5T_ALPHA_I64   H5T_STD_I64LE
 
#define H5T_ALPHA_U8   H5T_STD_U8LE
 
#define H5T_ALPHA_U16   H5T_STD_U16LE
 
#define H5T_ALPHA_U32   H5T_STD_U32LE
 
#define H5T_ALPHA_U64   H5T_STD_U64LE
 
#define H5T_ALPHA_B8   H5T_STD_B8LE
 
#define H5T_ALPHA_B16   H5T_STD_B16LE
 
#define H5T_ALPHA_B32   H5T_STD_B32LE
 
#define H5T_ALPHA_B64   H5T_STD_B64LE
 
#define H5T_ALPHA_F32   H5T_IEEE_F32LE
 
#define H5T_ALPHA_F64   H5T_IEEE_F64LE
 
#define H5T_MIPS_I8   H5T_STD_I8BE
 
#define H5T_MIPS_I16   H5T_STD_I16BE
 
#define H5T_MIPS_I32   H5T_STD_I32BE
 
#define H5T_MIPS_I64   H5T_STD_I64BE
 
#define H5T_MIPS_U8   H5T_STD_U8BE
 
#define H5T_MIPS_U16   H5T_STD_U16BE
 
#define H5T_MIPS_U32   H5T_STD_U32BE
 
#define H5T_MIPS_U64   H5T_STD_U64BE
 
#define H5T_MIPS_B8   H5T_STD_B8BE
 
#define H5T_MIPS_B16   H5T_STD_B16BE
 
#define H5T_MIPS_B32   H5T_STD_B32BE
 
#define H5T_MIPS_B64   H5T_STD_B64BE
 
#define H5T_MIPS_F32   H5T_IEEE_F32BE
 
#define H5T_MIPS_F64   H5T_IEEE_F64BE
 
#define H5T_VAX_F32   (H5OPEN H5T_VAX_F32_g)
 
#define H5T_VAX_F64   (H5OPEN H5T_VAX_F64_g)
 
#define H5T_NATIVE_CHAR   (CHAR_MIN ? H5T_NATIVE_SCHAR : H5T_NATIVE_UCHAR)
 
#define H5T_NATIVE_SCHAR   (H5OPEN H5T_NATIVE_SCHAR_g)
 
#define H5T_NATIVE_UCHAR   (H5OPEN H5T_NATIVE_UCHAR_g)
 
#define H5T_NATIVE_SHORT   (H5OPEN H5T_NATIVE_SHORT_g)
 
#define H5T_NATIVE_USHORT   (H5OPEN H5T_NATIVE_USHORT_g)
 
#define H5T_NATIVE_INT   (H5OPEN H5T_NATIVE_INT_g)
 
#define H5T_NATIVE_UINT   (H5OPEN H5T_NATIVE_UINT_g)
 
#define H5T_NATIVE_LONG   (H5OPEN H5T_NATIVE_LONG_g)
 
#define H5T_NATIVE_ULONG   (H5OPEN H5T_NATIVE_ULONG_g)
 
#define H5T_NATIVE_LLONG   (H5OPEN H5T_NATIVE_LLONG_g)
 
#define H5T_NATIVE_ULLONG   (H5OPEN H5T_NATIVE_ULLONG_g)
 
#define H5T_NATIVE_FLOAT   (H5OPEN H5T_NATIVE_FLOAT_g)
 
#define H5T_NATIVE_DOUBLE   (H5OPEN H5T_NATIVE_DOUBLE_g)
 
#define H5T_NATIVE_LDOUBLE   (H5OPEN H5T_NATIVE_LDOUBLE_g)
 
#define H5T_NATIVE_B8   (H5OPEN H5T_NATIVE_B8_g)
 
#define H5T_NATIVE_B16   (H5OPEN H5T_NATIVE_B16_g)
 
#define H5T_NATIVE_B32   (H5OPEN H5T_NATIVE_B32_g)
 
#define H5T_NATIVE_B64   (H5OPEN H5T_NATIVE_B64_g)
 
#define H5T_NATIVE_OPAQUE   (H5OPEN H5T_NATIVE_OPAQUE_g)
 
#define H5T_NATIVE_HADDR   (H5OPEN H5T_NATIVE_HADDR_g)
 
#define H5T_NATIVE_HSIZE   (H5OPEN H5T_NATIVE_HSIZE_g)
 
#define H5T_NATIVE_HSSIZE   (H5OPEN H5T_NATIVE_HSSIZE_g)
 
#define H5T_NATIVE_HERR   (H5OPEN H5T_NATIVE_HERR_g)
 
#define H5T_NATIVE_HBOOL   (H5OPEN H5T_NATIVE_HBOOL_g)
 
#define H5T_NATIVE_INT8   (H5OPEN H5T_NATIVE_INT8_g)
 
#define H5T_NATIVE_UINT8   (H5OPEN H5T_NATIVE_UINT8_g)
 
#define H5T_NATIVE_INT_LEAST8   (H5OPEN H5T_NATIVE_INT_LEAST8_g)
 
#define H5T_NATIVE_UINT_LEAST8   (H5OPEN H5T_NATIVE_UINT_LEAST8_g)
 
#define H5T_NATIVE_INT_FAST8   (H5OPEN H5T_NATIVE_INT_FAST8_g)
 
#define H5T_NATIVE_UINT_FAST8   (H5OPEN H5T_NATIVE_UINT_FAST8_g)
 
#define H5T_NATIVE_INT16   (H5OPEN H5T_NATIVE_INT16_g)
 
#define H5T_NATIVE_UINT16   (H5OPEN H5T_NATIVE_UINT16_g)
 
#define H5T_NATIVE_INT_LEAST16   (H5OPEN H5T_NATIVE_INT_LEAST16_g)
 
#define H5T_NATIVE_UINT_LEAST16   (H5OPEN H5T_NATIVE_UINT_LEAST16_g)
 
#define H5T_NATIVE_INT_FAST16   (H5OPEN H5T_NATIVE_INT_FAST16_g)
 
#define H5T_NATIVE_UINT_FAST16   (H5OPEN H5T_NATIVE_UINT_FAST16_g)
 
#define H5T_NATIVE_INT32   (H5OPEN H5T_NATIVE_INT32_g)
 
#define H5T_NATIVE_UINT32   (H5OPEN H5T_NATIVE_UINT32_g)
 
#define H5T_NATIVE_INT_LEAST32   (H5OPEN H5T_NATIVE_INT_LEAST32_g)
 
#define H5T_NATIVE_UINT_LEAST32   (H5OPEN H5T_NATIVE_UINT_LEAST32_g)
 
#define H5T_NATIVE_INT_FAST32   (H5OPEN H5T_NATIVE_INT_FAST32_g)
 
#define H5T_NATIVE_UINT_FAST32   (H5OPEN H5T_NATIVE_UINT_FAST32_g)
 
#define H5T_NATIVE_INT64   (H5OPEN H5T_NATIVE_INT64_g)
 
#define H5T_NATIVE_UINT64   (H5OPEN H5T_NATIVE_UINT64_g)
 
#define H5T_NATIVE_INT_LEAST64   (H5OPEN H5T_NATIVE_INT_LEAST64_g)
 
#define H5T_NATIVE_UINT_LEAST64   (H5OPEN H5T_NATIVE_UINT_LEAST64_g)
 
#define H5T_NATIVE_INT_FAST64   (H5OPEN H5T_NATIVE_INT_FAST64_g)
 
#define H5T_NATIVE_UINT_FAST64   (H5OPEN H5T_NATIVE_UINT_FAST64_g)
 

Typedefs

typedef herr_t(* H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void *buf, void *bkg, hid_t dset_xfer_plist)
 
typedef H5T_conv_ret_t(* H5T_conv_except_func_t) (H5T_conv_except_t except_type, hid_t src_id, hid_t dst_id, void *src_buf, void *dst_buf, void *user_data)
 Exception handler. More...
 

Enumerations

enum  H5T_class_t {
  H5T_NO_CLASS = -1 , H5T_INTEGER = 0 , H5T_FLOAT = 1 , H5T_TIME = 2 ,
  H5T_STRING = 3 , H5T_BITFIELD = 4 , H5T_OPAQUE = 5 , H5T_COMPOUND = 6 ,
  H5T_REFERENCE = 7 , H5T_ENUM = 8 , H5T_VLEN = 9 , H5T_ARRAY = 10 ,
  H5T_NCLASSES
}
 
enum  H5T_order_t {
  H5T_ORDER_ERROR = -1 , H5T_ORDER_LE = 0 , H5T_ORDER_BE = 1 , H5T_ORDER_VAX = 2 ,
  H5T_ORDER_MIXED = 3 , H5T_ORDER_NONE = 4
}
 
enum  H5T_sign_t { H5T_SGN_ERROR = -1 , H5T_SGN_NONE = 0 , H5T_SGN_2 = 1 , H5T_NSGN = 2 }
 
enum  H5T_norm_t { H5T_NORM_ERROR = -1 , H5T_NORM_IMPLIED = 0 , H5T_NORM_MSBSET = 1 , H5T_NORM_NONE = 2 }
 
enum  H5T_cset_t {
  H5T_CSET_ERROR = -1 , H5T_CSET_ASCII = 0 , H5T_CSET_UTF8 = 1 , H5T_CSET_RESERVED_2 = 2 ,
  H5T_CSET_RESERVED_3 = 3 , H5T_CSET_RESERVED_4 = 4 , H5T_CSET_RESERVED_5 = 5 , H5T_CSET_RESERVED_6 = 6 ,
  H5T_CSET_RESERVED_7 = 7 , H5T_CSET_RESERVED_8 = 8 , H5T_CSET_RESERVED_9 = 9 , H5T_CSET_RESERVED_10 = 10 ,
  H5T_CSET_RESERVED_11 = 11 , H5T_CSET_RESERVED_12 = 12 , H5T_CSET_RESERVED_13 = 13 , H5T_CSET_RESERVED_14 = 14 ,
  H5T_CSET_RESERVED_15 = 15
}
 
enum  H5T_str_t {
  H5T_STR_ERROR = -1 , H5T_STR_NULLTERM = 0 , H5T_STR_NULLPAD = 1 , H5T_STR_SPACEPAD = 2 ,
  H5T_STR_RESERVED_3 = 3 , H5T_STR_RESERVED_4 = 4 , H5T_STR_RESERVED_5 = 5 , H5T_STR_RESERVED_6 = 6 ,
  H5T_STR_RESERVED_7 = 7 , H5T_STR_RESERVED_8 = 8 , H5T_STR_RESERVED_9 = 9 , H5T_STR_RESERVED_10 = 10 ,
  H5T_STR_RESERVED_11 = 11 , H5T_STR_RESERVED_12 = 12 , H5T_STR_RESERVED_13 = 13 , H5T_STR_RESERVED_14 = 14 ,
  H5T_STR_RESERVED_15 = 15
}
 
enum  H5T_pad_t {
  H5T_PAD_ERROR = -1 , H5T_PAD_ZERO = 0 , H5T_PAD_ONE = 1 , H5T_PAD_BACKGROUND = 2 ,
  H5T_NPAD = 3
}
 
enum  H5T_cmd_t { H5T_CONV_INIT = 0 , H5T_CONV_CONV = 1 , H5T_CONV_FREE = 2 }
 
enum  H5T_bkg_t { H5T_BKG_NO = 0 , H5T_BKG_TEMP = 1 , H5T_BKG_YES = 2 }
 
enum  H5T_pers_t { H5T_PERS_DONTCARE = -1 , H5T_PERS_HARD = 0 , H5T_PERS_SOFT = 1 }
 
enum  H5T_direction_t { H5T_DIR_DEFAULT = 0 , H5T_DIR_ASCEND = 1 , H5T_DIR_DESCEND = 2 }
 
enum  H5T_conv_except_t {
  H5T_CONV_EXCEPT_RANGE_HI = 0 , H5T_CONV_EXCEPT_RANGE_LOW = 1 , H5T_CONV_EXCEPT_PRECISION = 2 , H5T_CONV_EXCEPT_TRUNCATE = 3 ,
  H5T_CONV_EXCEPT_PINF = 4 , H5T_CONV_EXCEPT_NINF = 5 , H5T_CONV_EXCEPT_NAN = 6
}
 
enum  H5T_conv_ret_t { H5T_CONV_ABORT = -1 , H5T_CONV_UNHANDLED = 0 , H5T_CONV_HANDLED = 1 }
 

Functions

hid_t H5Tcreate (H5T_class_t type, size_t size)
 Creates a new datatype. More...
 
hid_t H5Tcopy (hid_t type_id)
 Copies an existing datatype. More...
 
herr_t H5Tclose (hid_t type_id)
 Releases a datatype. More...
 
htri_t H5Tequal (hid_t type1_id, hid_t type2_id)
 Determines whether two datatype identifiers refer to the same datatype. More...
 
herr_t H5Tlock (hid_t type_id)
 Locks a datatype. More...
 
herr_t H5Tcommit2 (hid_t loc_id, const char *name, hid_t type_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id)
 Commits a transient datatype, linking it into the file and creating a new committed datatype. More...
 
hid_t H5Topen2 (hid_t loc_id, const char *name, hid_t tapl_id)
 Opens a committed (named) datatype. More...
 
herr_t H5Tcommit_anon (hid_t loc_id, hid_t type_id, hid_t tcpl_id, hid_t tapl_id)
 Commits a transient datatype to a file, creating a new named datatype, but does not link it into the file structure. More...
 
hid_t H5Tget_create_plist (hid_t type_id)
 Returns a copy of a datatype's creation property list. More...
 
htri_t H5Tcommitted (hid_t type_id)
 Determines whether a datatype is a committed type or a transient type. More...
 
herr_t H5Tencode (hid_t obj_id, void *buf, size_t *nalloc)
 Encodes a datatype object description into a binary buffer. More...
 
hid_t H5Tdecode (const void *buf)
 Decodes a binary object description of datatype and return a new object handle. More...
 
herr_t H5Tinsert (hid_t parent_id, const char *name, size_t offset, hid_t member_id)
 Adds a new member to a compound datatype. More...
 
herr_t H5Tpack (hid_t type_id)
 Recursively removes padding from within a compound datatype. More...
 
hid_t H5Tenum_create (hid_t base_id)
 Creates a new enumeration datatype. More...
 
herr_t H5Tenum_insert (hid_t type, const char *name, const void *value)
 Inserts a new enumeration datatype member. More...
 
herr_t H5Tenum_nameof (hid_t type, const void *value, char *name, size_t size)
 Returns the symbol name corresponding to a specified member of an enumeration datatype. More...
 
herr_t H5Tenum_valueof (hid_t type, const char *name, void *value)
 Returns the value corresponding to a specified member of an enumeration datatype. More...
 
hid_t H5Tvlen_create (hid_t base_id)
 Creates a new variable-length array datatype. More...
 
hid_t H5Tarray_create2 (hid_t base_id, unsigned ndims, const hsize_t dim[])
 Creates an array datatype object. More...
 
int H5Tget_array_ndims (hid_t type_id)
 Returns the rank of an array datatype. More...
 
int H5Tget_array_dims2 (hid_t type_id, hsize_t dims[])
 Retrieves sizes of array dimensions. More...
 
herr_t H5Tset_tag (hid_t type, const char *tag)
 Tags an opaque datatype. More...
 
char * H5Tget_tag (hid_t type)
 Gets the tag associated with an opaque datatype. More...
 
hid_t H5Tget_super (hid_t type)
 Returns the base datatype from which a datatype is derived. More...
 
H5T_class_t H5Tget_class (hid_t type_id)
 Returns a datatype class. More...
 
htri_t H5Tdetect_class (hid_t type_id, H5T_class_t cls)
 Determines whether a datatype contains any datatypes of the given datatype class. More...
 
size_t H5Tget_size (hid_t type_id)
 Returns the size of a datatype. More...
 
H5T_order_t H5Tget_order (hid_t type_id)
 Returns the byte order of an atomic datatype. More...
 
size_t H5Tget_precision (hid_t type_id)
 Returns the precision of an atomic datatype. More...
 
int H5Tget_offset (hid_t type_id)
 Retrieves the bit offset of the first significant bit. More...
 
herr_t H5Tget_pad (hid_t type_id, H5T_pad_t *lsb, H5T_pad_t *msb)
 Retrieves the padding type of the least and most-significant bit padding. More...
 
H5T_sign_t H5Tget_sign (hid_t type_id)
 Retrieves the sign type for an integer type. More...
 
herr_t H5Tget_fields (hid_t type_id, size_t *spos, size_t *epos, size_t *esize, size_t *mpos, size_t *msize)
 Retrieves floating point datatype bit field information. More...
 
size_t H5Tget_ebias (hid_t type_id)
 Retrieves the exponent bias of a floating-point type. More...
 
H5T_norm_t H5Tget_norm (hid_t type_id)
 Retrieves mantissa normalization of a floating-point datatype. More...
 
H5T_pad_t H5Tget_inpad (hid_t type_id)
 Retrieves the internal padding type for unused bits in floating-point datatypes. More...
 
H5T_str_t H5Tget_strpad (hid_t type_id)
 Retrieves the type of padding used for a string datatype. More...
 
int H5Tget_nmembers (hid_t type_id)
 Retrieves the number of elements in a compound or enumeration datatype. More...
 
char * H5Tget_member_name (hid_t type_id, unsigned membno)
 Retrieves the name of a compound or enumeration datatype member. More...
 
int H5Tget_member_index (hid_t type_id, const char *name)
 Retrieves the index of a compound or enumeration datatype member. More...
 
size_t H5Tget_member_offset (hid_t type_id, unsigned membno)
 Retrieves the offset of a field of a compound datatype. More...
 
H5T_class_t H5Tget_member_class (hid_t type_id, unsigned membno)
 Returns datatype class of compound datatype member. More...
 
hid_t H5Tget_member_type (hid_t type_id, unsigned membno)
 Returns the datatype of the specified member. More...
 
herr_t H5Tget_member_value (hid_t type_id, unsigned membno, void *value)
 Returns the value of an enumeration datatype member. More...
 
H5T_cset_t H5Tget_cset (hid_t type_id)
 Retrieves the character set type of a string datatype. More...
 
htri_t H5Tis_variable_str (hid_t type_id)
 Determines whether datatype is a variable-length string. More...
 
hid_t H5Tget_native_type (hid_t type_id, H5T_direction_t direction)
 Returns the native datatype identifier of a specified datatype. More...
 
herr_t H5Tset_size (hid_t type_id, size_t size)
 Sets size for a datatype. More...
 
herr_t H5Tset_order (hid_t type_id, H5T_order_t order)
 Sets the byte order of a datatype. More...
 
herr_t H5Tset_precision (hid_t type_id, size_t prec)
 Sets the precision of an atomic datatype. More...
 
herr_t H5Tset_offset (hid_t type_id, size_t offset)
 Sets the bit offset of the first significant bit. More...
 
herr_t H5Tset_pad (hid_t type_id, H5T_pad_t lsb, H5T_pad_t msb)
 Sets the least and most-significant bits padding types. More...
 
herr_t H5Tset_sign (hid_t type_id, H5T_sign_t sign)
 Sets the sign property for an integer type. More...
 
herr_t H5Tset_fields (hid_t type_id, size_t spos, size_t epos, size_t esize, size_t mpos, size_t msize)
 Sets locations and sizes of floating point bit fields. More...
 
herr_t H5Tset_ebias (hid_t type_id, size_t ebias)
 Sets the exponent bias of a floating-point type. More...
 
herr_t H5Tset_norm (hid_t type_id, H5T_norm_t norm)
 Sets the mantissa normalization of a floating-point datatype. More...
 
herr_t H5Tset_inpad (hid_t type_id, H5T_pad_t pad)
 Fills unused internal floating-point bits. More...
 
herr_t H5Tset_cset (hid_t type_id, H5T_cset_t cset)
 Sets character set to be used in a string or character datatype. More...
 
herr_t H5Tset_strpad (hid_t type_id, H5T_str_t strpad)
 Defines the type of padding used for character strings. More...
 
herr_t H5Tregister (H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func)
 Registers a datatype conversion function. More...
 
herr_t H5Tunregister (H5T_pers_t pers, const char *name, hid_t src_id, hid_t dst_id, H5T_conv_t func)
 Removes a conversion function. More...
 
H5T_conv_t H5Tfind (hid_t src_id, hid_t dst_id, H5T_cdata_t **pcdata)
 Finds a conversion function. More...
 
htri_t H5Tcompiler_conv (hid_t src_id, hid_t dst_id)
 Check whether the library‚Äôs default conversion is hard conversion. More...
 
herr_t H5Tconvert (hid_t src_id, hid_t dst_id, size_t nelmts, void *buf, void *background, hid_t plist_id)
 Converts data from one specified datatype to another. More...
 
herr_t H5Tcommit1 (hid_t loc_id, const char *name, hid_t type_id)
 Commits a transient datatype to a file, creating a new named datatype. More...
 
hid_t H5Topen1 (hid_t loc_id, const char *name)
 Opens a named datatype. More...
 
hid_t H5Tarray_create1 (hid_t base_id, int ndims, const hsize_t dim[], const int perm[])
 Creates an array datatype object. More...
 
int H5Tget_array_dims1 (hid_t type_id, hsize_t dims[], int perm[])
 Retrieves sizes of array dimensions. More...
 

Variables

hid_t H5T_IEEE_F32BE_g
 
hid_t H5T_IEEE_F32LE_g
 
hid_t H5T_IEEE_F64BE_g
 
hid_t H5T_IEEE_F64LE_g
 
hid_t H5T_STD_I8BE_g
 
hid_t H5T_STD_I8LE_g
 
hid_t H5T_STD_I16BE_g
 
hid_t H5T_STD_I16LE_g
 
hid_t H5T_STD_I32BE_g
 
hid_t H5T_STD_I32LE_g
 
hid_t H5T_STD_I64BE_g
 
hid_t H5T_STD_I64LE_g
 
hid_t H5T_STD_U8BE_g
 
hid_t H5T_STD_U8LE_g
 
hid_t H5T_STD_U16BE_g
 
hid_t H5T_STD_U16LE_g
 
hid_t H5T_STD_U32BE_g
 
hid_t H5T_STD_U32LE_g
 
hid_t H5T_STD_U64BE_g
 
hid_t H5T_STD_U64LE_g
 
hid_t H5T_STD_B8BE_g
 
hid_t H5T_STD_B8LE_g
 
hid_t H5T_STD_B16BE_g
 
hid_t H5T_STD_B16LE_g
 
hid_t H5T_STD_B32BE_g
 
hid_t H5T_STD_B32LE_g
 
hid_t H5T_STD_B64BE_g
 
hid_t H5T_STD_B64LE_g
 
hid_t H5T_STD_REF_OBJ_g
 
hid_t H5T_STD_REF_DSETREG_g
 
hid_t H5T_UNIX_D32BE_g
 
hid_t H5T_UNIX_D32LE_g
 
hid_t H5T_UNIX_D64BE_g
 
hid_t H5T_UNIX_D64LE_g
 
hid_t H5T_C_S1_g
 
hid_t H5T_FORTRAN_S1_g
 
hid_t H5T_VAX_F32_g
 
hid_t H5T_VAX_F64_g
 
hid_t H5T_NATIVE_SCHAR_g
 
hid_t H5T_NATIVE_UCHAR_g
 
hid_t H5T_NATIVE_SHORT_g
 
hid_t H5T_NATIVE_USHORT_g
 
hid_t H5T_NATIVE_INT_g
 
hid_t H5T_NATIVE_UINT_g
 
hid_t H5T_NATIVE_LONG_g
 
hid_t H5T_NATIVE_ULONG_g
 
hid_t H5T_NATIVE_LLONG_g
 
hid_t H5T_NATIVE_ULLONG_g
 
hid_t H5T_NATIVE_FLOAT_g
 
hid_t H5T_NATIVE_DOUBLE_g
 
hid_t H5T_NATIVE_LDOUBLE_g
 
hid_t H5T_NATIVE_B8_g
 
hid_t H5T_NATIVE_B16_g
 
hid_t H5T_NATIVE_B32_g
 
hid_t H5T_NATIVE_B64_g
 
hid_t H5T_NATIVE_OPAQUE_g
 
hid_t H5T_NATIVE_HADDR_g
 
hid_t H5T_NATIVE_HSIZE_g
 
hid_t H5T_NATIVE_HSSIZE_g
 
hid_t H5T_NATIVE_HERR_g
 
hid_t H5T_NATIVE_HBOOL_g
 
hid_t H5T_NATIVE_INT8_g
 
hid_t H5T_NATIVE_UINT8_g
 
hid_t H5T_NATIVE_INT_LEAST8_g
 
hid_t H5T_NATIVE_UINT_LEAST8_g
 
hid_t H5T_NATIVE_INT_FAST8_g
 
hid_t H5T_NATIVE_UINT_FAST8_g
 
hid_t H5T_NATIVE_INT16_g
 
hid_t H5T_NATIVE_UINT16_g
 
hid_t H5T_NATIVE_INT_LEAST16_g
 
hid_t H5T_NATIVE_UINT_LEAST16_g
 
hid_t H5T_NATIVE_INT_FAST16_g
 
hid_t H5T_NATIVE_UINT_FAST16_g
 
hid_t H5T_NATIVE_INT32_g
 
hid_t H5T_NATIVE_UINT32_g
 
hid_t H5T_NATIVE_INT_LEAST32_g
 
hid_t H5T_NATIVE_UINT_LEAST32_g
 
hid_t H5T_NATIVE_INT_FAST32_g
 
hid_t H5T_NATIVE_UINT_FAST32_g
 
hid_t H5T_NATIVE_INT64_g
 
hid_t H5T_NATIVE_UINT64_g
 
hid_t H5T_NATIVE_INT_LEAST64_g
 
hid_t H5T_NATIVE_UINT_LEAST64_g
 
hid_t H5T_NATIVE_INT_FAST64_g
 
hid_t H5T_NATIVE_UINT_FAST64_g
 

Macro Definition Documentation

◆ H5OPEN

#define H5OPEN   H5open(),

◆ H5T_NCSET

#define H5T_NCSET   H5T_CSET_RESERVED_2 /*Number of character sets actually defined */

◆ H5T_NSTR

#define H5T_NSTR   H5T_STR_RESERVED_3 /*num H5T_str_t types actually defined */

◆ H5T_OPAQUE_TAG_MAX

#define H5T_OPAQUE_TAG_MAX   256

Maximum length of an opaque tag

◆ H5T_VARIABLE

#define H5T_VARIABLE   ((size_t)(-1))

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

◆ HOFFSET

#define HOFFSET (   S,
 
)    (offsetof(S, M))

Typedef Documentation

◆ H5T_conv_except_func_t

typedef H5T_conv_ret_t(* H5T_conv_except_func_t) (H5T_conv_except_t except_type, hid_t src_id, hid_t dst_id, void *src_buf, void *dst_buf, void *user_data)

Exception handler.

Parameters
[in]except_typeThe kind of exception that occurred
[in]src_idSource datatype identifier
[in]dst_idDestination datatype identifier
[in]src_bufSource data buffer
[in,out]dst_bufDestination data buffer
[in,out]user_dataCallback context
Returns
Valid callback function return values are H5T_CONV_ABORT, H5T_CONV_UNHANDLED and H5T_CONV_HANDLED.

If an exception like overflow happens during conversion, this function is called if it's registered through H5Pset_type_conv_cb().

◆ H5T_conv_t

typedef herr_t(* H5T_conv_t) (hid_t src_id, hid_t dst_id, H5T_cdata_t *cdata, size_t nelmts, size_t buf_stride, size_t bkg_stride, void *buf, void *bkg, hid_t dset_xfer_plist)

All datatype conversion functions are...

Enumeration Type Documentation

◆ H5T_bkg_t

enum H5T_bkg_t

How is the ‘bkg’ buffer used by the conversion function?

Enumerator
H5T_BKG_NO 

background buffer is not needed, send NULL

H5T_BKG_TEMP 

bkg buffer used as temp storage only

H5T_BKG_YES 

init bkg buf with data before conversion

◆ H5T_class_t

These are the various classes of datatypes internal If this goes over 16 types (0-15), the file format will need to change.

Enumerator
H5T_NO_CLASS 

error

H5T_INTEGER 

integer types

H5T_FLOAT 

floating-point types

H5T_TIME 

date and time types

H5T_STRING 

character string types

H5T_BITFIELD 

bit field types

H5T_OPAQUE 

opaque types

H5T_COMPOUND 

compound types

H5T_REFERENCE 

reference types

H5T_ENUM 

enumeration types

H5T_VLEN 

variable-Length types

H5T_ARRAY 

array types

H5T_NCLASSES 

sentinel: this must be last

◆ H5T_cmd_t

enum H5T_cmd_t

Commands sent to conversion functions

Enumerator
H5T_CONV_INIT 

query and/or initialize private data

H5T_CONV_CONV 

convert data from source to dest datatype

H5T_CONV_FREE 

function is being removed from path

◆ H5T_conv_except_t

The exception type passed into the conversion callback function

Enumerator
H5T_CONV_EXCEPT_RANGE_HI 

Source value is greater than destination's range

H5T_CONV_EXCEPT_RANGE_LOW 

Source value is less than destination's range

H5T_CONV_EXCEPT_PRECISION 

Source value loses precision in destination

H5T_CONV_EXCEPT_TRUNCATE 

Source value is truncated in destination

H5T_CONV_EXCEPT_PINF 

Source value is positive infinity

H5T_CONV_EXCEPT_NINF 

Source value is negative infinity

H5T_CONV_EXCEPT_NAN 

Source value is NaN (not a number, including QNaN and SNaN)

◆ H5T_conv_ret_t

The return value from conversion callback function H5T_conv_except_func_t()

Enumerator
H5T_CONV_ABORT 

abort conversion

H5T_CONV_UNHANDLED 

callback function failed to handle the exception

H5T_CONV_HANDLED 

callback function handled the exception successfully

◆ H5T_cset_t

enum H5T_cset_t

Character set to use for text strings.

Enumerator
H5T_CSET_ERROR 

error

H5T_CSET_ASCII 

US ASCII

H5T_CSET_UTF8 

UTF-8 Unicode encoding

H5T_CSET_RESERVED_2 

reserved for later use

H5T_CSET_RESERVED_3 

reserved for later use

H5T_CSET_RESERVED_4 

reserved for later use

H5T_CSET_RESERVED_5 

reserved for later use

H5T_CSET_RESERVED_6 

reserved for later use

H5T_CSET_RESERVED_7 

reserved for later use

H5T_CSET_RESERVED_8 

reserved for later use

H5T_CSET_RESERVED_9 

reserved for later use

H5T_CSET_RESERVED_10 

reserved for later use

H5T_CSET_RESERVED_11 

reserved for later use

H5T_CSET_RESERVED_12 

reserved for later use

H5T_CSET_RESERVED_13 

reserved for later use

H5T_CSET_RESERVED_14 

reserved for later use

H5T_CSET_RESERVED_15 

reserved for later use

◆ H5T_direction_t

The order to retrieve atomic native datatype

Enumerator
H5T_DIR_DEFAULT 

default direction is ascending

H5T_DIR_ASCEND 

in ascending order

H5T_DIR_DESCEND 

in descending order

◆ H5T_norm_t

enum H5T_norm_t

Floating-point normalization schemes

Enumerator
H5T_NORM_ERROR 

error

H5T_NORM_IMPLIED 

msb of mantissa isn't stored, always 1

H5T_NORM_MSBSET 

msb of mantissa is always 1

H5T_NORM_NONE 

not normalized

◆ H5T_order_t

Byte orders

Enumerator
H5T_ORDER_ERROR 

error

H5T_ORDER_LE 

little endian

H5T_ORDER_BE 

bit endian

H5T_ORDER_VAX 

VAX mixed endian

H5T_ORDER_MIXED 

Compound type with mixed member orders

H5T_ORDER_NONE 

no particular order (strings, bits,..)

◆ H5T_pad_t

enum H5T_pad_t

Type of padding to use in other atomic types

Enumerator
H5T_PAD_ERROR 

error

H5T_PAD_ZERO 

always set to zero

H5T_PAD_ONE 

always set to one

H5T_PAD_BACKGROUND 

set to background value

H5T_NPAD 

sentinel: THIS MUST BE LAST

◆ H5T_pers_t

enum H5T_pers_t

Conversion function persistence

Enumerator
H5T_PERS_DONTCARE 

wild card

H5T_PERS_HARD 

hard conversion function

H5T_PERS_SOFT 

soft conversion function

◆ H5T_sign_t

enum H5T_sign_t

Types of integer sign schemes

Enumerator
H5T_SGN_ERROR 

error

H5T_SGN_NONE 

this is an unsigned type

H5T_SGN_2 

two's complement

H5T_NSGN 

◆ H5T_str_t

enum H5T_str_t

Type of padding to use in character strings.

Enumerator
H5T_STR_ERROR 

error

H5T_STR_NULLTERM 

null terminate like in C

H5T_STR_NULLPAD 

pad with nulls

H5T_STR_SPACEPAD 

pad with spaces like in Fortran

H5T_STR_RESERVED_3 

reserved for later use

H5T_STR_RESERVED_4 

reserved for later use

H5T_STR_RESERVED_5 

reserved for later use

H5T_STR_RESERVED_6 

reserved for later use

H5T_STR_RESERVED_7 

reserved for later use

H5T_STR_RESERVED_8 

reserved for later use

H5T_STR_RESERVED_9 

reserved for later use

H5T_STR_RESERVED_10 

reserved for later use

H5T_STR_RESERVED_11 

reserved for later use

H5T_STR_RESERVED_12 

reserved for later use

H5T_STR_RESERVED_13 

reserved for later use

H5T_STR_RESERVED_14 

reserved for later use

H5T_STR_RESERVED_15 

reserved for later use

Variable Documentation

◆ H5T_C_S1_g

hid_t H5T_C_S1_g
extern

◆ H5T_FORTRAN_S1_g

hid_t H5T_FORTRAN_S1_g
extern

◆ H5T_IEEE_F32BE_g

hid_t H5T_IEEE_F32BE_g
extern

◆ H5T_IEEE_F32LE_g

hid_t H5T_IEEE_F32LE_g
extern

◆ H5T_IEEE_F64BE_g

hid_t H5T_IEEE_F64BE_g
extern

◆ H5T_IEEE_F64LE_g

hid_t H5T_IEEE_F64LE_g
extern

◆ H5T_NATIVE_B16_g

hid_t H5T_NATIVE_B16_g
extern

◆ H5T_NATIVE_B32_g

hid_t H5T_NATIVE_B32_g
extern

◆ H5T_NATIVE_B64_g

hid_t H5T_NATIVE_B64_g
extern

◆ H5T_NATIVE_B8_g

hid_t H5T_NATIVE_B8_g
extern

◆ H5T_NATIVE_DOUBLE_g

hid_t H5T_NATIVE_DOUBLE_g
extern

◆ H5T_NATIVE_FLOAT_g

hid_t H5T_NATIVE_FLOAT_g
extern

◆ H5T_NATIVE_HADDR_g

hid_t H5T_NATIVE_HADDR_g
extern

◆ H5T_NATIVE_HBOOL_g

hid_t H5T_NATIVE_HBOOL_g
extern

◆ H5T_NATIVE_HERR_g

hid_t H5T_NATIVE_HERR_g
extern

◆ H5T_NATIVE_HSIZE_g

hid_t H5T_NATIVE_HSIZE_g
extern

◆ H5T_NATIVE_HSSIZE_g

hid_t H5T_NATIVE_HSSIZE_g
extern

◆ H5T_NATIVE_INT16_g

hid_t H5T_NATIVE_INT16_g
extern

◆ H5T_NATIVE_INT32_g

hid_t H5T_NATIVE_INT32_g
extern

◆ H5T_NATIVE_INT64_g

hid_t H5T_NATIVE_INT64_g
extern

◆ H5T_NATIVE_INT8_g

hid_t H5T_NATIVE_INT8_g
extern

◆ H5T_NATIVE_INT_FAST16_g

hid_t H5T_NATIVE_INT_FAST16_g
extern

◆ H5T_NATIVE_INT_FAST32_g

hid_t H5T_NATIVE_INT_FAST32_g
extern

◆ H5T_NATIVE_INT_FAST64_g

hid_t H5T_NATIVE_INT_FAST64_g
extern

◆ H5T_NATIVE_INT_FAST8_g

hid_t H5T_NATIVE_INT_FAST8_g
extern

◆ H5T_NATIVE_INT_g

hid_t H5T_NATIVE_INT_g
extern

◆ H5T_NATIVE_INT_LEAST16_g

hid_t H5T_NATIVE_INT_LEAST16_g
extern

◆ H5T_NATIVE_INT_LEAST32_g

hid_t H5T_NATIVE_INT_LEAST32_g
extern

◆ H5T_NATIVE_INT_LEAST64_g

hid_t H5T_NATIVE_INT_LEAST64_g
extern

◆ H5T_NATIVE_INT_LEAST8_g

hid_t H5T_NATIVE_INT_LEAST8_g
extern

◆ H5T_NATIVE_LDOUBLE_g

hid_t H5T_NATIVE_LDOUBLE_g
extern

◆ H5T_NATIVE_LLONG_g

hid_t H5T_NATIVE_LLONG_g
extern

◆ H5T_NATIVE_LONG_g

hid_t H5T_NATIVE_LONG_g
extern

◆ H5T_NATIVE_OPAQUE_g

hid_t H5T_NATIVE_OPAQUE_g
extern

◆ H5T_NATIVE_SCHAR_g

hid_t H5T_NATIVE_SCHAR_g
extern

◆ H5T_NATIVE_SHORT_g

hid_t H5T_NATIVE_SHORT_g
extern

◆ H5T_NATIVE_UCHAR_g

hid_t H5T_NATIVE_UCHAR_g
extern

◆ H5T_NATIVE_UINT16_g

hid_t H5T_NATIVE_UINT16_g
extern

◆ H5T_NATIVE_UINT32_g

hid_t H5T_NATIVE_UINT32_g
extern

◆ H5T_NATIVE_UINT64_g

hid_t H5T_NATIVE_UINT64_g
extern

◆ H5T_NATIVE_UINT8_g

hid_t H5T_NATIVE_UINT8_g
extern

◆ H5T_NATIVE_UINT_FAST16_g

hid_t H5T_NATIVE_UINT_FAST16_g
extern

◆ H5T_NATIVE_UINT_FAST32_g

hid_t H5T_NATIVE_UINT_FAST32_g
extern

◆ H5T_NATIVE_UINT_FAST64_g

hid_t H5T_NATIVE_UINT_FAST64_g
extern

◆ H5T_NATIVE_UINT_FAST8_g

hid_t H5T_NATIVE_UINT_FAST8_g
extern

◆ H5T_NATIVE_UINT_g

hid_t H5T_NATIVE_UINT_g
extern

◆ H5T_NATIVE_UINT_LEAST16_g

hid_t H5T_NATIVE_UINT_LEAST16_g
extern

◆ H5T_NATIVE_UINT_LEAST32_g

hid_t H5T_NATIVE_UINT_LEAST32_g
extern

◆ H5T_NATIVE_UINT_LEAST64_g

hid_t H5T_NATIVE_UINT_LEAST64_g
extern

◆ H5T_NATIVE_UINT_LEAST8_g

hid_t H5T_NATIVE_UINT_LEAST8_g
extern

◆ H5T_NATIVE_ULLONG_g

hid_t H5T_NATIVE_ULLONG_g
extern

◆ H5T_NATIVE_ULONG_g

hid_t H5T_NATIVE_ULONG_g
extern

◆ H5T_NATIVE_USHORT_g

hid_t H5T_NATIVE_USHORT_g
extern

◆ H5T_STD_B16BE_g

hid_t H5T_STD_B16BE_g
extern

◆ H5T_STD_B16LE_g

hid_t H5T_STD_B16LE_g
extern

◆ H5T_STD_B32BE_g

hid_t H5T_STD_B32BE_g
extern

◆ H5T_STD_B32LE_g

hid_t H5T_STD_B32LE_g
extern

◆ H5T_STD_B64BE_g

hid_t H5T_STD_B64BE_g
extern

◆ H5T_STD_B64LE_g

hid_t H5T_STD_B64LE_g
extern

◆ H5T_STD_B8BE_g

hid_t H5T_STD_B8BE_g
extern

◆ H5T_STD_B8LE_g

hid_t H5T_STD_B8LE_g
extern

◆ H5T_STD_I16BE_g

hid_t H5T_STD_I16BE_g
extern

◆ H5T_STD_I16LE_g

hid_t H5T_STD_I16LE_g
extern

◆ H5T_STD_I32BE_g

hid_t H5T_STD_I32BE_g
extern

◆ H5T_STD_I32LE_g

hid_t H5T_STD_I32LE_g
extern

◆ H5T_STD_I64BE_g

hid_t H5T_STD_I64BE_g
extern

◆ H5T_STD_I64LE_g

hid_t H5T_STD_I64LE_g
extern

◆ H5T_STD_I8BE_g

hid_t H5T_STD_I8BE_g
extern

◆ H5T_STD_I8LE_g

hid_t H5T_STD_I8LE_g
extern

◆ H5T_STD_REF_DSETREG_g

hid_t H5T_STD_REF_DSETREG_g
extern

◆ H5T_STD_REF_OBJ_g

hid_t H5T_STD_REF_OBJ_g
extern

◆ H5T_STD_U16BE_g

hid_t H5T_STD_U16BE_g
extern

◆ H5T_STD_U16LE_g

hid_t H5T_STD_U16LE_g
extern

◆ H5T_STD_U32BE_g

hid_t H5T_STD_U32BE_g
extern

◆ H5T_STD_U32LE_g

hid_t H5T_STD_U32LE_g
extern

◆ H5T_STD_U64BE_g

hid_t H5T_STD_U64BE_g
extern

◆ H5T_STD_U64LE_g

hid_t H5T_STD_U64LE_g
extern

◆ H5T_STD_U8BE_g

hid_t H5T_STD_U8BE_g
extern

◆ H5T_STD_U8LE_g

hid_t H5T_STD_U8LE_g
extern

◆ H5T_UNIX_D32BE_g

hid_t H5T_UNIX_D32BE_g
extern

◆ H5T_UNIX_D32LE_g

hid_t H5T_UNIX_D32LE_g
extern

◆ H5T_UNIX_D64BE_g

hid_t H5T_UNIX_D64BE_g
extern

◆ H5T_UNIX_D64LE_g

hid_t H5T_UNIX_D64LE_g
extern

◆ H5T_VAX_F32_g

hid_t H5T_VAX_F32_g
extern

◆ H5T_VAX_F64_g

hid_t H5T_VAX_F64_g
extern