---
product: Chilkat
product_version: 11.7.0
language: autoit
language_label: AutoIt
class: CkString
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/autoit_CkStringRef.html
---
# Chilkat CkString — AutoIt — v11.7.0

> Chilkat 11.7.0 · language=autoit · class=CkString
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/CkString.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/autoit/guide.md`.

## Purpose

The Chilkat string class.

## Object creation, unlocking and error handling

**Object Creation**

```autoit
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.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in AutoIt.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumArabic` | property, read-only | `NumArabic ; Integer (read-only)` |
| `NumAscii` | property, read-only | `NumAscii ; Integer (read-only)` |
| `NumCentralEuro` | property, read-only | `NumCentralEuro ; Integer (read-only)` |
| `NumChars` | property, read-only | `NumChars ; Integer (read-only)` |
| `NumChinese` | property, read-only | `NumChinese ; Integer (read-only)` |
| `NumCyrillic` | property, read-only | `NumCyrillic ; Integer (read-only)` |
| `NumGreek` | property, read-only | `NumGreek ; Integer (read-only)` |
| `NumHebrew` | property, read-only | `NumHebrew ; Integer (read-only)` |
| `NumJapanese` | property, read-only | `NumJapanese ; Integer (read-only)` |
| `NumKorean` | property, read-only | `NumKorean ; Integer (read-only)` |
| `NumLatin` | property, read-only | `NumLatin ; Integer (read-only)` |
| `NumThai` | property, read-only | `NumThai ; Integer (read-only)` |
| `SizeAnsi` | property, read-only | `SizeAnsi ; Integer (read-only)` |
| `SizeUtf8` | property, read-only | `SizeUtf8 ; Integer (read-only)` |
| `Str` | property, read/write | `Str ; String` |
| `AnsiCharAt` | method | `AnsiCharAt($iIndex) ; returns Integer` |
| `Append` | method | `Append($sStr)` |
| `AppendDateRfc3339` | method | `AppendDateRfc3339($vDt)` |
| `AppendDateRfc822` | method | `AppendDateRfc822($vDt)` |
| `AppendEncoded` | method | `AppendEncoded($sStr, $sEncoding, $sCharset)` |
| `AppendToFile` | method | `AppendToFile($sPath, $sCharsetEncoding) ; returns Boolean` |
| `BeginsWith` | method | `BeginsWith($sStr) ; returns Boolean` |
| `ChopAfter` | method | `ChopAfter($sFindStr)` |
| `ChopBefore` | method | `ChopBefore($sFindStr)` |
| `Clear` | method | `Clear()` |
| `Contains` | method | `Contains($sSubstr) ; returns Boolean` |
| `EndsWith` | method | `EndsWith($sSubstr) ; returns Boolean` |
| `GetEncoded` | method | `GetEncoded($sBinaryEncoding, $sCharsetEncoding) ; returns String` |
| `HtmlEntityDecode` | method | `HtmlEntityDecode()` |
| `HtmlEntityEncode` | method | `HtmlEntityEncode()` |
| `LastAnsiChar` | method | `LastAnsiChar() ; returns Integer` |
| `Left` | method | `Left($iNumChars) ; returns String` |
| `Length` | method | `Length() ; returns Integer` |
| `LoadFile` | method | `LoadFile($sPath, $sCharsetEncoding) ; returns Boolean` |
| `Matches` | method | `Matches($sStrPattern, $bCaseSensitive) ; returns Boolean` |
| `Mid` | method | `Mid($iIndex, $iNumChars) ; returns String` |
| `ParseDateRfc3339` | method | `ParseDateRfc3339() ; returns Date` |
| `ParseDateRfc822` | method | `ParseDateRfc822() ; returns Date` |
| `Pluralize` | method | `Pluralize()` |
| `Prepend` | method | `Prepend($sStr)` |
| `PunyDecode` | method | `PunyDecode()` |
| `PunyEncode` | method | `PunyEncode()` |
| `RemoveAnsiChar` | method | `RemoveAnsiChar($iCh)` |
| `ReplaceAll` | method | `ReplaceAll($sFindStr, $sReplaceStr)` |
| `ReplaceAnsiChar` | method | `ReplaceAnsiChar($iFindCh, $iReplaceCh)` |
| `ReplaceFirst` | method | `ReplaceFirst($sFindStr, $sReplaceStr)` |
| `Right` | method | `Right($iNumChars) ; returns String` |
| `SaveToFile` | method | `SaveToFile($sPath, $sCharsetEncoding) ; returns Boolean` |
| `Shorten` | method | `Shorten($iNumChars)` |
| `StrComp` | method | `StrComp($sStr, $bCaseSensitive) ; returns Integer` |
| `StripHtml` | method | `StripHtml()` |
| `ToCRLF` | method | `ToCRLF()` |
| `ToLF` | method | `ToLF()` |
| `Trim` | method | `Trim()` |
| `Trim2` | method | `Trim2()` |
| `TrimInside` | method | `TrimInside()` |
| `Unpluralize` | method | `Unpluralize()` |

## Properties

### CkString.NumArabic

`Chilkat 11.7.0 · autoit · CkString · NumArabic · property · read-only · since 9.5.0.25`

```autoit
NumArabic  ; Integer (read-only)
```

The number of Arabic characters contained in this string.

### CkString.NumAscii

`Chilkat 11.7.0 · autoit · CkString · NumAscii · property · read-only · since 9.5.0.25`

```autoit
NumAscii  ; Integer (read-only)
```

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

### CkString.NumCentralEuro

`Chilkat 11.7.0 · autoit · CkString · NumCentralEuro · property · read-only · since 9.5.0.25`

```autoit
NumCentralEuro  ; Integer (read-only)
```

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.

### CkString.NumChars

`Chilkat 11.7.0 · autoit · CkString · NumChars · property · read-only`

```autoit
NumChars  ; Integer (read-only)
```

The number of characters in the string.

### CkString.NumChinese

`Chilkat 11.7.0 · autoit · CkString · NumChinese · property · read-only · since 9.5.0.25`

```autoit
NumChinese  ; Integer (read-only)
```

The number of Chinese characters contained in this string.

### CkString.NumCyrillic

`Chilkat 11.7.0 · autoit · CkString · NumCyrillic · property · read-only · since 9.5.0.25`

```autoit
NumCyrillic  ; Integer (read-only)
```

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.

### CkString.NumGreek

`Chilkat 11.7.0 · autoit · CkString · NumGreek · property · read-only · since 9.5.0.25`

```autoit
NumGreek  ; Integer (read-only)
```

The number of Greek characters contained in this string.

### CkString.NumHebrew

`Chilkat 11.7.0 · autoit · CkString · NumHebrew · property · read-only · since 9.5.0.25`

```autoit
NumHebrew  ; Integer (read-only)
```

The number of Hebrew characters contained in this string.

### CkString.NumJapanese

`Chilkat 11.7.0 · autoit · CkString · NumJapanese · property · read-only · since 9.5.0.25`

```autoit
NumJapanese  ; Integer (read-only)
```

The number of Japanese characters contained in this string.

### CkString.NumKorean

`Chilkat 11.7.0 · autoit · CkString · NumKorean · property · read-only · since 9.5.0.25`

```autoit
NumKorean  ; Integer (read-only)
```

The number of Korean characters contained in this string.

### CkString.NumLatin

`Chilkat 11.7.0 · autoit · CkString · NumLatin · property · read-only · since 9.5.0.25`

```autoit
NumLatin  ; Integer (read-only)
```

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.

### CkString.NumThai

`Chilkat 11.7.0 · autoit · CkString · NumThai · property · read-only · since 9.5.0.25`

```autoit
NumThai  ; Integer (read-only)
```

The number of Thai characters contained in this string.

### CkString.SizeAnsi

`Chilkat 11.7.0 · autoit · CkString · SizeAnsi · property · read-only`

```autoit
SizeAnsi  ; Integer (read-only)
```

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

### CkString.SizeUtf8

`Chilkat 11.7.0 · autoit · CkString · SizeUtf8 · property · read-only`

```autoit
SizeUtf8  ; Integer (read-only)
```

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

### CkString.Str

`Chilkat 11.7.0 · autoit · CkString · Str · property · read/write`

```autoit
Str  ; String
```

The string value of this object.

## Methods

### CkString.AnsiCharAt

`Chilkat 11.7.0 · autoit · CkString · AnsiCharAt · method`

```autoit
AnsiCharAt($iIndex)  ; returns Integer
```

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

### CkString.Append

`Chilkat 11.7.0 · autoit · CkString · Append · method`

```autoit
Append($sStr)
```

The `str` is appended to end of this instance.

### CkString.AppendDateRfc3339

`Chilkat 11.7.0 · autoit · CkString · AppendDateRfc3339 · method`

```autoit
AppendDateRfc3339($vDt)
```

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

### CkString.AppendDateRfc822

`Chilkat 11.7.0 · autoit · CkString · AppendDateRfc822 · method`

```autoit
AppendDateRfc822($vDt)
```

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

### CkString.AppendEncoded

`Chilkat 11.7.0 · autoit · CkString · AppendEncoded · method`

```autoit
AppendEncoded($sStr, $sEncoding, $sCharset)
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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)
```

### CkString.AppendToFile

`Chilkat 11.7.0 · autoit · CkString · AppendToFile · method`

```autoit
AppendToFile($sPath, $sCharsetEncoding)  ; returns Boolean
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.BeginsWith

