diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1999-09-28 01:51:56 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1999-09-28 01:51:56 (GMT) |
commit | 1c8a7fbd04e2a0e0fdda13591955589dc0233924 (patch) | |
tree | 63fc61f48d24fa861f84bf0995d0ef1fdefccdc1 /doc | |
parent | ab1a73dd3a0a26b971db6474fc67f5d6a42d74a0 (diff) | |
download | hdf5-1c8a7fbd04e2a0e0fdda13591955589dc0233924.zip hdf5-1c8a7fbd04e2a0e0fdda13591955589dc0233924.tar.gz hdf5-1c8a7fbd04e2a0e0fdda13591955589dc0233924.tar.bz2 |
[svn-r1674] Dataspaces.html
RM_H5S.html
Commented out H5Sextent_class. It's still in the plan but not
yet implemented.
RM_H5S.html
Removed H5Sselect_name from list of functions that are not yet
implemented but are described in the UG.
Updated return value descriptions for H5Sis_simple
and H5Sselect_valid to correspond to the earlier
hbool_t -> htri_t change.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/Dataspaces.html | 5 | ||||
-rw-r--r-- | doc/html/RM_H5S.html | 21 |
2 files changed, 19 insertions, 7 deletions
diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index 5f3df7b..30200a5 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -293,6 +293,8 @@ Releases resources associated with a dataspace. Subsequent use of the dataspace identifier after this call is undefined. </DD> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) + <DT> <TT>H5S_class_t H5Sextent_class (hid_t <I>space</I>)</TT></DT> @@ -301,6 +303,9 @@ Query a dataspace to determine the current class of a dataspace. The value which is returned is one of: H5S_SCALAR, H5S_SIMPLE on success or H5S_NO_CLASS on failure. </DD> + +--> + </DL> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 4aad44b..b0e1979 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -67,7 +67,9 @@ elements of a dataset. </ul> </td><td> </td><td valign=top> <ul> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a> +--> <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a> <li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a> <li><a href="#Dataspace-SetExtentNone">H5Sset_extent_none</a> @@ -100,11 +102,10 @@ of the <cite>HDF5 User's Guide.</cite>. <li>H5Scommit <li>H5Sis_subspace <li>H5Slock - <li>H5Sopen </ul> </td><td> </td><td valign=top> <ul> - <li>H5Sselect_name + <li>H5Sopen <li>H5Sselect_op <li>H5Sselect_order </ul> @@ -335,9 +336,10 @@ of the <cite>HDF5 User's Guide.</cite>. selection is being reset. </dl> <dt><strong>Returns:</strong> - <dd>Returns <tt>TRUE</tt> if the selection is contained within - the extent and <tt>FALSE</tt> if it is not. - Returns returns a negative value on error conditions + <dd>Returns a positive value, for <code>TRUE</code>, + if the selection is contained within the extent + or <code>0</code> (zero), for <code>FALSE</code>, if it is not. + Returns a negative value on error conditions such as the selection or extent not being defined. </dl> @@ -522,8 +524,9 @@ of the <cite>HDF5 User's Guide.</cite>. <dd>Identifier of the dataspace to query </dl> <dt><strong>Returns:</strong> - <dd>Returns TRUE or FALSE if Successful; - otherwise returns a negative value. + <dd>When successful, returns a positive value, for <code>TRUE</code>, + or <code>0</code> (zero), for <code>FALSE</code>. + Otherwise returns a negative value. </dl> @@ -560,6 +563,8 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> +<!-- NOT YET IMPLEMENTED (R1.2 -- 9908) + <hr> <dl> <dt><strong>Name:</strong> <a name="Dataspace-ExtentClass">H5Sextent_class</a> @@ -584,6 +589,8 @@ of the <cite>HDF5 User's Guide.</cite>. otherwise H5S_NO_CLASS (-1). </dl> +--> + <hr> <dl> |