diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2014-10-02 14:59:01 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2014-10-02 14:59:01 (GMT) |
| commit | bd9c6d829acd95ba78b07c8d286eae81d74cd1c9 (patch) | |
| tree | fd753147d80ea057105b9fa18d7eca55d9a27735 | |
| parent | cbd0112b16e4da4811226beb03144db4c5ed10d2 (diff) | |
| download | hdf5-bd9c6d829acd95ba78b07c8d286eae81d74cd1c9.zip hdf5-bd9c6d829acd95ba78b07c8d286eae81d74cd1c9.tar.gz hdf5-bd9c6d829acd95ba78b07c8d286eae81d74cd1c9.tar.bz2 | |
[svn-r25658] Purpose: Fixed HDFFV-8922
Description:
Added notes regarding UTF-8 and extended ASCII, provided in HDFFV-8899,
to C++ API.
Platforms tested:
Linux/32 2.6 (jam) - only in comments
| -rw-r--r-- | c++/src/H5StrType.cpp | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp index a906b72..5195bba 100644 --- a/c++/src/H5StrType.cpp +++ b/c++/src/H5StrType.cpp @@ -146,6 +146,13 @@ StrType::StrType( const DataSet& dataset ) : AtomType () ///\brief Retrieves the character set type of this string datatype. ///\return Character set type, which can be: /// \li \c H5T_CSET_ASCII (0) - Character set is US ASCII. +///\note +/// ASCII and UTF-8 Unicode are the only currently supported character +/// encodings. Extended ASCII encodings (for example, ISO 8859) are not +/// supported. This encoding policy is not enforced by the HDF5 Library. +/// Using encodings other than ASCII and UTF-8 can lead to compatibility +/// and usability problems. See the C API entry H5Pset_char_encoding for +/// more information. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- @@ -166,6 +173,13 @@ H5T_cset_t StrType::getCset() const ///\brief Sets character set to be used. ///\param cset - IN: character set type, which can be: /// \li \c H5T_CSET_ASCII (0) - Character set is US ASCII. +///\note +/// ASCII and UTF-8 Unicode are the only currently supported character +/// encodings. Extended ASCII encodings (for example, ISO 8859) are not +/// supported. This encoding policy is not enforced by the HDF5 Library. +/// Using encodings other than ASCII and UTF-8 can lead to compatibility +/// and usability problems. See the C API entry H5Pset_char_encoding for +/// more information. ///\exception H5::DataTypeIException // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- |