H5I

[ Top ] [ Modules ]

NAME

  MODULE H5I

FILE

  fortran/src/H5Iff.f90

PURPOSE

  This file contains Fortran interfaces for H5I functions.

NOTES

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

h5idec_ref_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5idec_ref_f

PURPOSE

  Decrements the reference count of an ID

INPUTS

  obj_id        - Object identifier

OUTPUTS

  ref_count     - Current reference count of the ID
  hdferr:       - Error code
                   Success:  0
                   Failure: -1

AUTHOR

  Quincey Koziol
  December  9, 2003

SOURCE

  SUBROUTINE h5idec_ref_f(obj_id, ref_count, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
    INTEGER, INTENT(OUT) :: hdferr       ! Error code

h5iget_file_id_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iget_file_id_f

PURPOSE

  Obtains file identifier from the object identifier

INPUTS

  obj_id        - object identifier

OUTPUTS

  file_id       - file identifier
  hdferr:       - error code
                    Success:  0
                    Failure: -1

AUTHOR

  Elena Pourmal
  August 23, 2004

SOURCE

  SUBROUTINE h5iget_file_id_f(obj_id, file_id, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN)  :: obj_id   ! Object identifier
    INTEGER(HID_T), INTENT(OUT) :: file_id  ! File identifier
    INTEGER, INTENT(OUT) :: hdferr          ! Error code

h5iget_name_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iget_name_f

PURPOSE

  Gets a name of an object specified by its idetifier.

INPUTS

  obj_id    - attribute identifier
  buf_size  - size of a buffer to read name in

OUTPUTS

  buf       - buffer to read name in, name will be truncated if
              buffer is not big enough
  name_size - name size
  hdferr:   - error code
               Success:  0
               Failure: -1

AUTHOR

  Elena Pourmal
  March 12, 2003

SOURCE

  SUBROUTINE h5iget_name_f(obj_id, buf, buf_size, name_size, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: obj_id      ! Object identifier
    INTEGER(SIZE_T), INTENT(IN) :: buf_size   ! Buffer size
    CHARACTER(LEN=*), INTENT(OUT) :: buf      ! Buffer to hold object name
    INTEGER(SIZE_T), INTENT(OUT) :: name_size ! Actual name size
    INTEGER, INTENT(OUT) :: hdferr            ! Error code:
                                              !   0 if successful,
                                              !   -1 if fail

h5iget_ref_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iget_ref_f

PURPOSE

  Retrieves the reference count of an ID

INPUTS

  obj_id        - object identifier

OUTPUTS

  ref_count     - Current reference count of the ID
  hdferr:         - error code
  Success:  0
  Failure: -1

AUTHOR

  Quincey Koziol
  December  9, 2003

SOURCE

  SUBROUTINE h5iget_ref_f(obj_id, ref_count, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
    INTEGER, INTENT(OUT) :: hdferr       ! Error code

h5iget_type_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iget_type_f

PURPOSE

  Retrieves the type of an object.

INPUTS

  obj_id   - object identifier

OUTPUTS

  type     - type of the object, possible values:
              H5I_FILE_F
              H5I_GROUP_F
              H5I_DATATYPE_F
              H5I_DATASPACE_F
              H5I_DATASET_F
              H5I_ATTR_F
              H5I_BADID_F
  hdferr:  - 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).  March 5, 2001

SOURCE

  SUBROUTINE h5iget_type_f(obj_id, TYPE, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: obj_id  ! Object identifier
    INTEGER, INTENT(OUT) :: TYPE ! type of an object.
                                 ! possible values are:
                                 !   H5I_FILE_F
                                 !   H5I_GROUP_F
                                 !   H5I_DATATYPE_F
                                 !   H5I_DATASPACE_F
                                 !   H5I_DATASET_F
                                 !   H5I_ATTR_F
                                 !   H5I_BADID_F
    INTEGER, INTENT(OUT) :: hdferr  ! Error code

h5iinc_ref_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iinc_ref_f

PURPOSE

  Increments the reference count of an ID

INPUTS

  obj_id        - object identifier

OUTPUTS

  ref_count     - Current reference count of the ID
  hdferr:              - error code
  Success:  0
  Failure: -1

AUTHOR

  Quincey Koziol
  December  9, 2003

SOURCE

  SUBROUTINE h5iinc_ref_f(obj_id, ref_count, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN) :: obj_id ! Object identifier
    INTEGER, INTENT(OUT) :: ref_count    ! Current reference count of ID
    INTEGER, INTENT(OUT) :: hdferr       ! Error code

h5iis_valid_f

[ Top ] [ H5I ] [ Subroutines ]

NAME

  h5iget_file_id_f

PURPOSE

  Check if an ID is valid without producing an error message

INPUTS

  id           - identifier

OUTPUTS

  valid        - status of id as a valid identifier
  hdferr:      - error code            
                  Success:  0
                  Failure: -1

AUTHOR

  M. Scot Breitenfeld
  April 13, 2009

SOURCE

  SUBROUTINE h5iis_valid_f(id, valid, hdferr)
    IMPLICIT NONE
    INTEGER(HID_T), INTENT(IN)  :: id ! Identifier 
    LOGICAL, INTENT(OUT) :: valid     ! Status of id as a valid identifier
    INTEGER, INTENT(OUT) :: hdferr    ! Error code