From de56222826f6a48437c059f3ce228dd88ae94ead Mon Sep 17 00:00:00 2001 From: Binh-Minh Ribler Date: Wed, 1 Oct 2014 23:56:42 -0500 Subject: [svn-r25656] 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 --- c++/src/H5StrType.cpp | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/c++/src/H5StrType.cpp b/c++/src/H5StrType.cpp index a906b72..0593a47 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 //-------------------------------------------------------------------------- -- cgit v0.12