Last modified: 25 November 2009
Name: H5Eget_minor
Signature:
  char * `H5Eget_minor`(H5E_minor_t `n`)

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

Notice:
  This function has been deprecated.

Description:
  Given a minor error number, `H5Eget_minor` returns a constant character string that describes the error.

Note:
  In the Release 1.8.x series, `H5Eget_minor` returns a string of dynamic allocated char array. An application calling this function from an HDF5 library of Release 1.8.0 or later must free the memory associated with the return value to prevent a memory leak. This is a change from the 1.6.x release series.

Parameters:

  H5E_minor_t `n` | IN: Minor error number.

Returns:
  Returns a character string describing the error if successful. Otherwise returns "Invalid minor error number."

Fortran90 Interface: h5eget_minor_f

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

      END SUBROUTINE h5eget_minor_f

History:

  Release | Change
  1.8.0 | Function deprecated and return type changed in this release.