CkCharsetW Unicode C++ Reference Documentation

CkCharsetW

A component/class for converting character data from one encoding to another. This software is unique in that the data required for converting to/from the supported charsets is entirely embedded witin the Chilkat DLL/library. It does not depend on what code pages may or may not be installed on a particular computer. This allows programs to operate correctly regardless of the locale, OS version, or other factors.

Properties

void get_AltToCharset(CkString &str);
const wchar_t *altToCharset(void);
void put_AltToCharset(const wchar_t *str);

If the ErrorAction property is set to 6, then this property controls how errors are handled. It specifies an alternate "To" charset. When a character in the input data cannot be converted to the target charset, an attempt is made to convert it to the AltToCharset. If that fails, the input character is dropped.

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

int get_ErrorAction(void);
void put_ErrorAction(int newVal);

Controls how errors are handled. When a character in the input data cannot be converted to the target charset, the action taken is controlled by this property. The possible settings are: (0) drop the error characters, (1) substitute the data set by the SetErrorBytes or SetErrorString method, (2) convert to a hex-escaped string (&#xXXXX), (3) RESERVED, (4) RESERVED, (5) RESERVED, (6) convert the error character to the AltToCharset instead, if that fails then drop the character, (7) Pass non-convertible characters to the output unchanged.

void get_FromCharset(CkString &str);
const wchar_t *fromCharset(void);
void put_FromCharset(const wchar_t *str);

Tells the charset converter the charset of the input data for a conversion. Possible values are:


us-ascii
unicode  (also known as UTF16LE or simply UTF16)
unicodefffe  (also known as UTF16BE)
ebcdic
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm01140
ibm01141
ibm01142
ibm01143
ibm01144
ibm01145
ibm01146
ibm01147
ibm01148
ibm01149
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastInputAsHex(CkString &str);
const wchar_t *lastInputAsHex(void);

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last input data in a hexidecimalized string.

void get_LastInputAsQP(CkString &str);
const wchar_t *lastInputAsQP(void);

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last input data in a quoted-printable string.

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

void get_LastOutputAsHex(CkString &str);
const wchar_t *lastOutputAsHex(void);

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last output data in a hexidecimalized string.

void get_LastOutputAsQP(CkString &str);
const wchar_t *lastOutputAsQP(void);

If SaveLast is set to true, then the input and output of a conversion is saved to allow the exact bytes that are sent to the converter to be seen (for debugging purposes). This property shows the last output data in a quoted-printable string.

bool get_SaveLast(void);
void put_SaveLast(bool newVal);

Tells the component to keep the input/output byte data in memory after a conversion is complete so the data can be examined via the LastInputAsHex/QP and LastOutputAsHex/QP properties. (for debugging purposes)

void get_ToCharset(CkString &str);
const wchar_t *toCharset(void);
void put_ToCharset(const wchar_t *str);

Tells the charset converter the target charset for a conversion. Possible values are:


us-ascii
unicode  (also known as UTF16LE or simply UTF16)
unicodefffe  (also known as UTF16BE)
ebcdic
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm01140
ibm01141
ibm01142
ibm01143
ibm01144
ibm01145
ibm01146
ibm01147
ibm01148
ibm01149
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

void get_Version(CkString &str);
const wchar_t *version(void);

Version of the component/library, such as "9.5.0.63"

Methods

int CharsetToCodePage(const wchar_t *charsetName);

Converts a charset name to a code page number. For example, "iso-8859-1" converts to code page 28591.

bool CodePageToCharset(int codePage, CkString &outCharset);
const wchar_t *codePageToCharset(int codePage);

Converts a code page number to a charset name. For example, 65001 converts to "utf-8".

Returns true for success, false for failure.

bool ConvertData(const void *inData, CkByteData &outData);
const wchar_t *convertData(const void *inData);

Converts character data from one charset to another. Before calling ConvertData, the FromCharset and ToCharset properties must be set to the source and destination charset names, such as "iso-8859-1" or "Shift_JIS".

Returns true for success, false for failure.

bool ConvertFile(const wchar_t *inPath, const wchar_t *destPath);

Converts a file from one character encoding to another. The FromCharset and ToCharset properties specify the source and destination character encodings. If the ToCharset is utf-16 or utf-8, then the preamble (also known as BOM) is included in the output. (Call ConvertFileNoPreamble to suppress the output of the BOM.)

Returns true for success, false for failure.

bool ConvertFileNoPreamble(const wchar_t *inPath, const wchar_t *destPath);

Converts a file from one character encoding to another. The FromCharset and ToCharset properties specify the source and destination character encodings. No preamble (also known as BOM) is included in the output.

bool ConvertFromUnicode(const wchar_t *inData, CkByteData &outBytes);
const wchar_t *convertFromUnicode(const wchar_t *inData);

Converts Unicode (utf-16) text to the charset specified by the ToCharset property.

Returns true for success, false for failure.

bool ConvertFromUtf16(const void *uniData, CkByteData &outMbData);
const wchar_t *convertFromUtf16(const void *uniData);

Converts utf-16 text to the charset specified by the ToCharset property.

Returns true for success, false for failure.

bool ConvertHtml(const void *inData, CkByteData &outHtml);
const wchar_t *convertHtml(const void *inData);

Converts HTML text from one character encoding to another. The FromCharset and ToCharset properties must be set prior to calling this method. This method automatically edits the META tag within the HTML that indicates the charset.

Returns true for success, false for failure.

bool ConvertHtmlFile(const wchar_t *inPath, const wchar_t *destPath);

Converts an HTML file from one character encoding to another. The ToCharset properties must be set prior to calling this method. If the FromCharset is not set, it is obtained from the HTML META tag that indicates the charset. This method automatically edits the META tag within the HTML that indicates the charset.

Returns true for success, false for failure.

bool ConvertToUnicode(const void *inData, CkString &outStr);
const wchar_t *convertToUnicode(const void *inData);

Converts multibyte character data to a Unicode string. The FromCharset property should be set before calling this method.

Returns true for success, false for failure.

bool ConvertToUtf16(const void *mbData, CkByteData &outUniData);
const wchar_t *convertToUtf16(const void *mbData);

To be documented soon.

Returns true for success, false for failure.

bool EntityEncodeDec(const wchar_t *str, CkString &outStr);
const wchar_t *entityEncodeDec(const wchar_t *str);

Converts non-US-ASCII characters to Unicode decimal entities (&#xxxxx;)

Returns true for success, false for failure.

bool EntityEncodeHex(const wchar_t *str, CkString &outStr);
const wchar_t *entityEncodeHex(const wchar_t *str);

Converts non-US-ASCII characters to Unicode hex entities (&#xXXXX;)

Returns true for success, false for failure.

bool GetHtmlCharset(const void *inData, CkString &outCharset);
const wchar_t *getHtmlCharset(const void *inData);

Examines HTML text and extracts the charset name specified by the META tag, if present.

Returns true for success, false for failure.

bool GetHtmlFileCharset(const wchar_t *htmlFilePath, CkString &outCharset);
const wchar_t *getHtmlFileCharset(const wchar_t *htmlFilePath);

Examines an HTML file and extracts the charset name specified by the META tag, if present.

Returns true for success, false for failure.

bool HtmlDecodeToStr(const wchar_t *inStr, CkString &outStr);
const wchar_t *htmlDecodeToStr(const wchar_t *inStr);

Converts HTML entities to Unicode characters.

Returns true for success, false for failure.

bool HtmlEntityDecode(const void *inHtml, CkByteData &outData);
const wchar_t *htmlEntityDecode(const void *inHtml);

Decodes HTML entities. See http://www.w3.org/TR/REC-html40/sgml/entities.html for information on HTML entities. Examples of HTML entities are < , å , å , 水 , Í , etc.

Returns true for success, false for failure.

bool HtmlEntityDecodeFile(const wchar_t *inPath, const wchar_t *destPath);

Decodes HTML entities in a file and creates a new HTML file with the entities decoded. See http://www.w3.org/TR/REC-html40/sgml/entities.html for information on HTML entities. Examples of HTML entities are < , å , å , 水 , Í , etc.

Returns true for success, false for failure.

bool IsUnlocked(void);

Returns true if the component is unlocked.

bool LowerCase(const wchar_t *inStr, CkString &outStr);
const wchar_t *lowerCase(const wchar_t *inStr);

Converts a string to lowercase.

Returns true for success, false for failure.

bool ReadFile(const wchar_t *path, CkByteData &outData);
const wchar_t *readFile(const wchar_t *path);

Convenience method for reading the entire contents of a file into a byte array.

Returns true for success, false for failure.

bool ReadFileToString(const wchar_t *path, const wchar_t *charset, CkString &outStr);
const wchar_t *readFileToString(const wchar_t *path, const wchar_t *charset);

Reads a text file and returns the text converted to a Unicode string. The filename is specified by the first method argument, and the charset of the text data is specified by the 2nd method argument.

Returns true for success, false for failure.

bool SaveLastError(const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

void SetErrorBytes(const void *data);

If the ErrorAction property is set to 1, the bytes passed to this method are used as the result for any characters that cannot be converted during a conversion.

void SetErrorString(const wchar_t *str, const wchar_t *charset);

If the ErrorAction property is set to 1, the string passed to this method is used as the result for any characters that cannot be converted during a conversion.

bool UnlockComponent(const wchar_t *unlockCode);

Unlocks the component. This method must be called once at the beginning of the program. Properties can be get/set without unlocking, but methods will not work unless the component has been unlocked.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

bool UpperCase(const wchar_t *inStr, CkString &outStr);
const wchar_t *upperCase(const wchar_t *inStr);

Converts a string to uppercase.

Returns true for success, false for failure.

bool UrlDecodeStr(const wchar_t *inStr, CkString &outStr);
const wchar_t *urlDecodeStr(const wchar_t *inStr);

URL decodes a string.

Returns true for success, false for failure.

bool VerifyData(const wchar_t *charset, const void *inData);

Returns true if the byte data conforms to the charset passed in the first argument.

bool VerifyFile(const wchar_t *charset, const wchar_t *path);

Returns true if the file contains character data that conforms to the charset passed in the 1st argument.

bool WriteFile(const wchar_t *path, const void *byteData);

Convenience method for saving an entire byte array to a file.

bool WriteStringToFile(const wchar_t *textData, const wchar_t *path, const wchar_t *charset);

Converts a Unicode string to a multibyte charset and writes the multibyte text data to a file. The destination charset is specified in the 2nd method argument.

Returns true for success, false for failure.