ChilkatCharset2 ActiveX Reference (Visual Basic)

ChilkatCharset2

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

AltToCharset As String

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.

ErrorAction As Long

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.

FromCharset As String

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

us-ascii
unicode
unicodefffe
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
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u

LastErrorHtml As String (read-only)

Error information in HTML format for the last method called.

LastErrorText As String (read-only)

Error information in plain-text format for the last method called.

LastErrorXml As String (read-only)

Error information in XML format for the last method called.

LastInputAsHex As String (read-only)

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.

LastInputAsQP As String (read-only)

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.

LastOutputAsHex As String (read-only)

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.

LastOutputAsQP As String (read-only)

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.

SaveLast As Long

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)

ToCharset As String

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

us-ascii
unicode
unicodefffe
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
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u

Version As String (read-only)

Returns the version of the component, such as "9.0.0"

Methods

CharsetToCodePage(charsetName As String) As Long

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

CodePageToCharset(codePage As Long) As String

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

Returns a null on failure

ConvertData(inCharData As Variant) As Variant

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 a zero-length byte array (as a Variant) on failure

ConvertFile(inFilename As String, outFilename As String) As Long

Converts a file from one character encoding to another. The FromCharset and ToCharset properties must be set to the source and destination character encodings before calling this method.

ConvertFromUnicode(str As String) As Variant

Converts Unicode text to the charset specified by the ToCharset property.

Returns a zero-length byte array (as a Variant) on failure

ConvertHtml(htmlIn As Variant) As Variant

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 a zero-length byte array (as a Variant) on failure

ConvertHtmlFile(inFilename As String, outFilename As String) As Long

Converts an HTML file 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.

ConvertToUnicode(inData As Variant) As String

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

Returns a null on failure

EntityEncodeDec(inStr As String) As String

To be documented soon...

EntityEncodeHex(inStr As String) As String

To be documented soon...

FromVB6(inStr As String, charset As String) As String

The reverse of ToVB6.

Returns a null on failure

GetHtmlCharset(htmlData As Variant) As String

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

Returns a null on failure

GetHtmlFileCharset(htmlFilename As String) As String

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

Returns a null on failure

HtmlDecodeToStr(inStr As String) As String

Converts HTML entities to Unicode characters.

Returns a null on failure

HtmlEntityDecode(inHtml As Variant) As Variant

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 a zero-length byte array (as a Variant) on failure

HtmlEntityDecodeFile(inFilename As String, outFilename As String) As Long

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 1 for success, 0 for failure.

IsUnlocked() As Long

Returns true if the component is unlocked.

LowerCase(inStr As String) As String

To be documented soon...

ReadFile(filename As String) As Variant

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

Returns a zero-length byte array (as a Variant) on failure

SaveLastError(filename As String) As Long

Saves the last error information to an XML formatted file.

SetErrorBytes(newVal As Variant)

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.

SetErrorString(newVal As String, charset As String)

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.

ToVB6(inStr As String, charset As String) As String

Converts a Unicode string to another Unicode string to be displayed in a VB6 TextBox or Label control in any language. Refer to http://www.example-code.com/vb/vbUnicode2.asp for more information.

Returns a null on failure

UnlockComponent(unlockCode As String) As Long

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.

UpperCase(inStr As String) As String

To be documented soon...

UrlDecode(inData As Variant) As Variant

Decodes a URL-encoded Variant (which could contain a string or byte array) and returns a URL-decoded Variant containing a byte array.

Returns a zero-length byte array (as a Variant) on failure

VerifyData(charset As String, charData As Variant) As Long

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

VerifyFile(charset As String, filename As String) As Long

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

WriteFile(filename As String, binaryData As Variant) As Long

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