Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
FH5R

Detailed Description

hobj_ref_t_f derived type

Modules

module  h5r
 This module contains Fortran interfaces for H5R functions.
 

Data Types

type  hobj_ref_t_f
 
type  hdset_reg_ref_t_f
 hdset_reg_ref_t_f derived type More...
 

Functions/Subroutines

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.
 
subroutine h5ropen_object_f (ref_ptr, obj_id, hdferr, rapl_id, oapl_id)
 Opens the HDF5 object referenced.
 
subroutine h5ropen_attr_f (ref_ptr, obj_id, hdferr, rapl_id, aapl_id)
 Opens the HDF5 attribute referenced.
 
subroutine h5ropen_region_f (ref_ptr, space_id, hdferr, rapl_id, oapl_id)
 Sets up a dataspace and selection as specified by a region reference.
 
subroutine h5rcopy_f (src_ref_ptr, dst_ref_ptr, hdferr)
 Copies an existing reference.
 
subroutine h5requal_f (ref1_ptr, ref2_ptr, equal, hdferr)
 Determines whether two references are equal.
 
subroutine h5rget_type_f (ref_ptr, ref_type, hdferr)
 Retrieves the type of a reference.
 
subroutine h5rdestroy_f (ref_ptr, hdferr)
 Closes a reference.
 
subroutine h5rcreate_object_f (loc_id, name, ref, hdferr, oapl_id)
 Creates a reference.
 
subroutine h5rcreate_region_f (loc_id, name, space_id, ref_ptr, hdferr, oapl_id)
 Creates a region reference.
 
subroutine h5rcreate_attr_f (loc_id, name, attr_name, ref_ptr, hdferr, oapl_id)
 Creates an attribute reference.
 
subroutine h5rget_obj_name_f (ref_ptr, name, hdferr, rapl_id, name_len)
 Retrieves the object name for a referenced object.
 
subroutine h5rget_attr_name_f (ref_ptr, name, hdferr, name_len)
 Retrieves the attribute name for a referenced object.
 
subroutine h5rget_file_name_f (ref_ptr, name, hdferr, name_len)
 Retrieves the file name for a referenced object.
 

Variables

integer(haddr_tref
 
integer, dimension(1:ref_reg_buf_lenref
 
integer h5r_object_f
 H5R_OBJECT.
 
integer h5r_dataset_region_f
 H5R_DATASET_REGION.
 
integer h5r_badtype_f
 H5R_BADTYPE.
 
integer h5r_object1_f
 H5R_OBJECT1.
 
integer h5r_dataset_region1_f
 H5R_DATASET_REGION1.
 
integer h5r_object2_f
 H5R_OBJECT2.
 
integer h5r_dataset_region2_f
 H5R_DATASET_REGION2.
 
integer h5r_attr_f
 H5R_ATTR.
 
integer h5r_maxtype_f
 H5R_MAXTYPE.
 

Function/Subroutine Documentation

◆ h5rcopy_f()

subroutine h5rcopy_f ( type(c_ptr)  src_ref_ptr,
type(c_ptr)  dst_ref_ptr,
integer, intent(out)  hdferr 
)

Copies an existing reference.

Parameters
src_ref_ptrPointer to reference to copy, of TYPE(H5R_ref_t)
dst_ref_ptrPointer to output reference, of TYPE(H5R_ref_t)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Rcopy()

◆ h5rcreate_attr_f()

subroutine h5rcreate_attr_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
character(len=*), intent(in)  attr_name,
type(c_ptr)  ref_ptr,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  oapl_id 
)

Creates an attribute reference.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idLocation identifier
nameName of object
attr_nameName of attribute
ref_ptrPointer to reference
hdferrReturns 0 if successful and -1 if it fails.
oapl_idObject access property list identifier

See C API: H5Rcreate_attr()

◆ 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_idLocation identifier.
nameName of the dataset at the specified location.
ref_typeType of reference:
  • H5R_OBJECT_F
  • H5T_STD_REF_DSETREG_F
refReference created by the function call.
hdferrReturns 0 if successful and -1 if it fails.
space_idDataspace identifier that describes selected region.

◆ h5rcreate_object_f()

subroutine h5rcreate_object_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
type(c_ptr)  ref,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  oapl_id 
)

