H5Epublic.h File Reference

#include <stdio.h>
#include "H5public.h"
#include "H5Ipublic.h"
#include "H5Epubgen.h"

Data Structures
struct	H5E_error2_t
struct	H5E_error1_t

Macros
#define	H5E_DEFAULT   (hid_t)0
#define	H5OPEN   H5open(),
#define	H5E_ERR_CLS   (H5OPEN H5E_ERR_CLS_g)
#define	H5E_BEGIN_TRY
#define	H5E_END_TRY
#define	H5Epush_sim(func, cls, maj, min, str)   H5Epush2(H5E_DEFAULT, __FILE__, func, __LINE__, cls, maj, min, str)
#define	H5Epush_ret(func, cls, maj, min, str, ret)
#define	H5Epush_goto(func, cls, maj, min, str, label)

Typedefs
typedef herr_t(*	H5E_walk2_t) (unsigned n, const H5E_error2_t *err_desc, void *client_data)
	[H5E_walk2_t_snip] More...
typedef herr_t(*	H5E_auto2_t) (hid_t estack, void *client_data)
	[H5E_walk2_t_snip] More...
typedef hid_t	H5E_major_t
typedef hid_t	H5E_minor_t
typedef herr_t(*	H5E_walk1_t) (int n, H5E_error1_t *err_desc, void *client_data)
	[H5E_walk1_t_snip] More...
typedef herr_t(*	H5E_auto1_t) (void *client_data)

Enumerations
enum	H5E_type_t { H5E_MAJOR, H5E_MINOR, H5E_MAJOR, H5E_MINOR }
enum	H5E_direction_t { H5E_WALK_UPWARD = 0, H5E_WALK_DOWNWARD = 1, H5E_WALK_UPWARD = 0, H5E_WALK_DOWNWARD = 1 }

Functions
herr_t	H5Eauto_is_v2 (hid_t estack_id, unsigned *is_stack)
	[H5E_auto2_t_snip] More...
herr_t	H5Eclear2 (hid_t estack_id)
	Clears the specified error stack or the error stack for the current thread. More...
herr_t	H5Eclose_msg (hid_t err_id)
	Closes an error message identifier. More...
herr_t	H5Eclose_stack (hid_t estack_id)
	Closes object handle for error stack. More...
hid_t	H5Ecreate_msg (hid_t cls, H5E_type_t msg_type, const char *msg)
	Adds major error message to an error class. More...
hid_t	H5Ecreate_stack (void)
	Creates a new empty error stack. More...
herr_t	H5Eget_auto2 (hid_t estack_id, H5E_auto2_t *func, void **client_data)
	Returns the settings for the automatic error stack traversal function and its data. More...
ssize_t	H5Eget_class_name (hid_t class_id, char *name, size_t size)
	Retrieves error class name. More...
hid_t	H5Eget_current_stack (void)
	Returns a copy of the current error stack. More...
ssize_t	H5Eget_msg (hid_t msg_id, H5E_type_t *type, char *msg, size_t size)
	Retrieves an error message. More...
ssize_t	H5Eget_num (hid_t estack_id)
	Retrieves the number of error messages in an error stack. More...
herr_t	H5Epop (hid_t estack_id, size_t count)
	Close an error message identifier. More...
herr_t	H5Eprint2 (hid_t estack_id, FILE *stream)
	Prints the specified error stack in a default manner. More...
herr_t	H5Epush2 (hid_t estack_id, const char *file, const char *func, unsigned line, hid_t cls_id, hid_t maj_id, hid_t min_id, const char *msg,...)
	Pushes new error record onto error stack. More...
hid_t	H5Eregister_class (const char *cls_name, const char *lib_name, const char *version)
	Registers a client library or application program to the HDF5 error API. More...
herr_t	H5Eset_auto2 (hid_t estack_id, H5E_auto2_t func, void *client_data)
	Turns automatic error printing on or off. More...
herr_t	H5Eset_current_stack (hid_t estack_id)
	Replaces the current error stack. More...
herr_t	H5Eunregister_class (hid_t class_id)
	Removes an error class. More...
herr_t	H5Ewalk2 (hid_t estack_id, H5E_direction_t direction, H5E_walk2_t func, void *client_data)
	Walks the specified error stack, calling the specified function. More...
herr_t	H5Eclear1 (void)
	[H5E_auto1_t_snip] More...
herr_t	H5Eget_auto1 (H5E_auto1_t *func, void **client_data)
	Returns the settings for the automatic error stack traversal function and its data. More...
char *	H5Eget_major (H5E_major_t maj)
char *	H5Eget_minor (H5E_minor_t min)
herr_t	H5Eprint1 (FILE *stream)
	Prints the specified error stack in a default manner. More...
