CkString AutoIt Reference Documentation

CkString

Current Version: 11.6.0

The Chilkat string class.

Object Creation

Local $oCkString = ObjCreate("Chilkat.CkString")

Register the 32-bit or 64-bit Chilkat ActiveX to match the AutoIt interpreter running the script (AutoIt3.exe or AutoIt3_x64.exe). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as ObjCreate("Chilkat.CkString.11") for Chilkat v11.*.*.

Boolean properties and arguments are integers in the ActiveX (1 or 0); AutoIt's True and False convert to them automatically. A method that fails to return an object returns Null. Methods and properties that pass or return raw byte arrays are not shown on this page; use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead.

Properties

NumArabic
NumArabic ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
NumAscii ; Integer (read-only)
Introduced in version 9.5.0.25

The number of us-ascii characters contained in this string.

top
NumCentralEuro
NumCentralEuro ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Central European and Eastern European characters found in this string. These are characters specific to Polish, Czech, Slovak, Hungarian, Slovene, Croatian, Serbian (Latin script), Romanian and Albanian.

top
NumChars
NumChars ; Integer (read-only)

To be documented soon...

top
NumChinese
NumChinese ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
NumCyrillic ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Cyrillic characters contained in this string. The Cyrillic alphabet also called azbuka, from the old name of the first two letters) is actually a family of alphabets, subsets of which are used by certain East and South Slavic languages ” Belarusian, Bulgarian, Macedonian, Russian, Rusyn, Serbian and Ukrainian”as well as many other languages of the former Soviet Union, Asia and Eastern Europe.

top
NumGreek
NumGreek ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
NumHebrew ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
NumJapanese ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
NumKorean ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
NumLatin ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Latin characters contained in this string. Latin characters include all major Western European languages, such as German, Spanish, French, Italian, Nordic languages, etc.

Note: This is the number of chars that are Latin characters that do not fall in the us-ascii range. In other words, the 8bit Latin chars.

top
NumThai
NumThai ; Integer (read-only)
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top
SizeAnsi
SizeAnsi ; Integer (read-only)

The size, in bytes, of the ANSI encoding of the string.

top
SizeUtf8
SizeUtf8 ; Integer (read-only)

The size, in bytes, of the utf-8 encoding of the string.

top
Str
Str ; String

The string value of this object.

top

Methods

AnsiCharAt
AnsiCharAt($iIndex) ; returns Integer

Returns the ASCII value of the Nth char in the string. The 1st char is at index 0.

top
Append
Append($sStr)

The str is appended to end of this instance.

top
AppendDateRfc3339
AppendDateRfc3339($vDt)

Appends a date/time string in RFC 3339 format to the end of this instance.

top
AppendDateRfc822
AppendDateRfc822($vDateTime)

The dateTime is appended in RFC 822 format to the end of this instance.

top
AppendEncoded
AppendEncoded($sStr, $sEncoding, $sCharset)

Appends characters from an encoded string. The encoding may be base64, hex, url, or quoted-printable. For example, to append ABC 123 from a URL-encoded string, call:

strObj.AppendEncoded(ABC+123,url,iso-8859-1)

More Information and Examples
top
AppendToFile
AppendToFile($sPath, $sCharsetEncoding) ; returns Boolean

Appends the contents of the string to a file. The string is first converted to the character encoding specified by charsetEncoding before being appended to the file.

More Information and Examples
top
BeginsWith
BeginsWith($sStr) ; returns Boolean

Returns True if the string begins with str. Otherwise returns False. This method is case sensitive.

top
ChopAfter
ChopAfter($sFindStr)

Truncates the string after the 1st occurrence of findStr. If findStr is not present, nothing is truncated.

top
ChopBefore
ChopBefore($sFindStr)

Truncates the string before the 1st occurrence of findStr. If findStr is not present, nothing is truncated.

top
Clear
Clear()

Clears the string. After calling this method, the string contains 0 characters.

top
Contains
Contains($sSubstr) ; returns Boolean

Returns True if substr is present in the string (case sensitive), otherwise returns False.

top
EndsWith
EndsWith($sSubstr) ; returns Boolean

Returns True if the string ends with substr (case-sensitive). Otherwise returns False.

top
GetEncoded
GetEncoded($sBinaryEncoding, $sCharsetEncoding) ; returns String

Returns the character string in an encoding use the charsetEncoding specified. The binaryEncoding may be base64, hex, url, or quoted-printable. For example:

(Visual Basic 6.0)

Dim s As New CkString