`Chilkat 11.7.0 · autoit · CkString · BeginsWith · method`

```autoit
BeginsWith($sStr)  ; returns Boolean
```

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

### CkString.ChopAfter

`Chilkat 11.7.0 · autoit · CkString · ChopAfter · method`

```autoit
ChopAfter($sFindStr)
```

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

### CkString.ChopBefore

`Chilkat 11.7.0 · autoit · CkString · ChopBefore · method`

```autoit
ChopBefore($sFindStr)
```

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

### CkString.Clear

`Chilkat 11.7.0 · autoit · CkString · Clear · method`

```autoit
Clear()
```

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

### CkString.Contains

`Chilkat 11.7.0 · autoit · CkString · Contains · method`

```autoit
Contains($sSubstr)  ; returns Boolean
```

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

### CkString.EndsWith

`Chilkat 11.7.0 · autoit · CkString · EndsWith · method`

```autoit
EndsWith($sSubstr)  ; returns Boolean
```

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

### CkString.GetEncoded

`Chilkat 11.7.0 · autoit · CkString · GetEncoded · method`

```autoit
GetEncoded($sBinaryEncoding, $sCharsetEncoding)  ; returns String
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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

### CkString.HtmlEntityDecode

`Chilkat 11.7.0 · autoit · CkString · HtmlEntityDecode · method`

```autoit
HtmlEntityDecode()
```

Decodes any HTML entities found in the string.

### CkString.HtmlEntityEncode

`Chilkat 11.7.0 · autoit · CkString · HtmlEntityEncode · method`

```autoit
HtmlEntityEncode()
```

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

### CkString.LastAnsiChar

`Chilkat 11.7.0 · autoit · CkString · LastAnsiChar · method`

```autoit
LastAnsiChar()  ; returns Integer
```

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

### CkString.Left

`Chilkat 11.7.0 · autoit · CkString · Left · method`

```autoit
Left($iNumChars)  ; returns String
```

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

Returns `Null` on failure

### CkString.Length

`Chilkat 11.7.0 · autoit · CkString · Length · method`

```autoit
Length()  ; returns Integer
```

Returns the length, in characters, of the string.

### CkString.LoadFile

`Chilkat 11.7.0 · autoit · CkString · LoadFile · method`

```autoit
LoadFile($sPath, $sCharsetEncoding)  ; returns Boolean
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.Matches

