HDF5 FORTRAN Developer's Guide

## H5R

[ Top ] [ Modules ]

NAME

      MODULE H5R

FILE

      fortran/src/H5Rff.f90

PURPOSE

      This file contains Fortran interfaces for H5R functions. It includes
      all the functions that are independent on whether the Fortran 2003 functions
      are enabled or disabled.

NOTES

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

## h5rget_object_type_obj_f

[ Top ] [ H5R ] [ Subroutines ]

NAME

      h5rget_object_type_obj_f

PURPOSE

      Retrieves the type of object that an object reference points to.

INPUTS

      dset_id       - identifier of the dataset containing
                      reference to the objects
      ref           - reference to open

OUTPUTS

      obj_type      - object_type, possible values:
                        H5G_UNKNOWN_F     (-1)
                        H5G_GROUP_F        0
                        H5G_DATASET_F      1
                        H5G_TYPE_F         2
                        H5G_LINK_F         3
      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).  February 28, 2001

NOTES

      This is a module procedure for the h5rget_object_type_f
      subroutine.

SOURCE

      SUBROUTINE h5rget_object_type_obj_f(dset_id, ref, obj_type, hdferr)
        IMPLICIT NONE
        INTEGER(HID_T), INTENT(IN) :: dset_id   ! Dataset identifier
        TYPE(hobj_ref_t_f), INTENT(IN) :: ref   ! Object reference
        INTEGER, INTENT(OUT) :: obj_type     ! Object type
                                             !  H5G_UNKNOWN_F     (-1)
                                             !  H5G_GROUP_F        0
                                             !  H5G_DATASET_F      1
                                             !  H5G_TYPE_F         2
                                             !  H5G_LINK_F         3
        INTEGER, INTENT(OUT) :: hdferr       ! Error code

## h5rget_region_region_f

[ Top ] [ H5R ] [ Subroutines ]

NAME

      h5rget_region_region_f

PURPOSE

      Retrieves a dataspace with the specified region selected

INPUTS

      dset_id       - identifier of the dataset containing
                      reference to the regions
      ref           - reference to open

OUTPUTS

      space_id      - dataspace identifier
      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).  February 28, 2001

NOTES

      This is a module procedure for the h5rget_region_f subroutine.

SOURCE

      SUBROUTINE h5rget_region_region_f(dset_id, ref, space_id, hdferr)
        IMPLICIT NONE
        INTEGER(HID_T), INTENT(IN) :: dset_id      ! Dataset identifier
        TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Dataset region reference
        INTEGER(HID_T), INTENT(OUT) :: space_id    ! Space identifier
        INTEGER, INTENT(OUT) :: hdferr             ! Error code