diff options
| -rw-r--r-- | doc/html/H5S/H5Screate_simple.htm | 73 |
1 files changed, 45 insertions, 28 deletions
diff --git a/doc/html/H5S/H5Screate_simple.htm b/doc/html/H5S/H5Screate_simple.htm index 6cea380..4a85edd 100644 --- a/doc/html/H5S/H5Screate_simple.htm +++ b/doc/html/H5S/H5Screate_simple.htm @@ -2,54 +2,77 @@ <!-- HEADER RIGHT "H5Screate_simple" --> <hr> <dl> +<dt><div align=right><font color=999999 size=-1><i> + Last modified: 13 April 2009 + </i></font></div> + <dt><strong>Name:</strong> <a name="Dataspace-CreateSimple">H5Screate_simple</a> <dt><strong>Signature:</strong> <dd><em>hid_t</em> <code>H5Screate_simple</code>(<em>int</em> <code>rank</code>, <em>const hsize_t *</em> <code>dims</code>, <em>const hsize_t *</em> <code>maxdims</code> ) + +<p> <dt><strong>Purpose:</strong> <dd>Creates a new simple dataspace and opens it for access. -<dt><strong>Description:</strong> +<p> +<dt><strong>Description:</strong> <dd><code>H5Screate_simple</code> creates a new simple dataspace - and opens it for access. + and opens it for access, returning a dataset identifier. <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>dims</code> is a one-dimensional array of size <code>rank</code> + specifying the size of each dimension of the dataset. + <code>maxdims</code> is an array of the same size + 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> - If an element of <code>maxdims</code> is - <code>H5S_UNLIMITED</code>, (<code>-1</code>), + If an element of <code>maxdims</code> is <code>H5S_UNLIMITED</code>, the maximum size of the corresponding dimension is unlimited. Otherwise, no element of <code>maxdims</code> should be smaller than the corresponding element of <code>dims</code>. <p> + Note that any dataset with an unlimited dimension must also + be chunked; see + <a href="RM_H5P.html#Property-SetChunk"><code>H5Pset_chunk</code></a>. + <p> The dataspace identifier returned from this function must be released with <code>H5Sclose</code> or resource leaks will occur. + +<p> <dt><strong>Parameters:</strong> - <ul><table> - <tr> - <td valign="top"><em>int</em> <code>rank</code></td> - <td valign="top">Number of dimensions of dataspace.</td></tr> - <tr> - <td valign="top"><em>const hsize_t *</em> <code>dims</code></td> - <td valign="top">An array of the size of each dimension.</td></tr> - <tr> - <td valign="top"><em>const hsize_t *</em> <code>maxdims </code></td> - <td valign="top">An array of the maximum size of each dimension.</td></tr> - </table></ul> + <dd><table> + <tr> + <td valign="top"><em>int</em> <code>rank</code></td> + <td valign="top">Number of dimensions of dataspace.</td></tr> + <tr> + + <td valign="top"><em>const hsize_t *</em> <code>dims</code></td> + <td valign="top">An array of the size of each + dimension.</td></tr> + <tr> + <td valign="top"><em>const hsize_t *</em> <code>maxdims </code></td> + <td valign="top">An array of the maximum size of each + dimension.</td></tr> + </table> + +<p> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; otherwise returns a negative value. + +<p> +<dt><strong>See Also:</strong> + <dd><a href="RM_H5P.html#Property-SetChunk"><code>H5Pset_chunk</code></a> + +<p> <dt><strong>Fortran90 Interface:</strong> h5screate_simple_f <dd> - <pre> + <pre> SUBROUTINE h5screate_simple_f(rank, dims, space_id, hdferr, maxdims) IMPLICIT NONE INTEGER, INTENT(IN) :: rank ! Number of dataspace dimensions @@ -61,13 +84,7 @@ SUBROUTINE h5screate_simple_f(rank, dims, space_id, hdferr, maxdims) ! Array with the maximum ! dimension sizes END SUBROUTINE h5screate_simple_f - </pre> - - <!--<dt><strong>Non-C API(s):</strong> - <dd> - - <img src="Graphics/Java.gif"> - <img src="Graphics/C++.gif"> - --> + </pre> + </dl> |