`Chilkat 11.7.0 · autoit · CkString · Matches · method`

```autoit
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.

### CkString.Mid

`Chilkat 11.7.0 · autoit · CkString · Mid · method`

```autoit
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

### CkString.ParseDateRfc3339

`Chilkat 11.7.0 · autoit · CkString · ParseDateRfc3339 · method`

```autoit
ParseDateRfc3339()  ; returns Date
```

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

### CkString.ParseDateRfc822

`Chilkat 11.7.0 · autoit · CkString · ParseDateRfc822 · method`

```autoit
ParseDateRfc822()  ; returns Date
```

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

### CkString.Pluralize

`Chilkat 11.7.0 · autoit · CkString · Pluralize · method`

```autoit
Pluralize()
```

Pluralizes an English word.

### CkString.Prepend

`Chilkat 11.7.0 · autoit · CkString · Prepend · method`

```autoit
Prepend($sStr)
```

Prepends `str` to this instance.

### CkString.PunyDecode

`Chilkat 11.7.0 · autoit · CkString · PunyDecode · method · since 9.5.0.52`

```autoit
PunyDecode()
```

In-place decodes the string from punycode.

### CkString.PunyEncode

`Chilkat 11.7.0 · autoit · CkString · PunyEncode · method · since 9.5.0.52`

