summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-09-28 01:48:44 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-09-28 01:48:44 (GMT)
commitab1a73dd3a0a26b971db6474fc67f5d6a42d74a0 (patch)
tree8a34f258f1a886f45fd41c2f4a98094f72353b82 /doc
parent36583b79eb2e72d3fd0981d6e0523a022043f8f7 (diff)
downloadhdf5-ab1a73dd3a0a26b971db6474fc67f5d6a42d74a0.zip
hdf5-ab1a73dd3a0a26b971db6474fc67f5d6a42d74a0.tar.gz
hdf5-ab1a73dd3a0a26b971db6474fc67f5d6a42d74a0.tar.bz2
[svn-r1673] RM_H5T.html
Added H5Tget_member_offset. Corrected H5Tinsert description to read that an element of a compound datatype can itself be a compound datatype. Font correction. RM_H5F.html RM_H5T.html Updated return value descriptions for H5Fis_hdf5, H5Tcommitted, and H5Tequal to correspond to the earlier hbool_t -> htri_t change.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5F.html3
-rw-r--r--doc/html/RM_H5T.html47
2 files changed, 42 insertions, 8 deletions
diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html
index 272c37d..3fe6a4d 100644
--- a/doc/html/RM_H5F.html
+++ b/doc/html/RM_H5F.html
@@ -250,7 +250,8 @@ documented below.
<dd>File name to check format.
</dl>
<dt><strong>Returns:</strong>
- <dd>Returns <code>TRUE</code> or <code>FALSE</code> if successful.
+ <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>
diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html
index b109c54..33b960e 100644
--- a/doc/html/RM_H5T.html
+++ b/doc/html/RM_H5T.html
@@ -233,11 +233,13 @@ in the <cite>HDF5 User's Guide</cite> for further information, including a compl
able to share the datatype with other datasets in the same file.
<dt><strong>Parameters:</strong>
<dl>
- <dt>hid_t</em> <code>type</code>
+ <dt><em>hid_t</em> <code>type</code>
<dd>Datatype identifier.
</dl>
<dt><strong>Returns:</strong>
- <dd>The successful return values are TRUE if committed, else FALSE.
+ <dd>When successful, returns a positive value, for <code>TRUE</code>,
+ if the datatype has been committed, or <code>0</code> (zero),
+ for <code>FALSE</code>, if the datatype has not been committed.
Otherwise returns a negative value.
</dl>
@@ -604,8 +606,9 @@ H5Tget_overflow ()
<dd>Identifier of datatype to compare.
</dl>
<dt><strong>Returns:</strong>
- <dd>When successful, returns TRUE if the datatype identifiers
- refer to the same datatype, else FALSE.
+ <dd>When successful, returns a positive value, for <code>TRUE</code>,
+ if the datatype identifiers refer to the same datatype,
+ or <code>0</code> (zero), for <code>FALSE</code>.
Otherwise returns a negative value.
</dl>
@@ -1567,6 +1570,37 @@ zero.
<hr>
<dl>
+<dt><strong>Name:</strong> <a name="Datatype-GetMemberOffset">H5Tget_member_offset</a>
+<dt><strong>Signature:</strong>
+ <dd><em>size_t</em> <code>H5Tget_member_offset</code>(<em>hid_t </em><code>type_id</code>,
+ <em>int</em> <code>memb_no</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Retrieves the offset of a field of a compound datatype.
+<dt><strong>Description:</strong>
+ <dd><code>H5Tget_member_offset</code> retrieves the
+ byte offset of the beginning of a field within a
+ compound datatype with respect to the beginning
+ of the compound data type datum.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>type_id</code>
+ <dd>Identifier of datatype to query.
+ <dt><em>int</em> <code>memb_no</code>
+ <dd>Number of the field whose offset is requested.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns the byte offset of the field if successful;
+ otherwise returns <code>0</code> (zero).
+ Note that zero is a valid offset and that this function
+ will fail only if a call to <code>H5Tget_member_dims()</code>
+ fails with the same arguments.
+</dl>
+
+
+
+<hr>
+<dl>
<dt><strong>Name:</strong> <a name="Datatype-GetMemberDims">H5Tget_member_dims</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Tget_member_dims</code>(<em>hid_t </em><code>type_id</code>,
@@ -1647,9 +1681,8 @@ zero.
in an instance of the compound datatype, and <code>field_id</code>
is the datatype identifier of the new member.
<P>
- Note: All members of a compound datatype must be atomic; a
- compound datatype cannot have a member which is a compound
- datatype.
+ Note: Members of a compound datatype do not have to be atomic datatypes;
+ a compound datatype can have a member which is a compound datatype.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>type_id</code>