From 5308ccd9de5b10c803dee312cc60076704cbbf46 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 5 Jul 2001 22:03:11 -0500 Subject: [PATCH] [svn-r4127] Purpose: Bugfix Description: H5Screate_simple -- Corrected statement referring to value of 0 instead of H5S_UNLIMITED for unlimited dimensions. While there, took the opportunity to rework the Description section. Fixes Bug #568. Platforms tested: IE 5 --- doc/html/RM_H5S.html | 37 ++++++++++++++++++++++--------------- 1 file changed, 22 insertions(+), 15 deletions(-) diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 8c7359d4fc..1439c216d0 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -207,21 +207,28 @@ of the HDF5 User's Guide.. const hsize_t * maxdims )
Purpose: -
Creates a new simple data space and opens it for access. +
Creates a new simple dataspace and opens it for access.
Description: -
H5Screate_simple creates a new simple data space - and opens it for access. The rank is the number of - dimensions used in the dataspace. - The dims argument is the size - of the simple dataset and the maxdims argument is - the upper limit on the size of the dataset. maxdims - may be the null pointer in which case the upper limit is the - same as dims. If an element of maxdims - is zero then the corresponding dimension is unlimited, otherwise - no element of maxdims should be smaller than the - corresponding element of dims. The dataspace - identifier returned from this function should be released with - H5Sclose or resource leaks will occur. + +
H5Screate_simple creates a new simple dataspace + and opens it for access. +

+ rank is the number of dimensions used in the dataspace. +

+ dims is an array specifying the size of each dimension + of the dataset while + maxdims is an array specifying the upper limit on + the size of each dimension. + maxdims may be the null pointer, in which case the + upper limit is the same as dims. +

+ No element of maxdims should be smaller than the + corresponding element of dims. + If an element of maxdims is H5S_UNLIMITED, + the corresponding dimension is unlimited. +

+ The dataspace identifier returned from this function must be + released with H5Sclose or resource leaks will occur.

Parameters:
int rank @@ -1234,7 +1241,7 @@ H5S   HDF Help Desk
-Last modified: 12 June 2000 +Last modified: 5 July 2001
Describes HDF5 Release 1.5, Unreleased Development Branch