From a3f7bbf7d3f00c0997a1e693a9d917b749cfcd24 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 7 Apr 2009 15:14:23 -0500 Subject: [svn-r16684] Description: Added note that a scalar dataspace rank is always 0. -- Fixes Bugzilla entry 1075. Added "Last modified" tag and cleaned up HTML. Tested: Firefox --- doc/html/H5S/H5Screate.htm | 32 +++++++++++++++++++++++++------- 1 file changed, 25 insertions(+), 7 deletions(-) diff --git a/doc/html/H5S/H5Screate.htm b/doc/html/H5S/H5Screate.htm index 82f487a..75034af 100644 --- a/doc/html/H5S/H5Screate.htm +++ b/doc/html/H5S/H5Screate.htm @@ -2,26 +2,50 @@
+
+ Last modified: 7 April 2009 +
+
Name: H5Screate
Signature:
hid_t H5Screate(H5S_class_t type) + +

Purpose:
Creates a new dataspace of a specified type. + +

Description:
H5Screate creates a new dataspace of a particular type. The types currently supported are H5S_SCALAR and H5S_SIMPLE; - others are planned to be added later. + others may be added later. +

+ A scalar dataspace, H5S_SCALAR, + has a single element, though that element may be of a complex + datatype, such as a compound or array datatype. + By convention, the rank of a scalar dataspace is always + 0 (zero); think of it geometrically as a single, + dimensionless point, though that point can be complex. +

+ A simple dataspace, H5S_SIMPLE, consists of + a regular array of elements. + +

Parameters:
    H5S_class_t type     The type of dataspace to be created.
+ +

Returns:
Returns a dataspace identifier if successful; otherwise returns a negative value. + +

Fortran90 Interface: h5screate_f
@@ -38,11 +62,5 @@ SUBROUTINE h5screate_f(classtype, space_id, hdferr)
 END SUBROUTINE h5screate_f
 	
-
-- cgit v0.12