diff options
author | Quincey Koziol <koziol@hdfgroup.org> | 2003-09-16 13:40:10 (GMT) |
---|---|---|
committer | Quincey Koziol <koziol@hdfgroup.org> | 2003-09-16 13:40:10 (GMT) |
commit | 3abb7a1f68153a8a2eab5920fe7715467ac26081 (patch) | |
tree | 6fd41968ff9b49aaf04afcc11cc7aa0b16c750f3 /doc | |
parent | 82515c8899a5266657ef2ad4e2935a29918b3c21 (diff) | |
download | hdf5-3abb7a1f68153a8a2eab5920fe7715467ac26081.zip hdf5-3abb7a1f68153a8a2eab5920fe7715467ac26081.tar.gz hdf5-3abb7a1f68153a8a2eab5920fe7715467ac26081.tar.bz2 |
[svn-r7477] Purpose:
Clarify documentation about H5Tset_size for string datatypes.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/RM_H5T.html | 4 |
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> |