Page tree

The license could not be verified: License Certificate has expired!

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
id1195548671
Content Column
width50.00001%
id1195578110
classrm_pagetree_col mobile-hide
Content Block
id1195578111
 
Content Column
width50.00001%
id1195548673
classhdf-rm-main-column
Content Block
id1195548672

Include Content
render-without-blockstrue
page.rm-navbar
HTML Wrap
classhdf-print-only

Page Title

HTML Wrap
classhdf-rm-summary-block

Hdf rm anchor
AnchorNamesummary

Excerpt

Creates a reference

HTML Wrap
classhdf-rm-content-block

Hdf rm anchor
AnchorNameprocedure

Procedure:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf_procedure

H5R_CREATE ( ref, loc_id, name, ref_type, space_id )

Hdf rm anchor
AnchorNamesignature

Signature:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-c

HTML
<pre><code class="language-c">herr_t H5Rcreate(
        void *ref,
        hid_t loc_id,
        const char *name,
        H5R_type_t ref_type,
        hid_t space_id
    )
</code></pre>
HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

HTML Add Class
hdf-togglebutton-visible
hdf-togglebutton-visible
selector.hdf-togglebutton.hdf-fortran

HTML
<pre><code class="language-fortran">Fortran90 Interface: h5rcreate_f
   
To create an object reference: 
 
Signature:
  SUBROUTINE h5rcreate_f(loc_id, name, ref, hdferr)
    INTEGER(HID_T)    , INTENT(IN)    :: loc_id
    CHARACTER(LEN=*)  , INTENT(IN)    :: name
    TYPE(hobj_ref_t_f), INTENT(INOUT) :: ref
    INTEGER           , INTENT(OUT)   :: hdferr

Inputs:
  loc_id - Location identifier
  name   - Name of the object at location specified by loc_id identifier

Outputs:
  ref    - Object reference
  hdferr - Error code:
            0 on success and -1 on failure

    
To create a region reference:  
    
Signature:
  SUBROUTINE h5rcreate_f(loc_id, name, space_id, ref, hdferr) 
    INTEGER(HID_T)         , INTENT(IN)  :: loc_id
    CHARACTER(LEN=*)       , INTENT(IN)  :: name
    INTEGER(HID_T)         , INTENT(IN)  :: space_id
    TYPE(hdset_reg_ref_t_f), INTENT(OUT) :: ref
    INTEGER                , INTENT(OUT) :: hdferr

Inputs:
  loc_id   - Location identifier
  name     - Name of the dataset at location specified by loc_id identifier 
  space_id - Dataset's dataspace identifier

Outputs:
  ref      - Dataset region reference
  hdferr   - Error code
              0 on success and -1 on failure


Fortran2003 Interface: h5rcreate_f
   
Signature:
  SUBROUTINE h5rcreate_f(loc_id, name, ref_type, ref, hdferr, space_id)
    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

Inputs:
  loc_id   - Location identifier used to locate the object being pointed to.
  name     - Name of object at location loc_id.
  ref_type - Type of reference:
              H5R_OBJECT
              H5T_STD_REF_DSETREG

Outputs:
  ref      - Reference created by the function call.
  hdferr   - Error code
              0 on success and -1 on failure

Optional Parameter:
  space_id - Dataspace identifier that describes selected region.
</code></pre>

Hdf rm anchor
AnchorNameparameters

Parameters:
HTML Wrap
classhdf-rm-section
void *refOUT: Reference created by the function call
hid_t loc_idIN: Location identifier used to locate the object being pointed to
const char *nameIN: Name of object at location loc_id
H5R_type_t ref_type    IN: Type of reference
hid_t space_idIN: 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

Hdf rm anchor
AnchorNamedescription

Description:
HTML Wrap
classhdf-rm-section

H5R_CREATE 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_tH5R_OBJECTObject 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.

Hdf rm anchor
AnchorNamereturns

Returns:
HTML Wrap
classhdf-rm-section

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

Hdf rm anchor
AnchorNameexample

Example:
HTML Wrap
classhdf-rm-section
HTML Wrap
classhdf-togglebox hdf-c

Bitbucket Server file
repoSlughdf5-examples
branchIdrefs/heads/master
projectKeyHDFFV
filepath1_10/C/H5T/h5ex_t_objref.c
showLineNumberstrue
lineStart56
progLangplain
lineEnd62
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

HTML Wrap
classhdf-togglebox hdf-fortran hdf-togglebox-hidden

Bitbucket Server file
repoSlughdf5-examples
branchIdrefs/heads/master
projectKeyHDFFV
filepath1_10/FORTRAN/H5T/h5ex_t_objref_F03.f90
showLineNumberstrue
lineStart58
progLangplain
lineEnd64
applicationLink5ac7b370-7412-3c8c-ad20-807a68261336

Hdf rm anchor
AnchorNamehistory

History:
HTML Wrap
classhdf-rm-section
Release    Change
1.8.8Fortran updated to Fortran2003.
1.8.0C function introduced in this release.