hobj_ref_t_f derived type
- See also
- References (H5R), C-API
-
The HDF5 References, User Guide
|
module | h5r |
| This module contains Fortran interfaces for H5R functions.
|
|
|
subroutine | h5rget_object_type_f (dset_id, ref, obj_type, hdferr) |
| Retrieves the type of object that an object reference points to.
|
|
subroutine | h5rget_region_f (dset_id, ref, space_id, hdferr) |
| Retrieves a dataspace with the specified region selected using pointer.
|
|
subroutine | h5rcreate_f (loc_id, name, ref_type, ref, hdferr, space_id) |
| Creates a reference.
|
|
subroutine | h5rget_name_f (loc_id, ref_type, ref, name, hdferr, size) |
| Retrieves a name of a referenced object.
|
|
subroutine | h5rget_obj_type_f (loc_id, ref_type, ref, obj_type, hdferr) |
| Retrieves the type of object that an object reference points to.
|
|
◆ h5rcreate_f()
subroutine h5rcreate_f |
( |
integer(hid_t), intent(in) |
loc_id, |
|
|
character(len=*), intent(in) |
name, |
|
|
integer, intent(in) |
ref_type, |
|
|
type(c_ptr), intent(inout) |
ref, |
|
|
integer, intent(out) |
hdferr, |
|
|
integer(hid_t), intent(in), optional |
space_id |
|
) |
| |
Creates a reference.
- Attention
- The preferred API, Fortran 2003 version.
- Parameters
-
loc_id | Location identifier. |
name | Name of the dataset at the specified location. |
ref_type | Type of reference:
- H5R_OBJECT_F
- H5T_STD_REF_DSETREG_F
|
ref | Reference created by the function call. |
hdferr | Returns 0 if successful and -1 if it fails. |
space_id | Dataspace identifier that describes selected region. |
◆ h5rget_name_f()
subroutine h5rget_name_f |
( |
integer(hid_t), intent(in) |
loc_id, |
|
|
integer, intent(in) |
ref_type, |
|
|
type(c_ptr), intent(in) |
ref, |
|
|
character(len=*), intent(inout) |
name, |
|
|
integer, intent(out) |
hdferr, |
|
|
integer(size_t), intent(out), optional |
size |
|
) |
| |
Retrieves a name of a referenced object.
- Attention
- The preferred API, Fortran 2003 version.
- Parameters
-
loc_id | Identifier for the file containing the reference or for any object in that file. |
ref_type | Type of reference. |
ref | An object or dataset region reference. |
name | A name associated with the referenced object or dataset ptr. |
hdferr | Returns 0 if successful and -1 if it fails. |
size | The size of the name buffer, returning 0 (zero) if no name is associated with the identifier. |
◆ h5rget_obj_type_f()
subroutine h5rget_obj_type_f |
( |
integer(hid_t), intent(in) |
loc_id, |
|
|
integer, intent(in) |
ref_type, |
|
|
type(c_ptr), intent(in) |
ref, |
|
|
integer, intent(out) |
obj_type, |
|
|
integer, intent(out) |
hdferr |
|
) |
| |
Retrieves the type of object that an object reference points to.
- Parameters
-
loc_id | Identifier for the dataset containing the reference or for the group that dataset is in. |
ref_type | Type of reference to query. |
ref | Reference to query. |
obj_type | Type of referenced object:
- H5G_UNKNOWN_F
- H5G_GROUP_F
- H5G_DATASET_F
- H5G_TYPE_F
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Rget_obj_type3()
◆ h5rget_object_type_f()
Retrieves the type of object that an object reference points to.
- Attention
- Obsolete API, use the Fortran 2003 version instead.
- Parameters
-
dset_id | Identifier of the dataset containing reference to the objects. |
ref | Reference to open. |
obj_type | Object_type, possible values:
- H5G_UNKNOWN_F
- H5G_GROUP_F
- H5G_DATASET_F
- H5G_TYPE_F
|
hdferr | Returns 0 if successful and -1 if it fails. |
◆ h5rget_region_f()
subroutine h5rget_region_f |
( |
integer(hid_t), intent(in) |
dset_id, |
|
|
type(c_ptr), intent(in) |
ref, |
|
|
integer(hid_t), intent(out) |
space_id, |
|
|
integer, intent(out) |
hdferr |
|
) |
| |
Retrieves a dataspace with the specified region selected using pointer.
- Attention
- The preferred API, Fortran 2003 version.
- Parameters
-
dset_id | Identifier of the dataset containing reference to the regions. |
ref | Reference to open. |
space_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Rget_region()
◆ h5r_dataset_region_f
integer h5r_dataset_region_f |
◆ h5r_object_f
◆ ref [1/2]
◆ ref [2/2]