diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2001-07-06 03:03:11 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2001-07-06 03:03:11 (GMT) |
commit | 5308ccd9de5b10c803dee312cc60076704cbbf46 (patch) | |
tree | b7602a506fdc9b95782c267debdf2a09e53c931a /doc/html/RM_H5S.html | |
parent | cfa36589316578e0fd6b1f315b48bffc0bf745d0 (diff) | |
download | hdf5-5308ccd9de5b10c803dee312cc60076704cbbf46.zip hdf5-5308ccd9de5b10c803dee312cc60076704cbbf46.tar.gz hdf5-5308ccd9de5b10c803dee312cc60076704cbbf46.tar.bz2 |
[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
Diffstat (limited to 'doc/html/RM_H5S.html')
-rw-r--r-- | doc/html/RM_H5S.html | 37 |
1 files changed, 22 insertions, 15 deletions
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 8c7359d..1439c21 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -207,21 +207,28 @@ of the <cite>HDF5 User's Guide.</cite>. <em>const hsize_t *</em> <code>maxdims</code> ) <dt><strong>Purpose:</strong> - <dd>Creates a new simple data space and opens it for access. + <dd>Creates a new simple dataspace and opens it for access. <dt><strong>Description:</strong> - <dd><code>H5Screate_simple</code> creates a new simple data space - and opens it for access. The <code>rank</code> is the number of - dimensions used in the dataspace. - The <code>dims</code> argument is the size - of the simple dataset and the <code>maxdims</code> argument is - the upper limit on the size of the dataset. <code>maxdims</code> - may be the null pointer in which case the upper limit is the - same as <code>dims</code>. If an element of <code>maxdims</code> - is zero then the corresponding dimension is unlimited, otherwise - no element of <code>maxdims</code> should be smaller than the - corresponding element of <code>dims</code>. The dataspace - identifier returned from this function should be released with - <code>H5Sclose</code> or resource leaks will occur. + + <dd><code>H5Screate_simple</code> creates a new simple dataspace + and opens it for access. + <p> + <code>rank</code> is the number of dimensions used in the dataspace. + <p> + <code>dims</code> is an array specifying the size of each dimension + of the dataset while + <code>maxdims</code> is an array specifying the upper limit on + the size of each dimension. + <code>maxdims</code> may be the null pointer, in which case the + upper limit is the same as <code>dims</code>. + <p> + No element of <code>maxdims</code> should be smaller than the + corresponding element of <code>dims</code>. + If an element of <code>maxdims</code> is <code>H5S_UNLIMITED</code>, + the corresponding dimension is unlimited. + <p> + The dataspace identifier returned from this function must be + released with <code>H5Sclose</code> or resource leaks will occur. <dt><strong>Parameters:</strong> <dl> <dt><em>int</em> <code>rank</code> @@ -1234,7 +1241,7 @@ H5S <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 12 June 2000 +Last modified: 5 July 2001 <br> Describes HDF5 Release 1.5, Unreleased Development Branch |