s.Str = èèè
Text1.Text = s.GetEncoded(hex, iso-8859-1) & vbCrLf
Text1.Text = Text.Text & s.GetEncoded(hex, utf-8) & vbCrLf
Text1.Text = Text1.Text & s.GetEncoded(hex, unicode)

'Output:
'E8E8E8
'C3A8C3A8C3A8
'E800E800E800

Returns Null on failure

More Information and Examples
top
HtmlEntityDecode
HtmlEntityDecode()

Decodes any HTML entities found in the string.

More Information and Examples
top
HtmlEntityEncode
HtmlEntityEncode()

HTML entity encodes all special characters. (Those characters that might require HTML entity encoding.)

More Information and Examples
top
LastAnsiChar
LastAnsiChar() ; returns Integer

Returns the ASCII value of the last character in the string.

top
Left
Left($iNumChars) ; returns String

Returns a string that is the leftmost numChars of this instance.

Returns Null on failure

top
Length
Length() ; returns Integer

Returns the length, in characters, of the string.

top
LoadFile
LoadFile($sPath, $sCharsetEncoding) ; returns Boolean

Loads an entire text file into the string object. The character encoding of the text file is specified by charsetEncoding. This method allows for text files in any charset to be loaded: utf-8, Unicode, Shift_JIS, iso-8859-1, etc.

More Information and Examples
top
Matches
Matches($sStrPattern, $bCaseSensitive) ; returns Boolean

Returns True if the string matches the strPattern, which may contain one or more asterisk wildcard characters. Case-sensitivity is controlled by , where 1 = case sensitive, 0 = case insensitive.

More Information and Examples
top
Mid
Mid($iIndex, $iNumChars) ; returns String

Same as the VB/VBScript Mid function, except that the 1st char is at index 0 (i.e. it is not 1-based). Returns a substring of length numChars starting at index.

Returns Null on failure

top
ParseDateRfc3339
ParseDateRfc3339() ; returns Date

Converts the date string (in RFC 3339 format) to a Date type.

More Information and Examples
top
ParseDateRfc822
ParseDateRfc822() ; returns Date

Converts the date string (in RFC 822 format) to a Date type.

More Information and Examples
top
Pluralize
Pluralize()

Pluralizes an English word.

More Information and Examples
top
Prepend
Prepend($sStr)

Prepends str to this instance.

top
PunyDecode
PunyDecode()
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

top
PunyEncode
PunyEncode()
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

top
RemoveAnsiChar
RemoveAnsiChar($iCh)

Removes all occurrences of ch from the string.

top
ReplaceAll
ReplaceAll($sFindStr, $sReplaceStr)

Replaces all occurrences of findStr with replaceStr. (case sensitive)

top
ReplaceAnsiChar
ReplaceAnsiChar($iFindCh, $iReplaceCh)

Replaces all occurrences of findCh with replaceCh.

top
ReplaceFirst
ReplaceFirst($sFindStr, $sReplaceStr)

Replaces the first occurrence of findStr with replaceStr. (case sensitive)

top
Right
Right($iNumChars) ; returns String

Returns a string that is the rightmost numChars of this instance.

Returns Null on failure

top
SaveToFile
SaveToFile($sPath, $sCharsetEncoding) ; returns Boolean

Saves the string to a file, using the character encoding specified by charsetEncoding. This method allows for the string to be saved using character encodings such as utf-8, Unicode, Shift-JIS, or anything else...

Returns True for success, False for failure.

More Information and Examples
top
Shorten
Shorten($iNumChars)

Removes the final numChars from the string.

top
StrComp
StrComp($sStr, $bCaseSensitive) ; returns Integer

Lexicographically compares two strings. Returns 0 if both strings are equal. A value greater than zero indicates that the first character that does not match has a greater value in the caller's string than in str; And a value less than zero indicates the opposite.

top
StripHtml
StripHtml()

Strips HTML tags from a string.

More Information and Examples
top
ToCRLF
ToCRLF()

Converts all line endings to CRLF.

top
ToLF
ToLF()

Converts all line endings to bare-LF (Unix/Linux style).

top
Trim
Trim()

Trim SPACE and Tab characters from both ends of the string.

top
Trim2
Trim2()

Trim SPACE, Tab, CR, and LF characters from both ends of the string.

top
TrimInside
TrimInside()

Replaces all tabs, CR's, and LF's, with SPACE chars, and removes extra SPACE's so there are no occurrences of more than one SPACE char in a row.

More Information and Examples
top
Unpluralize
Unpluralize()

Unpluralizes an English word.

More Information and Examples
top