summaryrefslogtreecommitdiffstats
path: root/doc/html
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2003-09-16 13:40:04 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2003-09-16 13:40:04 (GMT)
commitf4f1c62cc5f6dd7224be1a1f6e27d6cd7b7bcabe (patch)
treea1caecdf52403dfd68b1339e947243dec07c823e /doc/html
parent6953e9a0101f6fca7183a0be80e0c34c7eedc692 (diff)
downloadhdf5-f4f1c62cc5f6dd7224be1a1f6e27d6cd7b7bcabe.zip
hdf5-f4f1c62cc5f6dd7224be1a1f6e27d6cd7b7bcabe.tar.gz
hdf5-f4f1c62cc5f6dd7224be1a1f6e27d6cd7b7bcabe.tar.bz2
[svn-r7476] Purpose:
Clarify documentation about H5Tset_size for string datatypes.
Diffstat (limited to 'doc/html')
-rw-r--r--doc/html/RM_H5T.html4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html
index 7895b71..62e858b 100644
--- a/doc/html/RM_H5T.html
+++ b/doc/html/RM_H5T.html
@@ -1077,7 +1077,9 @@ H5Tget_overflow ()
toward zero. If the `offset' becomes zero and the significant
bits of the datatype still hang over the edge of the new size, then
the number of significant bits is decreased.
- Adjusting the size of an H5T_STRING automatically sets the precision
+ The size set for a string should include space for the null-terminator
+ character, otherwise it will not be stored on (or retrieved from) disk.
+ Adjusting the size of an string automatically sets the precision
to 8*size. A compound datatype may increase in size, but may not
shrink. All datatypes must have a positive size.
<dt><strong>Parameters:</strong>