ICU-8006 Update isFixedWidth API doc in ICU4C.

X-SVN-Rev: 29704
This commit is contained in:
Michael Ow 2011-03-29 04:20:18 +00:00
parent 2a669af439
commit 4ce8f58d86

View File

@ -1992,10 +1992,14 @@ ucnv_fromUCountPending(const UConverter* cnv, UErrorCode* status);
U_STABLE int32_t U_EXPORT2
ucnv_toUCountPending(const UConverter* cnv, UErrorCode* status);
/**
* Returns whether or not the converter has a fixed number of bytes
* per character (e.g. converters that are SBCS or DBCS).
* Returns whether or not the charset of the converter has a fixed number of bytes
* per charset character.
* An example of this are converters that are of the type UCNV_SBCS or UCNV_DBCS.
* Another example is UTF-32 which is always 4 bytes per character. A UTF-32 code point
* may represent more than one UTF-8 or UTF-16 code units but always have size of 4 bytes.
* Note: This method is not intended to be used to determine whether the charset has a
* fixed ratio of bytes to Unicode codes units for any particular Unicode encoding form.
* FALSE is returned with the UErrorCode if error occurs or cnv is NULL.
* @param cnv The converter to be tested
* @param status ICU error code in/out paramter