Creates a reference.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idLocation identifier.
nameName of the dataset at the specified location
refReference created by the function call
hdferrReturns 0 if successful and -1 if it fails.
oapl_idObject access property list identifier

See C API: H5Rcreate_object()

◆ h5rcreate_region_f()

subroutine h5rcreate_region_f ( integer(hid_t), intent(in)  loc_id,
character(len=*), intent(in)  name,
integer(hid_t), intent(in)  space_id,
type(c_ptr)  ref_ptr,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  oapl_id 
)

Creates a region reference.

Attention
The preferred API, Fortran 2003 version.
Parameters
loc_idLocation identifier
nameName of object
space_idDataspace identifier
ref_ptrPointer to reference
hdferrReturns 0 if successful and -1 if it fails.
oapl_idObject access property list identifier

See C API: H5Rcreate_region()

◆ h5rdestroy_f()

subroutine h5rdestroy_f ( type(c_ptr)  ref_ptr,
integer, intent(out)  hdferr 
)

Closes a reference.

Parameters
ref_ptrPointer to reference, of TYPE(H5R_ref_t)
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Rdestroy()

◆ h5requal_f()

subroutine h5requal_f ( type(c_ptr)  ref1_ptr,
type(c_ptr)  ref2_ptr,
logical, intent(out)  equal,
integer, intent(out)  hdferr 
)

Determines whether two references are equal.

Parameters
ref1_ptrPointer to reference to compare, of TYPE(H5R_ref_t)
ref2_ptrPointer to reference to compare, of TYPE(H5R_ref_t)
equalIf reference are equal
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Requal()

◆ h5rget_attr_name_f()

subroutine h5rget_attr_name_f ( type(c_ptr)  ref_ptr,
character(len=*)  name,
integer, intent(out)  hdferr,
integer(size_t), intent(out), optional  name_len 
)

Retrieves the attribute name for a referenced object.

Parameters
ref_ptrPointer to reference to query
nameBuffer to place the attribute name of the reference
hdferrReturns 0 if successful and -1 if it fails.
name_lenMaximum length of the name to retrieve

◆ h5rget_file_name_f()

subroutine h5rget_file_name_f ( type(c_ptr)  ref_ptr,
character(len=*)  name,
integer, intent(out)  hdferr,
integer(size_t), intent(out), optional  name_len 
)

Retrieves the file name for a referenced object.

Parameters
ref_ptrPointer to reference to query
nameBuffer to place the file name of the reference
hdferrReturns 0 if successful and -1 if it fails.
name_lenThe size of the name buffer

See C API: H5Rget_file_name()

◆ 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_idIdentifier for the file containing the reference or for any object in that file.
ref_typeType of reference.
refAn object or dataset region reference.
nameA name associated with the referenced object or dataset ptr.
hdferrReturns 0 if successful and -1 if it fails.
sizeThe size of the name buffer, returning 0 (zero) if no name is associated with the identifier.

◆ h5rget_obj_name_f()

subroutine h5rget_obj_name_f ( type(c_ptr)  ref_ptr,
character(len=*)  name,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  rapl_id,
integer(size_t), intent(out), optional  name_len 
)

Retrieves the object name for a referenced object.

Parameters
ref_ptrPointer to reference to query
nameBuffer to place the file name of the reference
hdferrReturns 0 if successful and -1 if it fails.
rapl_idReference access property list identifier
name_lenMaximum length of the name to retrieve

◆ 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_idIdentifier for the dataset containing the reference or for the group that dataset is in.
ref_typeType of reference to query.
refReference to query.
obj_typeType of referenced object:
  • H5G_UNKNOWN_F
  • H5G_GROUP_F
  • H5G_DATASET_F
  • H5G_TYPE_F
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Rget_obj_type3()

◆ h5rget_object_type_f()

