H5R (F90)
NAME
MODULE H5R_PROVISIONAL
FILE
fortran/src/H5Rff_F90.f90
PURPOSE
This file contains Fortran 90 interfaces for H5R functions. It contains the same functions as H5Rff_F03.f90 but excludes the Fortran 2003 functions and the interface listings. This file will be compiled instead of H5Rff_F03.f90 if Fortran 2003 functions are not enabled.
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.
h5rcreate_object_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rcreate_object_f
PURPOSE
Creates reference to the object
INPUTS
loc_id - location identifier name - name of the object at the specified location
OUTPUTS
ref - reference to the specified object
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). February 28, 2001
NOTES
This is a module procedure for the h5rcreate_f subroutine.
SOURCE
SUBROUTINE h5rcreate_object_f(loc_id, name, ref, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object at location specified ! by loc_id identifier TYPE(hobj_ref_t_f), INTENT(OUT) :: ref ! Object reference INTEGER, INTENT(OUT) :: hdferr ! Error code
h5rcreate_region_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rcreate_region_f
PURPOSE
Creates reference to the dataset region
INPUTS
loc_id - location identifier name - name of the dataset at the specified location space_id - dataspace identifier that describes selected region
OUTPUTS
ref - reference to the dataset region
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). February 28, 2001
NOTES
This is a module procedure for the h5rcreate_f subroutine.
SOURCE
SUBROUTINE h5rcreate_region_f(loc_id, name, space_id, ref, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: loc_id ! Location identifier CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the dataset at location specified ! by loc_id identifier INTEGER(HID_T), INTENT(IN) :: space_id ! Dataset's dataspace identifier TYPE(hdset_reg_ref_t_f), INTENT(OUT) :: ref ! Dataset region reference INTEGER, INTENT(OUT) :: hdferr ! Error code
h5rdereference_object_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rdereference_object_f
PURPOSE
Opens the HDF5 object referenced
INPUTS
dset_id - identifier of the dataset containing reference ref - reference to open
OUTPUTS
obj_id - object_identifier
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). February 28, 2001
NOTES
This is a module procedure for the h5rdereference_f subroutine.
SOURCE
SUBROUTINE h5rdereference_object_f(dset_id, ref, obj_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier TYPE(hobj_ref_t_f), INTENT(IN) :: ref ! Object reference INTEGER(HID_T), INTENT(OUT) :: obj_id ! Object identifier INTEGER, INTENT(OUT) :: hdferr ! Error code
h5rdereference_region_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rdereference_region_f
PURPOSE
Opens the dataset region
INPUTS
dset_id - identifier of the dataset containing
reference to teh regions
ref - reference to open
OUTPUTS
obj_id - dataspace identifier
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). February 28, 2001
NOTES
This is a module procedure for the h5rdereference_f subroutine.
SOURCE
SUBROUTINE h5rdereference_region_f(dset_id, ref, obj_id, hdferr) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: dset_id ! Dataset identifier TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Object reference INTEGER(HID_T), INTENT(OUT) :: obj_id ! Dataspace identifier INTEGER, INTENT(OUT) :: hdferr ! Error code
h5rget_name_object_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rget_name_object_f
PURPOSE
Retrieves a name of a referenced object.
INPUTS
loc_id - Identifier for the dataset containing the reference or for the group that dataset is in. ref - An object or dataset region reference.
OUTPUTS
name - A name associated with the referenced object or dataset region.
hdferr - error code
Success: 0
Failure: -1
OPTIONAL PARAMETERS
size - The size of the name buffer.
AUTHOR
M. Scot Breitenfeld March 28, 2008 SOURCES or for the group that dataset is in. returning 0 (zero) if no name is associated with the identifier
h5rget_name_region_f
[ Top ] [ H5R (F90) ] [ Subroutines ]
NAME
h5rget_name_region_f
PURPOSE
Retrieves a name of a dataset region.
INPUTS
loc_id - Identifier for the dataset containing the reference or
for the group that dataset is in.
ref - An object or dataset region reference.
OUTPUTS
name - A name associated with the referenced object or dataset region.
hdferr - error code
Success: 0
Failure: -1
OPTIONAL PARAMETERS
size - The size of the name buffer.
AUTHOR
M. Scot Breitenfeld March 28, 2008
SOURCE
SUBROUTINE h5rget_name_region_f(loc_id, ref, name, hdferr, size) IMPLICIT NONE INTEGER(HID_T), INTENT(IN) :: loc_id ! Identifier for the dataset containing the reference ! or for the group that dataset is in. TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref ! Object reference INTEGER(SIZE_T), OPTIONAL, INTENT(OUT) :: size ! The size of the name buffer, ! returning 0 (zero) if no name is associated ! with the identifier CHARACTER(LEN=*), INTENT(OUT) :: name ! A name associated with the referenced object or dataset region. INTEGER, INTENT(OUT) :: hdferr ! Error code