herr_t	H5Epush1 (const char *file, const char *func, unsigned line, H5E_major_t maj_id, H5E_minor_t min_id, const char *msg)
	Pushes new error record onto error stack. More...
herr_t	H5Eset_auto1 (H5E_auto1_t func, void *client_data)
	Turns automatic error printing on or off. More...
herr_t	H5Ewalk1 (H5E_direction_t direction, H5E_walk1_t func, void *client_data)
	Walks the specified error stack, calling the specified function. More...

Variables
hid_t	H5E_ERR_CLS_g

Macro Definition Documentation

H5E_BEGIN_TRY

#define H5E_BEGIN_TRY

Value:

    {                                 \
    unsigned H5E_saved_is_v2;                                 \
    union {                                   \
        H5E_auto1_t efunc1;                           \
        H5E_auto2_t efunc2;                               \
    } H5E_saved;                                  \
    void *H5E_saved_edata;                            \
                                              \
    (void)H5Eauto_is_v2(H5E_DEFAULT, &H5E_saved_is_v2);                   \
    if(H5E_saved_is_v2) {                             \
        (void)H5Eget_auto2(H5E_DEFAULT, &H5E_saved.efunc2, &H5E_saved_edata); \
        (void)H5Eset_auto2(H5E_DEFAULT, NULL, NULL);                      \
    } else {                                      \
        (void)H5Eget_auto1(&H5E_saved.efunc1, &H5E_saved_edata);              \
        (void)H5Eset_auto1(NULL, NULL);                       \
    }

H5E_DEFAULT

#define H5E_DEFAULT   (hid_t)0

H5E_END_TRY

#define H5E_END_TRY

Value:

    if(H5E_saved_is_v2)                               \
        (void)H5Eset_auto2(H5E_DEFAULT, H5E_saved.efunc2, H5E_saved_edata);   \
    else                                      \
        (void)H5Eset_auto1(H5E_saved.efunc1, H5E_saved_edata);            \
}

H5E_ERR_CLS

#define H5E_ERR_CLS   (H5OPEN H5E_ERR_CLS_g)

H5Epush_goto

#define H5Epush_goto	(		func,
			cls,
			maj,
			min,
			str,
			label
	)

Value:

    {                 \
    H5Epush2(H5E_DEFAULT, __FILE__, func, __LINE__, cls, maj, min, str);      \
    goto label;                                   \
}

H5Epush_ret

#define H5Epush_ret	(		func,
			cls,
			maj,
			min,
			str,
			ret
	)

Value:

    {                 \
    H5Epush2(H5E_DEFAULT, __FILE__, func, __LINE__, cls, maj, min, str);      \
    return(ret);                                  \
}

H5Epush_sim

#define H5Epush_sim	(		func,
			cls,
			maj,
			min,
			str
	)		H5Epush2(H5E_DEFAULT, __FILE__, func, __LINE__, cls, maj, min, str)

H5OPEN

#define H5OPEN   H5open(),

Typedef Documentation

H5E_auto1_t

typedef herr_t(* H5E_auto1_t) (void *client_data)

[H5E_walk1_t_snip] [H5E_auto1_t_snip]

H5E_auto2_t

typedef herr_t(* H5E_auto2_t) (hid_t estack, void *client_data)

[H5E_walk2_t_snip]

[H5E_auto2_t_snip]

H5E_major_t

typedef hid_t H5E_major_t

H5E_minor_t

typedef hid_t H5E_minor_t

H5E_walk1_t

typedef herr_t(* H5E_walk1_t) (int n, H5E_error1_t *err_desc, void *client_data)

[H5E_walk1_t_snip]

Error stack traversal callback function pointers

H5E_walk2_t

typedef herr_t(* H5E_walk2_t) (unsigned n, const H5E_error2_t *err_desc, void *client_data)

[H5E_walk2_t_snip]

Error stack traversal callback function pointers

Enumeration Type Documentation

H5E_direction_t

enum H5E_direction_t

Enumerator
H5E_WALK_UPWARD
H5E_WALK_DOWNWARD
H5E_WALK_UPWARD
H5E_WALK_DOWNWARD

H5E_type_t

enum H5E_type_t

Enumerator
H5E_MAJOR
H5E_MINOR
H5E_MAJOR
H5E_MINOR

Function Documentation

H5Eget_major()

char* H5Eget_major

(

H5E_major_t

maj

)

H5Eget_minor()

char* H5Eget_minor

(

H5E_minor_t

min

)

Variable Documentation

H5E_ERR_CLS_g

hid_t H5E_ERR_CLS_g