Page tree

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

 

JAVA

FORTRAN

C++

C

 

Link

H5R_DEREFERENCE1

Opens the HDF5 object referenced (DEPRECATED)

This function has been renamed from H5Rdereference and is deprecated in favor of the macro H5R_DEREFERENCE or the function H5R_DEREFERENCE2.

Procedure:

H5R_DEREFERENCE1 ( obj_id, ref_type, ref )

Signature:

hid_t H5Rdereference1(
        hid_t obj_id,
        H5R_type_t ref_type,
        void *ref
    )

Fortran90 Interface: h5rdereference_f
    
To dereference an object: 

Signature:
  SUBROUTINE h5rdereference_f(obj_id, ref, ref_obj_id, hdferr) 
    INTEGER(HID_T)    , INTENT(IN)  :: obj_id
    TYPE(hobj_ref_t_f), INTENT(IN)  :: ref
    INTEGER(HID_T)    , INTENT(OUT) :: ref_obj_id
    INTEGER           , INTENT(OUT) :: hdferr

Inputs:
  obj_id      - Valid identifier in file
  ref         - Object reference

Outputs:
  ref_obj_id  - Identifier of referenced object 
  hdferr      - Error code 
                 0 on success and -1 on failure 


To dereference a region:	
   
Signature:
  SUBROUTINE h5rdereference_f(obj_id, ref, ref_obj_id, hdferr)
    INTEGER(HID_T)         , INTENT(IN)  :: obj_id
    TYPE(hdset_reg_ref_t_f), INTENT(IN)  :: ref
    INTEGER(HID_T)         , INTENT(OUT) :: ref_obj_id
    INTEGER                , INTENT(OUT) :: hdferr 

Inputs:
  dset_id       - Valid identifier in file
  ref           - Object reference

Outputs:
  ref_obj_id    - Identifier of referenced object
  hdferr        - Error code 
                   0 on success and -1 on failure


Fortran2003 Interface: h5rdereference_f
   
Signature:
  SUBROUTINE h5rdereference_f(obj_id, ref_type, ref, ref_obj_id, hdferr)
    INTEGER(HID_T), INTENT(IN)  :: obj_id
    INTEGER       , INTENT(IN)  :: ref_type
    TYPE(C_PTR)   , INTENT(IN)  :: ref
    INTEGER(HID_T), INTENT(OUT) :: ref_obj_id
    INTEGER       , INTENT(OUT) :: hdferr

Inputs:
  obj_id     - Valid identifier for the file containing the
               referenced object or any object in that file.
  ref_type   - The reference type of ref.
  ref        - Object reference

Outputs:
  ref_obj_id - Identifier of referenced object
  hdferr     - Error code 
                0 on success and -1 on failure

Parameters:
hid_t obj_idIN: Valid identifier for the file containing the referenced object or any object in that file
H5R_type_t ref_type    IN: The reference type of ref
void *refIN: Reference to open

Description:

Given a reference, ref, to an object or a region in an object, H5R_DEREFERENCE1 opens that object and returns an identifier.

The parameter obj_id must be a valid identifier for an object in the HDF5 file containing the referenced object, including the file identifier.

The parameter ref_type specifies the reference type of the reference ref. ref_type may contain either of the following values:

  • H5R_OBJECT (0)
  • H5R_DATASET_REGION (1)

The object opened with this function should be closed when it is no longer needed so that resource leaks will not develop. Use the appropriate close function such as H5O_CLOSE or H5D_CLOSEfor datasets.

Returns:

Returns identifier of referenced object if successful; otherwise returns a negative value.

Example:

Coming Soon!

History:
Release    Change
1.10.0C function H5Rdereference renamed to H5Rdereference1 and deprecated in this release.
1.8.8Fortran updated to Fortran2003.
1.8.0C function introduced in this release.

--- Last Modified: September 13, 2018 | 12:42 PM