Last modified: 18 March 2016

Name: H5Sis_regular_hyperslab

Signature:
htri_t H5Sis_regular_hyperslab( hid_t space_id )

Purpose:
Determines whether a hyperslab selection is regular.

Description:
H5Sis_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 H5Sselect_hyperslab call. If several calls to H5Sselect_hyperslab are needed, then the hyperslab selection is irregular.

Parameters:
hid_t space_id   IN: The identifier of the dataspace.

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

Fortran Interface: h5sis_regular_hyperslab_f

See Also:
H5Sget_regular_hyperslab
H5Sselect_hyperslab
 
Virtual datasets:   H5Pset_virtual

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