subroutine h5rget_object_type_f ( integer(hid_t), intent(in)  dset_id,
type(hobj_ref_t_f), intent(in)  ref,
integer, intent(out)  obj_type,
integer, intent(out)  hdferr 
)

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

Attention
Obsolete API, use the Fortran 2003 version instead.
Parameters
dset_idIdentifier of the dataset containing reference to the objects.
refReference to open.
obj_typeObject_type, possible values:
  • H5G_UNKNOWN_F
  • H5G_GROUP_F
  • H5G_DATASET_F
  • H5G_TYPE_F
hdferrReturns 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_idIdentifier of the dataset containing reference to the regions.
refReference to open.
space_idDataspace identifier.
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Rget_region()

◆ h5rget_type_f()

subroutine h5rget_type_f ( type(c_ptr)  ref_ptr,
integer, intent(out)  ref_type,
integer, intent(out)  hdferr 
)

Retrieves the type of a reference.

Parameters
ref_ptrPointer to reference to copy, of TYPE(H5R_ref_t)
ref_typeA reference type
hdferrReturns 0 if successful and -1 if it fails.

See C API: H5Rget_type()

◆ h5ropen_attr_f()

subroutine h5ropen_attr_f ( type(c_ptr)  ref_ptr,
integer(hid_t), intent(out)  obj_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  rapl_id,
integer(hid_t), intent(in), optional  aapl_id 
)

Opens the HDF5 attribute referenced.

Parameters
ref_ptrPointer to reference to open, points object of TYPE(H5R_ref_t)
obj_idObject identifier
hdferrReturns 0 if successful and -1 if it fails.
rapl_idReference access property list identifier
aapl_idAttribute access property list identifier

See C API: H5Ropen_attr()

◆ h5ropen_object_f()

subroutine h5ropen_object_f ( type(c_ptr)  ref_ptr,
integer(hid_t), intent(out)  obj_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  rapl_id,
integer(hid_t), intent(in), optional  oapl_id 
)

Opens the HDF5 object referenced.

Parameters
ref_ptrPointer to reference to open, points object of TYPE(H5R_ref_t)
obj_idObject identifier
hdferrReturns 0 if successful and -1 if it fails.
rapl_idReference access property list identifier
oapl_idObject access property list identifier

See C API: H5Ropen_object()

◆ h5ropen_region_f()

subroutine h5ropen_region_f ( type(c_ptr)  ref_ptr,
integer(hid_t), intent(out)  space_id,
integer, intent(out)  hdferr,
integer(hid_t), intent(in), optional  rapl_id,
integer(hid_t), intent(in), optional  oapl_id 
)

Sets up a dataspace and selection as specified by a region reference.

Parameters
ref_ptrPointer to reference to open, points object of TYPE(H5R_ref_t)
space_idDataspace identifier
hdferrReturns 0 if successful and -1 if it fails.
rapl_idReference access property list identifier
oapl_idObject access property list identifier

See C API: H5Ropen_region()

Variable Documentation

◆ h5r_attr_f

integer h5r_attr_f

H5R_ATTR.

◆ h5r_badtype_f

integer h5r_badtype_f

H5R_BADTYPE.

◆ h5r_dataset_region1_f

integer h5r_dataset_region1_f

H5R_DATASET_REGION1.

◆ h5r_dataset_region2_f

integer h5r_dataset_region2_f

H5R_DATASET_REGION2.

◆ h5r_dataset_region_f

integer h5r_dataset_region_f

H5R_DATASET_REGION.

◆ h5r_maxtype_f

integer h5r_maxtype_f

H5R_MAXTYPE.

◆ h5r_object1_f

integer h5r_object1_f

H5R_OBJECT1.

◆ h5r_object2_f

integer h5r_object2_f

H5R_OBJECT2.

◆ h5r_object_f

integer h5r_object_f

H5R_OBJECT.

◆ ref [1/2]

integer(haddr_t) ref

◆ ref [2/2]

integer, dimension(1:ref_reg_buf_len) ref