summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2003-08-31 01:48:01 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2003-08-31 01:48:01 (GMT)
commitf92d7f73df1846f4489fb6e2c2dd857b636b4deb (patch)
tree74d28cd355a39d0d9f8dc0c96484380b6b12628e /doc
parentbd3510bea3638d5f4281bf9a6bbfe4c4a8b3ca9a (diff)
downloadhdf5-f92d7f73df1846f4489fb6e2c2dd857b636b4deb.zip
hdf5-f92d7f73df1846f4489fb6e2c2dd857b636b4deb.tar.gz
hdf5-f92d7f73df1846f4489fb6e2c2dd857b636b4deb.tar.bz2
[svn-r7434] Purpose:
Bug Fix and code cleanup Description: Correct error in H5T_detect_class that was causing nested compound datatypes with to not detect the datatype class of fields correctly, which caused errors with fill-values, variable-length datatypes and chunks later on. Return the rank of the array datatype from H5Tget_array_dims(), like H5Sget_dims(). Lots of cleanups to datatype code, to make the handling of arrays, compound types, variable-length strings and sequences and enumerated types more consistent and robust. Platforms tested: FreeBSD 4.9 (sleipnir) h5committest
Diffstat (limited to 'doc')
-rw-r--r--doc/html/H5.intro.html2
-rw-r--r--doc/html/RM_H5T.html6
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/html/H5.intro.html b/doc/html/H5.intro.html
index 2c0bb73..2b4d956 100644
--- a/doc/html/H5.intro.html
+++ b/doc/html/H5.intro.html
@@ -2356,7 +2356,7 @@ permutation of the array and the size of each dimension.
(<b>Note:</b> The permutation feature is not implemented in Release 1.4.)
<dir>
- <em>herr_t</em> <code>H5Tget_array_dims</code>(
+ <em>int</em> <code>H5Tget_array_dims</code>(
<em>hid_t</em> <code>adtype_id</code>,
<em>hsize_t *</em><code>dims[]</code>,
<em>int *</em><code>perm[]</code>
diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html
index 4a3e334..a877ff5 100644
--- a/doc/html/RM_H5T.html
+++ b/doc/html/RM_H5T.html
@@ -2946,13 +2946,13 @@ zero.
<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetArrayDims">H5Tget_array_dims</a>
<dt><strong>Signature:</strong>
- <dd><em>herr_t</em> <code>H5Tget_array_dims</code>(
+ <dd><em>int</em> <code>H5Tget_array_dims</code>(
<em>hid_t</em> <code>adtype_id</code>,
<em>hsize_t *</em><code>dims[]</code>,
<em>int *</em><code>perm[]</code>
)
<dt><strong>Purpose:</strong>
- <dd>Returns sizes of array dimensions and dimension permutations.
+ <dd>Retrieves sizes of array dimensions and dimension permutations.
<dt><strong>Description:</strong>
<dd><code>H5Tget_array_dims</code> returns the sizes of the dimensions
and the dimension permutations of the specified array datatype object.
@@ -2970,7 +2970,7 @@ zero.
<dd>OUT: Dimension permutations.
</dl>
<dt><strong>Returns:</strong>
- <dd>Returns a non-negative value if successful;
+ <dd>Returns the non-negative number of dimensions of the array type if successful;
otherwise returns a negative value.
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5t_FORTRAN.html#h5tget_array_dims_f"