Creates and writes a dataset containing a list of region references.

Procedure:

H5LR_MAKE_DATASET(loc_id, path, type_id, num_elem, obj_id, buf)

Signature:

<pre><code class="language-c">herr_t H5LRmake_dataset( hid_t loc_id, const char *path, hid_t type_id, const size_t num_elem, const hid_t *obj_id, const hdset_reg_ref_t *buf )</code></pre>

<pre><code class="language-fortran">SUBROUTINE H5LRmake_dataset_f(loc_id, path, type_id, &
     buf_size,loc_id_ref, ref, error)

  IMPLICIT NONE

  INTEGER(hid_t), INTENT(IN) :: loc_id                              ! Location identifier of the dataset to be created 
  CHARACTER(LEN=*), INTENT(IN) :: path                              ! Path to the dataset being created 
  INTEGER(hid_t), INTENT(IN) :: type_id                             ! Datatype of the dataset 
  INTEGER(size_t) :: buf_size                                       ! Size of the obj_id and buf arrays 
  INTEGER(hid_t), DIMENSION(1:buf_size), INTENT(IN) :: loc_id_ref   ! Array of object identifiers; each identifier describes 
                                                                    !  to which HDF5 file the corresponding region 
                                                                    !  reference belongs to 
  TYPE(hdset_reg_ref_t_f), DIMENSION(1:buf_size), INTENT(IN) :: ref ! Array of region references  
  INTEGER, INTENT(OUT) :: error                                     ! Error code:
                                                                    !  0 on success and -1 on failure

END SUBROUTINE H5LRmake_dataset_f</code></pre>

Parameters:
hid_t loc_id    IN: Location identifier of the dataset to be created
const char *path IN: Path to the dataset being created
hid_t type_id IN: Datatype of the dataset
const size_t num_elem    IN: Size of the obj_id and buf arrays
const hid_t *obj_id IN: Array of object identifiers; each identifier describes to which HDF5 file the corresponding region reference belongs to
const hdset_reg_ref_t *buf IN: Array of region references

Description:

Given an array of size num_elem of region references buf, the function will create a dataset with path path, at location specified by loc_id and of a datatype specified by type_id, and will write data associated with each region reference in the order corresponding to the order of the region references in the buffer. It is assumed that all referenced hyperslabs have the same dimensionality, and only the size of the slowest changing dimension may differ. Each reference in the buf array belongs to the file identified by the corresponding object identifiers in the array obj_id.

If path does not exist in loc_id then the function will create the path specified by path automatically.

Returns:

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

Example:

Coming Soon!

History:
Release    Change
1.0C function introduced in this release.
1.1Fortran wrapper introduced in this release.