```autoit
PunyEncode()
```

In-place encodes the string to punycode.

### CkString.RemoveAnsiChar

`Chilkat 11.7.0 · autoit · CkString · RemoveAnsiChar · method`

```autoit
RemoveAnsiChar($iCh)
```

Removes all occurrences of `ch` from the string.

### CkString.ReplaceAll

`Chilkat 11.7.0 · autoit · CkString · ReplaceAll · method`

```autoit
ReplaceAll($sFindStr, $sReplaceStr)
```

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

### CkString.ReplaceAnsiChar

`Chilkat 11.7.0 · autoit · CkString · ReplaceAnsiChar · method`

```autoit
ReplaceAnsiChar($iFindCh, $iReplaceCh)
```

Replaces all occurrences of `findCh` with `replaceCh`.

### CkString.ReplaceFirst

`Chilkat 11.7.0 · autoit · CkString · ReplaceFirst · method`

```autoit
ReplaceFirst($sFindStr, $sReplaceStr)
```

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

### CkString.Right

`Chilkat 11.7.0 · autoit · CkString · Right · method`

```autoit
Right($iNumChars)  ; returns String
```

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

Returns `Null` on failure

### CkString.SaveToFile

`Chilkat 11.7.0 · autoit · CkString · SaveToFile · method`

```autoit
SaveToFile($sPath, $sCharsetEncoding)  ; returns Boolean
```

**Full documentation for this method (same in every language):** [Supported Character Encodings](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

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.

### CkString.Shorten

`Chilkat 11.7.0 · autoit · CkString · Shorten · method`

```autoit
Shorten($iNumChars)
```

Removes the final `numChars` from the string.

### CkString.StrComp

`Chilkat 11.7.0 · autoit · CkString · StrComp · method`

```autoit
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.

### CkString.StripHtml

`Chilkat 11.7.0 · autoit · CkString · StripHtml · method`

```autoit
StripHtml()
```

Strips HTML tags from a string.

### CkString.ToCRLF

`Chilkat 11.7.0 · autoit · CkString · ToCRLF · method`

```autoit
ToCRLF()
```

Converts all line endings to CRLF.

### CkString.ToLF

`Chilkat 11.7.0 · autoit · CkString · ToLF · method`

```autoit
ToLF()
```

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

### CkString.Trim

`Chilkat 11.7.0 · autoit · CkString · Trim · method`

```autoit
Trim()
```

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

### CkString.Trim2

`Chilkat 11.7.0 · autoit · CkString · Trim2 · method`

```autoit
Trim2()
```

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

### CkString.TrimInside

`Chilkat 11.7.0 · autoit · CkString · TrimInside · method`

```autoit
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.

### CkString.Unpluralize

`Chilkat 11.7.0 · autoit · CkString · Unpluralize · method`

```autoit
Unpluralize()
```

Unpluralizes an English word.

