./src/H5_ff.f90

H5LIB

NAME

  MODULE H5LIB

PURPOSE

  This module provides fortran specific helper functions for the HDF library

USES

  H5LIB_PROVISIONAL - This module provides helper functions for Fortran 2003
                      only features. If Fortran 2003 functions are enabled then
                      H5_ff_F03.f90 is compiled, else H5_ff_F90.f90,
                      which is just a place holder blank module, is compiled.

NOTES

                         *** IMPORTANT ***
  If you add a new function 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.

h5check_version_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5check_version_f

PURPOSE

  Verifies that library versions are consistent.

INPUTS

  majnum               - major version of the library
  minum                - minor version of the library
  relnum               - release version of the library

OUTPUTS

  error                - error code
                          Success:  0
                          Failure:  application aborts

AUTHOR

  Elena Pourmal
  September 24, 2002

SOURCE

  SUBROUTINE h5check_version_f(majnum, minnum, relnum, error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(IN) :: majnum, minnum, relnum
    INTEGER, INTENT(OUT) :: error

h5close_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5close_f

PURPOSE

  Closes the HDF5 library and Fortran90 interface.

OUTPUTS

  error - error code
            Success:  0
            Failure: -1

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

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

SOURCE

  SUBROUTINE h5close_f(error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: error

h5dont_atexit_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5dont_atexit_f

PURPOSE

  Instructs library not to install atexit cleanup routine.

OUTPUTS

  error  - error code
             Success:  0
             Failure: -1

AUTHOR

  Elena Pourmal
  September 24, 2002

SOURCE

  SUBROUTINE h5dont_atexit_f(error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: error

h5garbage_collect_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5garbage_collect_f

PURPOSE

  Garbage collects on all free-lists of all types.

OUTPUTS

  error  - error code
             Success:  0
             Failure: -1

AUTHOR

  Elena Pourmal
  September 24, 2002

SOURCE

  SUBROUTINE h5garbage_collect_f(error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: error

h5get_libversion_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5get_libversion_f

PURPOSE

  Returns the HDF5 LIbrary release number

OUTPUTS

  majnum               - major version of the library
  minum                - minor version of the library
  relnum               - release version of the library
  error                - error code
                           Success:  0
                           Failure: -1

AUTHOR

  Elena Pourmal
  September 24, 2002

SOURCE

  SUBROUTINE h5get_libversion_f(majnum, minnum, relnum, error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: majnum, minnum, relnum, error

h5kind_to_type

[ Top ] [ H5LIB ] [ Functions ]

NAME

  h5kind_to_type

PURPOSE

  Converts the KIND to the correct HDF type

INPUTS

  kind    - Fortran KIND parameter
  flag    - whether KIND is of type INTEGER or REAL:
              H5_INTEGER_KIND - integer
              H5_REAL_KIND    - real

OUTPUTS

  h5_type - returns the type

AUTHOR

  M. Scot Breitenfeld
  Augest 25, 2008

SOURCE

  INTEGER(HID_T) FUNCTION h5kind_to_type(kind, flag) RESULT(h5_type)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(IN) :: kind
    INTEGER, INTENT(IN) :: flag

h5open_f

[ Top ] [ H5LIB ] [ Subroutines ]

NAME

  h5open_f

PURPOSE

  Initializes the HDF5 library and Fortran90 interface.

OUTPUTS

  error - error code
            Success:  0
            Failure: -1

AUTHOR

  Elena Pourmal
  August 12, 1999

HISTORY

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

SOURCE

  SUBROUTINE h5open_f(error)
    USE H5GLOBAL
    IMPLICIT NONE
    INTEGER, INTENT(OUT) :: error