H5E

[ Top ] [ Modules ]

NAME

  MODULE H5E

FILE

  fortran/src/H5Eff.f90

PURPOSE

  This Module contains Fortran interfaces for H5E functions.

NOTES

                         *** IMPORTANT ***
  If you add a new H5E function to the module you must add the function name
  to the Windows dll file 'hdf5_fortrandll.def' in the fortran/src directory.
  This is needed for Windows based operating systems.

h5eclear_f

[ Top ] [ H5E ] [ Subroutines ]

NAME

  h5eclear_f

PURPOSE

  Clears the error stack for the current thread.

OUTPUTS

  hdferr        - Returns 0 if successful and -1 if fails

OPTIONAL PARAMETERS

  estack_id     - Error Stack id

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

  Explicit Fortran interfaces were added for
  called C functions (it is needed for Windows
  port).  April 6, 2001

  Added optional error stack identifier in order to bring
  the function in line with the h5eclear2 routine.
  MSB, July 9, 2009

SOURCE

  SUBROUTINE h5eclear_f(hdferr, estack_id)
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: hdferr  ! Error code
    INTEGER(HID_T), OPTIONAL, INTENT(IN) :: estack_id

h5eget_major_f

[ Top ] [ H5E ] [ Subroutines ]

NAME

  h5eget_major_f

PURPOSE

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

INPUTS

  error_no      - major error number

OUTPUTS

  name          - character string describing the error
  namelen       - number of characters in the name buffer
  hdferr        - Returns 0 if successful and -1 if fails

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

  Explicit Fortran interfaces were added for
  called C functions (it is needed for Windows
  port).  April 6, 2001

SOURCE

  SUBROUTINE h5eget_major_f(error_no, name, namelen, hdferr)
    INTEGER, INTENT(IN) :: error_no        ! Major error number
    CHARACTER(LEN=*), INTENT(OUT) :: name  ! Character string describing
                                           ! the error.
    INTEGER(SIZE_T), INTENT(IN) :: namelen ! Anticipated number of characters
                                           ! in name.
    INTEGER, INTENT(OUT) :: hdferr         ! Error code

h5eget_minor_f

[ Top ] [ H5E ] [ Subroutines ]

NAME

  h5eget_minor_f

PURPOSE

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

INPUTS

  error_no      - minor error number

OUTPUTS

  name          - character string describing the error
  hdferr        - Returns 0 if successful and -1 if fails

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

  Explicit Fortran interfaces were added for
  called C functions (it is needed for Windows
  port).  April 6, 2001

SOURCE

  SUBROUTINE h5eget_minor_f(error_no, name, hdferr)
    INTEGER, INTENT(IN) :: error_no       ! Major error number
    CHARACTER(LEN=*), INTENT(OUT) :: name ! Character string describing
                                          ! the error
    INTEGER, INTENT(OUT) :: hdferr        ! Error code

h5eprint_f

[ Top ] [ H5E ] [ Subroutines ]

NAME

  h5eprint_f

PURPOSE

  Prints the error stack in a default manner.

OUTPUTS

  hdferr        - Returns 0 if successful and -1 if fails

OPTIONAL PARAMETERS

  name          - name of the file that contains print output

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

  Explicit Fortran interfaces were added for
  called C functions (it is needed for Windows
  port).  April 6, 2001

SOURCE

  SUBROUTINE h5eprint_f(hdferr, name)
    CHARACTER(LEN=*), OPTIONAL, INTENT(IN) :: name ! File name
    INTEGER, INTENT(OUT) :: hdferr          ! Error code