Determines whether a hyperslab selection is regular

Procedure:

H5S_IS_REGULAR_HYPERSLAB ( space_id )

Signature:

<pre><code class="language-c">htri_t H5Sis_regular_hyperslab(
        hid_t space_id
        )</code></pre>

<pre><code class="language-fortran">Fortran Interface: h5sis_regular_hyperslab_f
    
Signature:
  SUBROUTINE h5sis_regular_hyperslab_f(space_id, IsRegular, hdferr)
    INTEGER(HID_T), INTENT(IN) ::  space_id
    LOGICAL :: IsRegular
    INTEGER, INTENT(OUT) :: hdferr


Inputs:
  space_id  - The identifier of the dataspace.


Outputs:
  IsRegular - TRUE or FALSE for hyperslab selection if successful.
  hdferr    - Returns 0 if successful and -1 if fails.

        </code></pre>

Parameters:
hid_t space_idIN: The identifier of the dataspace

Description:

H5S_IS_REGULAR_HYPERSLAB takes the dataspace identifier, space_id, and queries the type of the hyperslab selection.

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

Returns:

Returns TRUE or FALSE for hyperslab selection if successful.
Returns FAIL on error or when querying other selection types such as point selection.

Example:

Coming Soon!

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