diff options
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/RM_H5D.html | 3 | ||||
| -rw-r--r-- | doc/html/RM_H5T.html | 39 | ||||
| -rw-r--r-- | doc/html/Tools.html | 4 |
3 files changed, 33 insertions, 13 deletions
diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 94ba4f5..1473dc3 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -204,8 +204,7 @@ facilitate moving easily between them.</i> <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>Identifier of the dataset to open or the file or group - to access the dataset within. + <dd>Identifier of the file or group to access the dataset within. <dt><em>const char *</em> <code>name</code> <dd>The name of the dataset to access. </dl> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 3dde985..f49c490 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -880,8 +880,8 @@ H5Tget_overflow () <li><code>H5T_BITFIELD</code> (<code>4</code>) <li><code>H5T_OPAQUE</code> (<code>5</code>) <li><code>H5T_COMPOUND</code> (<code>6</code>) - <li><code>H5T_ENUM</code> (<code>7</code>) - <li><code>H5T_REFERENCE</code> (<code>8</code>) + <li><code>H5T_REFERENCE</code> (<code>7</code>) + <li><code>H5T_ENUM</code> (<code>8</code>) </ul> <dt><strong>Parameters:</strong> <dl> @@ -1918,17 +1918,36 @@ zero. <dt><strong>Purpose:</strong> <dd>Defines the storage mechanism for character strings. <dt><strong>Description:</strong> - <dd>The method used to store character strings differs with the - programming language: C usually null terminates strings while - Fortran left-justifies and space-pads strings. - <code>H5Tset_strpad</code> defines the storage mechanism for the string. - Valid string padding values are: + <dd><code>H5Tset_strpad</code> defines the storage mechanism for the string. + <p> + The method used to store character strings differs with the + programming language: + <ul> + <li>C usually null terminates strings while + <li>Fortran left-justifies and space-pads strings. + </ul> + Valid string padding values, as passed in the parameter + <code>strpad</code>, are as follows: <ul> <dl> - <dt>H5T_STR_NULL (<code>0</code>) - <dd>Pad with zeros (as C does) - <dt>H5T_STR_SPACE (<code>1</code>) + <dt>H5T_STR_NULLTERM (<code>0</code>) + <dd>Null terminate (as C does) + <dt>H5T_STR_NULLPAD (<code>1</code>) + <dd>Pad with zeros + <dt>H5T_STR_SPACEPAD (<code>2</code>) <dd>Pad with spaces (as FORTRAN does) </dl> </ul> + <p> + When converting from a longer string to a shorter string, + the behavior is as follows. + If the short string is <code>H5T_STR_NULLPAD</code> or + <code>H5T_STR_SPACEPAD</code>, then the string is simply truncated. + If the short string is <code>H5T_STR_NULLTERM</code>, it is + truncated and a null terminator is appended. + <p> + When converting from a shorter string to a longer string, + the long string is padded on the end by appending nulls or spaces. + + <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>type_id</code> diff --git a/doc/html/Tools.html b/doc/html/Tools.html index ed23ea9..d86414c 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -130,8 +130,10 @@ These tools enable the user to examine HDF5 files interactively. <dt><code>-h</code> <dd>Prints information on this command and exits. <dt><code>-bb</code> - <dd>Displays the contents of the boot block. The default is + <dd>Displays the contents of the super block. The default is not to display. + <BR> + <em>(This option is not yet implemented.)</em> <dt><code>-header</code> <dd>Displays header information only; no data is displayed. <dt><code>-V</code> |