summaryrefslogtreecommitdiffstats
path: root/src/H5Sall.c
diff options
context:
space:
mode:
authorNeil Fortner <nfortne2@hdfgroup.org>2015-07-31 17:47:14 (GMT)
committerNeil Fortner <nfortne2@hdfgroup.org>2015-07-31 17:47:14 (GMT)
commit679a25a7c437355df289dfd3fbb18a7dfb65d9e8 (patch)
treed55a98be6d51ac38a4f8818c4b44e24ab8720a9b /src/H5Sall.c
parent49076d6d229abdf59cccac47a86431c977a60037 (diff)
downloadhdf5-679a25a7c437355df289dfd3fbb18a7dfb65d9e8.zip
hdf5-679a25a7c437355df289dfd3fbb18a7dfb65d9e8.tar.gz
hdf5-679a25a7c437355df289dfd3fbb18a7dfb65d9e8.tar.bz2
[svn-r27450] Add descriptions for all non-public functions.
Other comments. Add some input checking. Tested: ummon
Diffstat (limited to 'src/H5Sall.c')
-rw-r--r--src/H5Sall.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/H5Sall.c b/src/H5Sall.c
index 96ca1e5..1b9ceec 100644
--- a/src/H5Sall.c
+++ b/src/H5Sall.c
@@ -676,11 +676,16 @@ H5S_all_offset(const H5S_t H5_ATTR_UNUSED *space, hsize_t *offset)
PURPOSE
Return unlimited dimension of selection, or -1 if none
USAGE
- VDSINC
+ int H5S_all_unlim_dim(space)
+ H5S_t *space; IN: Dataspace pointer to check
RETURNS
Unlimited dimension of selection, or -1 if none (never fails).
DESCRIPTION
- VDSINC
+ Returns the index of the unlimited dimension in this selection, or -1
+ if the selection has no unlimited dimension. "All" selections are
+ always unlimited in every dimension, though this is not reflected in
+ other calls, where the selection is "clipped" against the current
+ extent, so for consistency this function always returns -1.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES