H5public.h File Reference

#include "H5pubconf.h"
#include "H5version.h"
#include "H5api_adpt.h"

Go to the source code of this file.

Data Structures
struct	H5_ih_info_t
struct	H5O_token_t

Macros
#define	H5_GCC_DIAG_OFF(x)
#define	H5_GCC_DIAG_ON(x)
#define	H5_VERS_MAJOR   1 /* For major interface/format changes */
#define	H5_VERS_MINOR   12 /* For minor interface/format changes */
#define	H5_VERS_RELEASE   0 /* For tweaks, bug-fixes, or development */
#define	H5_VERS_SUBRELEASE   "" /* For pre-releases like snap0 */
#define	H5_VERS_INFO   "HDF5 library version: 1.12.0" /* Full version string */
#define	H5check()
#define	H5_VERSION_GE(Maj, Min, Rel)
#define	H5_VERSION_LE(Maj, Min, Rel)
#define	bool   unsigned int
#define	true   1
#define	false   0
#define	H5_SIZEOF_SSIZE_T   H5_SIZEOF_INT
#define	HSIZE_UNDEF   ((hsize_t)(hssize_t)(-1))
#define	H5_PRINTF_HADDR_FMT   "%u"
#define	HADDR_MAX   (HADDR_UNDEF-1)
#define	H5_ITER_ERROR   (-1)
#define	H5_ITER_CONT   (0)
#define	H5_ITER_STOP   (1)
#define	H5O_MAX_TOKEN_SIZE   (16) /* Allows for 128-bit tokens */

Typedefs
typedef int	herr_t
typedef bool	hbool_t
typedef int	htri_t
typedef int	ssize_t
typedef enum H5_index_t	H5_index_t
typedef struct H5_ih_info_t	H5_ih_info_t
typedef struct H5O_token_t	H5O_token_t

Enumerations
enum	H5_iter_order_t {   H5_ITER_UNKNOWN = -1, H5_ITER_INC, H5_ITER_DEC, H5_ITER_NATIVE,   H5_ITER_N }
enum	H5_index_t { H5_INDEX_UNKNOWN = -1, H5_INDEX_NAME, H5_INDEX_CRT_ORDER, H5_INDEX_N }

Functions
H5_DLL herr_t	H5open (void)
H5_DLL herr_t	H5close (void)
H5_DLL herr_t	H5dont_atexit (void)
H5_DLL herr_t	H5garbage_collect (void)
H5_DLL herr_t	H5set_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)
H5_DLL herr_t	H5get_libversion (unsigned *majnum, unsigned *minnum, unsigned *relnum)
H5_DLL herr_t	H5check_version (unsigned majnum, unsigned minnum, unsigned relnum)
H5_DLL herr_t	H5is_library_threadsafe (hbool_t *is_ts)
H5_DLL herr_t	H5free_memory (void *mem)
H5_DLL void *	H5allocate_memory (size_t size, hbool_t clear)
H5_DLL void *	H5resize_memory (void *mem, size_t size)

Macro Definition Documentation

bool

#define bool   unsigned int

false

#define false   0

H5_GCC_DIAG_OFF

#define H5_GCC_DIAG_OFF

(

x

)

H5_GCC_DIAG_ON

#define H5_GCC_DIAG_ON

(

x

)

H5_ITER_CONT

#define H5_ITER_CONT   (0)

H5_ITER_ERROR

#define H5_ITER_ERROR   (-1)

H5_ITER_STOP

#define H5_ITER_STOP   (1)

H5_PRINTF_HADDR_FMT

#define H5_PRINTF_HADDR_FMT   "%u"

H5_SIZEOF_SSIZE_T

#define H5_SIZEOF_SSIZE_T   H5_SIZEOF_INT

H5_VERS_INFO

#define H5_VERS_INFO   "HDF5 library version: 1.12.0" /* Full version string */

H5_VERS_MAJOR

#define H5_VERS_MAJOR   1 /* For major interface/format changes */

H5_VERS_MINOR

#define H5_VERS_MINOR   12 /* For minor interface/format changes */

H5_VERS_RELEASE

#define H5_VERS_RELEASE   0 /* For tweaks, bug-fixes, or development */

H5_VERS_SUBRELEASE

#define H5_VERS_SUBRELEASE   "" /* For pre-releases like snap0 */

H5_VERSION_GE

#define H5_VERSION_GE	(		Maj,
			Min,
			Rel
	)

Value:

       (((H5_VERS_MAJOR==Maj) && (H5_VERS_MINOR==Min) && (H5_VERS_RELEASE>=Rel)) || \
        ((H5_VERS_MAJOR==Maj) && (H5_VERS_MINOR>Min)) || \
        (H5_VERS_MAJOR>Maj))

H5_VERSION_LE

#define H5_VERSION_LE	(		Maj,
			Min,
			Rel
	)

Value:

       (((H5_VERS_MAJOR==Maj) && (H5_VERS_MINOR==Min) && (H5_VERS_RELEASE<=Rel)) || \
        ((H5_VERS_MAJOR==Maj) && (H5_VERS_MINOR<Min)) || \
        (H5_VERS_MAJOR<Maj))

H5check

#define H5check

(

)

Value:

                        H5check_version(H5_VERS_MAJOR,H5_VERS_MINOR,          \
                        H5_VERS_RELEASE)

H5O_MAX_TOKEN_SIZE

#define H5O_MAX_TOKEN_SIZE   (16) /* Allows for 128-bit tokens */

HADDR_MAX

#define HADDR_MAX   (HADDR_UNDEF-1)

HSIZE_UNDEF

#define HSIZE_UNDEF   ((hsize_t)(hssize_t)(-1))

true

#define true   1

Typedef Documentation

H5_ih_info_t

typedef struct H5_ih_info_t H5_ih_info_t

H5_index_t

typedef enum H5_index_t H5_index_t

H5O_token_t

typedef struct H5O_token_t H5O_token_t

hbool_t

typedef bool hbool_t

herr_t

CATCH herr_t

htri_t

typedef int htri_t

ssize_t

typedef int ssize_t

Enumeration Type Documentation

H5_index_t

enum H5_index_t

Enumerator
H5_INDEX_UNKNOWN
H5_INDEX_NAME
H5_INDEX_CRT_ORDER
H5_INDEX_N

H5_iter_order_t

enum H5_iter_order_t

Enumerator
H5_ITER_UNKNOWN
H5_ITER_INC
H5_ITER_DEC
H5_ITER_NATIVE
H5_ITER_N

Function Documentation

H5allocate_memory()

H5_DLL void* H5allocate_memory	(	size_t	size,
		hbool_t	clear
	)

H5check_version()

H5_DLL herr_t H5check_version	(	unsigned	majnum,
		unsigned	minnum,
		unsigned	relnum
	)

H5close()

H5_DLL herr_t H5close

(

void

)

H5dont_atexit()

H5_DLL herr_t H5dont_atexit

(

void

)

H5free_memory()

H5_DLL herr_t H5free_memory

(

void *

mem

)

H5garbage_collect()

H5_DLL herr_t H5garbage_collect

(

void

)

H5get_libversion()

H5_DLL herr_t H5get_libversion	(	unsigned *	majnum,
		unsigned *	minnum,
		unsigned *	relnum
	)

H5is_library_threadsafe()

H5_DLL herr_t H5is_library_threadsafe

(

hbool_t *

is_ts

)

H5open()

H5_DLL herr_t H5open

(

void

)

H5resize_memory()

H5_DLL void* H5resize_memory	(	void *	mem,
		size_t	size
	)

H5set_free_list_limits()

H5_DLL herr_t H5set_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
	)