Page tree

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

 

JAVA

FORTRAN

C++

C

 

Link

H5R_GET_REGION

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

Procedure:

H5R_GET_REGION ( loc_id, ref_type, ref )

Signature:

hid_t H5Rget_region(
        hid_t loc_id, 
        H5R_type_t ref_type, 
        void *ref 
        ) 

Fortran90 Interface: h5rget_region_f 
     
SUBROUTINE h5rget_region_f(obj_id, ref, space_id, hdferr) 
  IMPLICIT NONE
  INTEGER(HID_T), INTENT(IN) :: obj_id        ! Object identifier 
  TYPE(hdset_reg_ref_t_f), INTENT(IN) :: ref  ! Dataset region reference 
  INTEGER(HID_T), INTENT(OUT) :: space_id     ! Space identifier 
  INTEGER, INTENT(OUT) :: hdferr              ! Error code 
                                              ! 0 on success and -1 on failure
END SUBROUTINE h5rget_region_f
  

Parameters:
hid_t loc_idIN: File identifier or identifier for any object in the file containing the referenced region
H5R_type_t ref_type    IN: Reference type of ref, which must be H5R_DATASET_REGION
void *refIN: Region reference to open

Description:

H5R_GET_REGION creates a copy of the dataspace of the dataset pointed to by a region reference, ref, and defines a selection matching the selection pointed to by ref within the dataspace copy.

loc_id is used to identify the file containing the referenced region; it can be a file identifier or an identifier for any object in the file.

The parameter ref_type specifies the reference type of ref and must contain the following value:

  • H5R_DATASET_REGION (1)

Use H5S_CLOSE to release the dataspace identifier returned by this function when the identifier is no longer needed.

Returns:

Returns a valid dataspace identifier if successful; otherwise returns a negative value.

Example:

        /*
         * Open the referenced object, retrieve its region as a
         * dataspace selection.
         */
        dset2 = H5Rdereference (dset, H5P_DEFAULT, H5R_DATASET_REGION, &rdata[i]);
        space = H5Rget_region (dset, H5R_DATASET_REGION, &rdata[i]);

     ! Open the referenced object, retrieve its region as a
     ! dataspace selection.
     !
     CALL H5Rdereference_f(dset, rdata(i), dset2, hdferr)
     CALL H5Rget_region_f(dset, rdata(i), space, hdferr)

History:

None

--- Last Modified: September 13, 2018 | 01:01 PM