Fortran Error (H5E) Interface

Detailed Description

See also

Error Handling (H5E), C-API

HDF5 Error Handling, User Guide

Modules
module	h5e
	This module contains Fortran interfaces for H5E functions.

Functions/Subroutines
subroutine	h5eclear_f (hdferr, estack_id)
	Clears the error stack for the current thread.
subroutine	h5eprint_f (hdferr, name)
	Prints the error stack in a default manner.
subroutine	h5eget_major_f (error_no, name, namelen, hdferr)
	Returns a character string describing an error specified by a major error number.
subroutine	h5eget_minor_f (error_no, name, hdferr)
	Returns a character string describing an error specified by a minor error number.
subroutine	h5eset_auto_f (printflag, hdferr, estack_id, func, client_data)
	Returns settings for automatic error stack traversal function and its data.

Variables
integer(hid_t)	h5e_default_f
	H5E_DEFAULT.
integer	h5e_major_f
	H5E_MAJOR.
integer	h5e_minor_f
	H5E_MINOR.
integer	h5e_walk_upward_f
	H5E_WALK_UPWARD.
integer	h5e_walk_downward_f
	H5E_WALK_DOWNWARD.

Function/Subroutine Documentation

h5eclear_f()

subroutine h5eclear_f	(	integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	estack_id
	)

Clears the error stack for the current thread.

Parameters

hdferr	Returns 0 if successful and -1 if it fails.
estack_id	Error Stack id

See C API: H5Eclear2()

h5eget_major_f()

subroutine h5eget_major_f	(	integer, intent(in)	error_no,
		character(len=*), intent(out)	name,
		integer(size_t), intent(in)	namelen,
		integer, intent(out)	hdferr
	)

Returns a character string describing an error specified by a major error number.

Parameters

error_no	Major error number.
name	Character string describing the error.
namelen	Number of characters in the name buffer.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Eget_major()

h5eget_minor_f()

subroutine h5eget_minor_f	(	integer, intent(in)	error_no,
		character(len=*), intent(out)	name,
		integer, intent(out)	hdferr
	)

Returns a character string describing an error specified by a minor error number.

Parameters

error_no	Minor error number.
name	Character string describing the error.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Eget_minor()

h5eprint_f()

subroutine h5eprint_f	(	integer, intent(out)	hdferr,
		character(len=*), intent(in), optional	name
	)

Prints the error stack in a default manner.

Parameters

hdferr	Returns 0 if successful and -1 if it fails.
name	Name of the file that contains print output

See C API: H5Eprint2()

h5eset_auto_f()

subroutine h5eset_auto_f	(	integer, intent(in)	printflag,
		integer, intent(out)	hdferr,
		integer(hid_t), intent(in), optional	estack_id,
		type(c_funptr), intent(in), optional	func,
		type(c_ptr), intent(in), optional	client_data
	)

Returns settings for automatic error stack traversal function and its data.

Parameters

printflag	Flag to turn automatic error printing on or off; possible values are: printon (1) printoff(0)
estack_id	Error stack identifier.
func	Function to be called upon an error condition.
client_data	Data passed to the error function.
hdferr	Returns 0 if successful and -1 if it fails.

See C API: H5Eset_auto2()

Variable Documentation

h5e_default_f

integer(hid_t) h5e_default_f

H5E_DEFAULT.

h5e_major_f

integer h5e_major_f

H5E_MAJOR.

h5e_minor_f

integer h5e_minor_f

H5E_MINOR.

h5e_walk_downward_f

integer h5e_walk_downward_f

H5E_WALK_DOWNWARD.

h5e_walk_upward_f

integer h5e_walk_upward_f

H5E_WALK_UPWARD.