Help us improve by taking our short survey: https://www.hdfgroup.org/website-survey/

| HDF5 Last Updated on 2026-07-28 The HDF5 Field Guide

Loading...
Searching...
No Matches
h5e Module Reference
Fortran Error (H5E) Interface

This module contains Fortran interfaces for H5E functions. More...

## Data Types
type | h5e_error_t
| h5e_error_t derived type More...
interface | h5eprint_c
interface | h5eprint_f

## Functions/Subroutines
subroutine | h5eappend_stack_f (dst_stack_id, src_stack_id, close_source_stack, hdferr)
| Appends one error stack to another, optionally closing the source stack.
subroutine | h5eclear_f (hdferr, estack_id)
| Clears the error stack for the current thread.
subroutine | h5eclose_msg_f (err_id, hdferr)
| Closes an error message.
subroutine | h5eclose_stack_f (err_stack_id, hdferr)
| Closes an error stack handle.
subroutine | h5ecreate_msg_f (class_id, msg_type, msg, err_id, hdferr)
| Adds a major or minor error message to an error class.
subroutine | h5ecreate_stack_f (err_stack_id, hdferr)
| Creates a new, empty error stack.
subroutine | h5eget_class_name_f (class_id, name, hdferr, size)
| Retrieves an error message.
subroutine | h5eget_current_stack_f (err_stack_id, hdferr)
| Returns a copy of the current error stack.
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 | h5eget_msg_f (msg_id, msg_type, msg, hdferr, msg_size)
| Retrieves an error message.
subroutine | h5eget_num_f (error_stack_id, count, hdferr)
| Retrieves the number of error messages in an error stack.
subroutine | h5epop_f (err_stack_id, count, hdferr)
| Deletes specified number of error messages from the error stack.
subroutine | h5eprint_f (err_stack, hdferr, name)
subroutine | h5eprint_f (hdferr, name)
| Prints the error stack in a default manner.
subroutine | h5epush_f (err_stack, file, func, line, cls_id, maj_id, min_id, msg, hdferr, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10, arg11, arg12, arg13, arg14, arg15, arg16, arg17, arg18, arg19, arg20)
| Pushes a new error record onto an error stack.
subroutine | h5eregister_class_f (cls_name, lib_name, version, class_id, hdferr)
| Registers a client library or application program to the HDF5 error API.
subroutine | h5eset_auto_f (printflag, hdferr, estack_id, func, client_data)
| Returns settings for automatic error stack traversal function and its data.
subroutine | h5eset_current_stack_f (err_stack_id, hdferr)
| Replaces the current error stack.
subroutine | h5eunregister_class_f (class_id, hdferr)
| Removes an error class.
subroutine | h5ewalk_f (err_stack, direction, op, op_data, hdferr)
| Walks the specified error stack, calling the specified function.

## Variables
integer, parameter | printoff = 0
| Turn off automatic printing of errors.
integer, parameter | printon = 1
| Turn on automatic printing of errors.

## Detailed Description

This module contains Fortran interfaces for H5E functions.

## Function/Subroutine Documentation

## ◆ h5eprint_f()

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

## Variable Documentation

## ◆ printoff

integer, parameter printoff = 0

Turn off automatic printing of errors.

## ◆ printon

integer, parameter printon = 1

Turn on automatic printing of errors.