diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1998-10-29 22:13:17 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1998-10-29 22:13:17 (GMT) |
commit | cd3b1059977b1a80e320334c68630f88867341c8 (patch) | |
tree | 4f38388af7f9667610ac50ca63df3311f8794d07 /doc/html/RM_H5S.html | |
parent | f9fd7a35c22952248e114704fbb189d43419f442 (diff) | |
download | hdf5-cd3b1059977b1a80e320334c68630f88867341c8.zip hdf5-cd3b1059977b1a80e320334c68630f88867341c8.tar.gz hdf5-cd3b1059977b1a80e320334c68630f88867341c8.tar.bz2 |
[svn-r830] ======
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
Diffstat (limited to 'doc/html/RM_H5S.html')
-rw-r--r-- | doc/html/RM_H5S.html | 60 |
1 files changed, 33 insertions, 27 deletions
diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index d0ed17a..5d34684 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -14,7 +14,10 @@ HDF5/H5S Draft API Specification <a href="RM_H5E.html">H5E</a> <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> +<a href="RM_H5I.html">H5I</a> <a href="RM_H5P.html">H5P</a> +<a href="RM_H5R.html">H5R</a> +<a href="RM_H5RA.html">H5RA</a> H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> @@ -117,7 +120,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -156,7 +159,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -180,7 +183,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -229,8 +232,8 @@ of the <cite>HDF5 User's Guide.</cite>. elements being selected. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -256,8 +259,8 @@ of the <cite>HDF5 User's Guide.</cite>. selection is being made. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -278,8 +281,8 @@ of the <cite>HDF5 User's Guide.</cite>. selection is being reset. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -303,7 +306,7 @@ of the <cite>HDF5 User's Guide.</cite>. <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 <tt>FAIL</tt> (<tt>-1</tt>) on error conditions + Returns returns a negative value on error conditions such as the selection or extent not being defined. </dl> @@ -334,7 +337,7 @@ of the <cite>HDF5 User's Guide.</cite>. <dl> <dt><strong>Name:</strong> <a name="Dataspace-SelectNpoints">H5Sget_select_npoints</a> <dt><strong>Signature:</strong> - <dd><em>hsize_t</em> <code>H5Sget_select_npoints</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>hssize_t</em> <code>H5Sget_select_npoints</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of elements in a dataspace. <dt><strong>Description:</strong> @@ -347,7 +350,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns the number of elements in the selection if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -368,7 +371,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; - otherwise FAIL (-1) + otherwise returns a negative value. </dl> @@ -397,7 +400,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns the number of dimensions in the dataspace if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -467,7 +470,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace identifier if successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -489,7 +492,7 @@ of the <cite>HDF5 User's Guide.</cite>. </dl> <dt><strong>Returns:</strong> <dd>Returns TRUE or FALSE if Successful; - otherwise FAIL (-1). + otherwise returns a negative value. </dl> @@ -521,8 +524,8 @@ of the <cite>HDF5 User's Guide.</cite>. <dd>IN: The offset at which to position the selection. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -574,8 +577,8 @@ of the <cite>HDF5 User's Guide.</cite>. the extent is copied. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -596,8 +599,8 @@ of the <cite>HDF5 User's Guide.</cite>. the extent is to be removed. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -690,8 +693,8 @@ I/O is performed. <dd>IN: Size of block in hyperslab. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -714,8 +717,8 @@ I/O is performed. <dd>Identifier of dataspace to release. </dl> <dt><strong>Returns:</strong> - <dd>Returns SUCCEED (0) if successful; - otherwise FAIL (-1). + <dd>Returns a non-negative value if successful; + otherwise returns a negative value. </dl> @@ -728,7 +731,10 @@ I/O is performed. <a href="RM_H5E.html">H5E</a> <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> +<a href="RM_H5I.html">H5I</a> <a href="RM_H5P.html">H5P</a> +<a href="RM_H5R.html">H5R</a> +<a href="RM_H5RA.html">H5RA</a> H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> @@ -743,7 +749,7 @@ H5S <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 1 September 1998 +Last modified: 27 October 1998 </body> </html> |