Last modified: 18 March 2016

Name: H5Sget_regular_hyperslab

Signature:
herr_t H5Sget_regular_hyperslab( hid_t space_id, hsize_t start[], hsize_t stride[], hsize_t count[], hsize_t block[] )

Purpose:
Retrieves a regular hyperslab selection.

Description:
H5Sget_regular_hyperslab takes the dataspace identifier, space_id, and retrieves the values of start, stride, count, and block for the regular hyperslab selection.

A regular hyperslab selection is a hyperslab selection described by setting the offset, stride, count, and block parameters to the H5Sselect_hyperslab call. If several calls to H5Sselect_hyperslab are needed, the hyperslab selection is irregular.

See H5Sselect_hyperslab for descriptions of offset, stride, count, and block.

Note:
If a hyperslab selection is originally regular, then becomes irregular through selection operations, and then becomes regular again, the final regular selection may be equivalent but not identical to the original regular selection.

Parameters:
hid_t space_id   IN: The identifier of the dataspace.
hsize_t start[]   OUT: Offset of the start of the regular hyperslab.
hsize_t stride[]   OUT: Stride of the regular hyperslab.
hsize_t count[]   OUT: Number of blocks in the regular hyperslab.
hsize_t block[]   OUT: Size of a block in the regular hyperslab.

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

Fortran Interface: h5sget_regular_hyperslab_f
Signature:
  SUBROUTINE h5sget_regular_hyperslab_f(space_id, start, stride, count, 
                                        block, hdferr)
    INTEGER(HID_T), INTENT(IN) ::  space_id
    INTEGER(HSIZE_T), INTENT(OUT), DIMENSION(*), TARGET ::  start
    INTEGER(HSIZE_T), INTENT(OUT), DIMENSION(*), TARGET ::  stride
    INTEGER(HSIZE_T), INTENT(OUT), DIMENSION(*), TARGET ::  count
    INTEGER(HSIZE_T), INTENT(OUT), DIMENSION(*), TARGET ::  block
    INTEGER, INTENT(OUT) :: hdferr
Inputs:
  space_id - The identifier of the dataspace.
Outputs:
  start    - Offset of the start of the regular hyperslab.
  stride   - Stride of the regular hyperslab.
  count    - Number of blocks in the regular hyperslab.
  block    - Size of a block in the regular hyperslab.
  hdferr   - Returns 0 if successful and -1 if fails.

See Also:
H5Sis_regular_hyperslab
H5Sselect_hyperslab
 
Virtual datasets:   H5Pset_virtual

History:
Release     Change
1.10.0 C function introduced with this release.