[svn-r3666]

Purpose:
    Bugfixes and a new description of file-closing behavior.
Description:
    h5.intro.html -- Fixed HTML coding errors.
    RM_H5.html -- H5close -- Corrected typo.
    RM_H5F.html -- H5Fclose -- Added paragraph clarifying behavior if
            any OIDs for contained objects are still open.
    RM_H5T.html -- H5Tget_strpad -- Corrected description; appears that
            this did not get updated in synchrony with H5Tset_strpad.
        H5Tset_strpad -- Corrected 'strpad' parameter description.
    RM_H5S.html -- H5Sselect_valid -- Corrected description of space_id
             parameter.
    RM_H5P.html -- H5Pget_driver -- Corrected return type.
Platforms tested:
    IE 5
This commit is contained in:
Frank Baker
2001-03-19 18:26:51 -05:00
parent dadeb7e4f8
commit b03ed1dcec
6 changed files with 22 additions and 16 deletions

View File

@@ -1801,23 +1801,18 @@ zero.
<dd><em>H5T_str_t </em><code>H5Tget_strpad</code>(<em>hid_t </em><code>type_id</code>
)
<dt><strong>Purpose:</strong>
<dd>Retrieves the string padding method for a string datatype.
<dd>Retrieves the storage mechanism for a string datatype.
<dt><strong>Description:</strong>
<dd><code>H5Tget_strpad</code> retrieves the string padding method
for a string datatype. Valid string padding types are:
<ul> <dl>
<dt>H5T_STR_NULL (<code>0</code>)
<dd>Pad with zeros (as C does)
<dt>H5T_STR_SPACE (<code>1</code>)
<dd>Pad with spaces (as FORTRAN does)
</dl> </ul>
<dd><code>H5Tget_strpad</code> retrieves the storage mechanism
for a string datatype, as defined in
<a href="#Datatype-SetStrpad"><code>H5Tset_strpad</code></a>.
<dt><strong>Parameters:</strong>
<dl>
<dt><em>hid_t</em> <code>type_id</code>
<dd>Identifier of datatype to query.
</dl>
<dt><strong>Returns:</strong>
<dd>Returns a valid string padding type if successful;
<dd>Returns a valid string storage mechanism if successful;
otherwise <code>H5T_STR_ERROR</code> (-1).
<dt><strong>Non-C API(s):</strong>
<dd><a href="fortran/h5t_FORTRAN.html#h5tget_strpad_f"