Last modified: 19 July 2013
Name: H5Rcreate
Signature:
herr_t H5Rcreate( void *ref, hid_t loc_id, const char *name, H5R_type_t ref_type, hid_t space_id )

Purpose:
Creates a reference.

Description:
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id.

The HDF5 library maps the void type specified above for ref to the type specified in ref_type, which will be one of those appearing in the first column of the following table. The second column of the table lists the HDF5 constant associated with each reference type.

hdset_reg_ref_t   H5R_DATASET_REGION   Dataset region reference
hobj_ref_t H5R_OBJECT Object reference

The parameters loc_id and name are used to locate the object.

The parameter space_id identifies the dataset region that a dataset region reference points to. This parameter is used only with dataset region references and should be set to -1 if the reference is an object reference, H5R_OBJECT.

Warning:
Neither an object reference nor a dataset region reference may refer to an object that must be accessed through an external link.

More specifically, references can refer to objects only within the current logical HDF5 file while external links typically point to an object in a different logical HDF5 file. Therefore, neither an HDF5 object reference nor an HDF5 dataset region reference may refer to an object or to a region in any dataset, respectively, that is accessed by means of an external link.

Parameters:
void *ref OUT: Reference created by the function call.
hid_t loc_id IN: Location identifier used to locate the object being pointed to.
const char *name IN: Name of object at location loc_id.
H5R_type_t ref_type     IN: Type of reference.
hid_t space_id IN: Dataspace identifier with selection. Used only for dataset region references; pass as -1 if reference is an object reference, i.e., of type H5R_OBJECT.

Returns:
Returns a non-negative value if successful; otherwise returns a negative value.

Fortran90 Interface: h5rcreate_f

To create an object reference:

 

To create a region reference:

Fortran2003 Interface: h5rcreate_f

History:
Release     Change
1.8.8 Fortran updated to Fortran2003.
1.8.0 C function introduced in this release.