H5public.h File Reference

#include "H5pubconf.h"
#include "H5version.h"
#include <features.h>
#include <sys/types.h>
#include <limits.h>
#include <stdarg.h>
#include <stdint.h>
#include <inttypes.h>
#include <stddef.h>
#include "H5api_adpt.h"
#include <stdbool.h>

Data Structures
struct	H5_ih_info_t
	[H5_index_t_snip] More...
struct	H5O_token_t
	[H5O_token_t_snip] More...
struct	H5_alloc_stats_t
	[H5O_token_t_snip] More...

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   13 /* 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.13.0" /* Full version string */
#define	H5check()
#define	H5_VERSION_GE(Maj, Min, Rel)
#define	H5_VERSION_LE(Maj, Min, Rel)
#define	H5_SIZEOF_HSIZE_T   H5_SIZEOF_LONG_LONG
#define	H5_SIZEOF_HSSIZE_T   H5_SIZEOF_LONG_LONG
#define	HSIZE_UNDEF   ((hsize_t)(hssize_t)(-1))
#define	HADDR_UNDEF   ((haddr_t)(long)(-1))
#define	H5_SIZEOF_HADDR_T   H5_SIZEOF_LONG
#define	H5_PRINTF_HADDR_FMT   "%lu"
#define	HADDR_MAX   (HADDR_UNDEF-1)
#define	H5_ITER_ERROR   (-1)
	[H5_iter_order_t_snip] More...
#define	H5_ITER_CONT   (0)
#define	H5_ITER_STOP   (1)
#define	H5O_MAX_TOKEN_SIZE   (16)
	[H5_ih_info_t_snip] More...

Typedefs
typedef int	herr_t
typedef bool	hbool_t
typedef int	htri_t
typedef unsigned long long	hsize_t
typedef signed long long	hssize_t
typedef unsigned long	haddr_t

Enumerations
enum	H5_iter_order_t {   H5_ITER_UNKNOWN = -1, H5_ITER_INC, H5_ITER_DEC, H5_ITER_NATIVE,   H5_ITER_N }
	[H5_iter_order_t_snip] More...
enum	H5_index_t { H5_INDEX_UNKNOWN = -1, H5_INDEX_NAME, H5_INDEX_CRT_ORDER, H5_INDEX_N }
	[H5_index_t_snip] More...

Functions
herr_t	H5open (void)
	Initializes the HDF5 library. More...
herr_t	H5close (void)
	Flushes all data to disk, closes all open objects, and releases memory. More...
herr_t	H5dont_atexit (void)
	Instructs library not to install atexit() cleanup routine. More...
herr_t	H5garbage_collect (void)
	Garbage collects on all free-lists of all types. More...
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)
	Sets free-list size limits. More...
herr_t	H5get_free_list_sizes (size_t *reg_size, size_t *arr_size, size_t *blk_size, size_t *fac_size)
	Gets the current size of the free lists used to manage memory. More...
herr_t	H5get_alloc_stats (H5_alloc_stats_t *stats)
	Gets the memory allocation statistics for the library. More...
herr_t	H5get_libversion (unsigned *majnum, unsigned *minnum, unsigned *relnum)
	Returns the HDF library release number. More...
herr_t	H5check_version (unsigned majnum, unsigned minnum, unsigned relnum)
	Verifies that HDF5 library versions are consistent. More...
herr_t	H5is_library_threadsafe (hbool_t *is_ts)
	Determines whether the HDF5 library was built with the thread-safety feature enabled. More...
herr_t	H5free_memory (void *mem)
	Frees memory allocated by the HDF5 library. More...
void *	H5allocate_memory (size_t size, hbool_t clear)
	Frees memory allocated by the HDF5 library. More...
void *	H5resize_memory (void *mem, size_t size)
	Resizes and, if required, re-allocates memory that will later be freed internally by the HDF5 library. More...

Macro Definition Documentation

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_order_t_snip]

H5_ITER_STOP

#define H5_ITER_STOP   (1)

H5_PRINTF_HADDR_FMT

#define H5_PRINTF_HADDR_FMT   "%lu"

H5_SIZEOF_HADDR_T

#define H5_SIZEOF_HADDR_T   H5_SIZEOF_LONG

H5_SIZEOF_HSIZE_T

#define H5_SIZEOF_HSIZE_T   H5_SIZEOF_LONG_LONG

H5_SIZEOF_HSSIZE_T

#define H5_SIZEOF_HSSIZE_T   H5_SIZEOF_LONG_LONG

H5_VERS_INFO

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

H5_VERS_MAJOR

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

H5_VERS_MINOR

#define H5_VERS_MINOR   13 /* 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)

[H5_ih_info_t_snip]

The maximum size allowed for tokens

Tokens are unique and permanent identifiers that are used to reference HDF5 objects in a container. This allows for 128-bit tokens

HADDR_MAX

#define HADDR_MAX   (HADDR_UNDEF-1)

HADDR_UNDEF

#define HADDR_UNDEF   ((haddr_t)(long)(-1))

HSIZE_UNDEF

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

Typedef Documentation

haddr_t

typedef unsigned long haddr_t

hbool_t

typedef bool hbool_t

herr_t

typedef int herr_t

hsize_t

typedef unsigned long long hsize_t

hssize_t

typedef signed long long hssize_t

htri_t

typedef int htri_t

Enumeration Type Documentation

H5_index_t

enum H5_index_t

[H5_index_t_snip]

The types of indices on links in groups/attributes on objects. Primarily used for "<do> <foo> by index" routines and for iterating over links in groups/attributes on objects.

Enumerator
H5_INDEX_UNKNOWN	Unknown index type
H5_INDEX_NAME	Index on names
H5_INDEX_CRT_ORDER	Index on creation order
H5_INDEX_N	Number of indices defined

H5_iter_order_t

enum H5_iter_order_t

[H5_iter_order_t_snip]

Common iteration orders

Enumerator
H5_ITER_UNKNOWN	Unknown order
H5_ITER_INC	Increasing order
H5_ITER_DEC	Decreasing order
H5_ITER_NATIVE	No particular order, whatever is fastest
H5_ITER_N	Number of iteration orders