CkString Xbase++ Reference Documentation

CkString

Current Version: 11.6.0

The Chilkat string class.

Object Creation

LOCAL oCkString
oCkString := CreateObject("Chilkat.CkString")

// ... use oCkString ...

oCkString:destroy()

Xbase++ uses the Chilkat ActiveX through the automation object returned by CreateObject(); properties and methods are accessed with the send operator (oHttp:ConnectTimeout := 30, oHttp:Download(cUrl, cPath)), and :destroy() releases the object. Register the Chilkat ActiveX matching the bitness of your Xbase++ application. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as CreateObject("Chilkat.CkString.11") for Chilkat v11.*.*.

Boolean properties, arguments and return values are integers in the ActiveX: pass 1 or 0, and test a method's success with == 1. A method that fails to return an object returns NIL. Objects returned by methods (such as an HttpResponse or JsonObject) are automation objects too and should likewise be released with :destroy(). 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
oCkString:NumArabic // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
oCkString:NumAscii // Numeric (read-only)
Introduced in version 9.5.0.25

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

top
NumCentralEuro
oCkString:NumCentralEuro // Numeric (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
oCkString:NumChars // Numeric (read-only)

To be documented soon...

top
NumChinese
oCkString:NumChinese // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
oCkString:NumCyrillic // Numeric (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
oCkString:NumGreek // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
oCkString:NumHebrew // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
oCkString:NumJapanese // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
oCkString:NumKorean // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
oCkString:NumLatin // Numeric (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
oCkString:NumThai // Numeric (read-only)
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top
SizeAnsi
oCkString:SizeAnsi // Numeric (read-only)

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

top
SizeUtf8
oCkString:SizeUtf8 // Numeric (read-only)

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

top
Str
oCkString:Str // Character

The string value of this object.

top

Methods

AnsiCharAt
nResult := oCkString:AnsiCharAt(nIndex) // returns Numeric

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

top
Append
oCkString:Append(cStr)

The str is appended to end of this instance.

top
AppendDateRfc3339
oCkString:AppendDateRfc3339(dDt)

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

top
AppendDateRfc822
oCkString:AppendDateRfc822(dDateTime)

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

top
AppendEncoded
oCkString:AppendEncoded(cStr, cEncoding, cCharset)

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
nSuccess := oCkString:AppendToFile(cPath, cCharsetEncoding) // returns Numeric (1/0)

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
nSuccess := oCkString:BeginsWith(cStr) // returns Numeric (1/0)

Returns 1 if the string begins with str. Otherwise returns 0. This method is case sensitive.

top
ChopAfter
oCkString:ChopAfter(cFindStr)

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

top
ChopBefore
oCkString:ChopBefore(cFindStr)

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

top
Clear
oCkString:Clear()

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

top
Contains
nSuccess := oCkString:Contains(cSubstr) // returns Numeric (1/0)

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

top
EndsWith
nSuccess := oCkString:EndsWith(cSubstr) // returns Numeric (1/0)

Returns 1 if the string ends with substr (case-sensitive). Otherwise returns 0.

top
GetEncoded
cResult := oCkString:GetEncoded(cBinaryEncoding, cCharsetEncoding) // returns Character

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 NIL on failure

More Information and Examples
top
HtmlEntityDecode
oCkString:HtmlEntityDecode()

Decodes any HTML entities found in the string.

More Information and Examples
top
HtmlEntityEncode
oCkString:HtmlEntityEncode()

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

More Information and Examples
top
LastAnsiChar
nResult := oCkString:LastAnsiChar() // returns Numeric

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

top
Left
cResult := oCkString:Left(nNumChars) // returns Character

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

Returns NIL on failure

top
Length
nResult := oCkString:Length() // returns Numeric

Returns the length, in characters, of the string.

top
LoadFile
nSuccess := oCkString:LoadFile(cPath, cCharsetEncoding) // returns Numeric (1/0)

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
nSuccess := oCkString:Matches(cStrPattern, lCaseSensitive) // returns Numeric (1/0)

Returns 1 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
cResult := oCkString:Mid(nIndex, nNumChars) // returns Character

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 NIL on failure

top
ParseDateRfc3339
dResult := oCkString:ParseDateRfc3339() // returns Date

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

More Information and Examples
top
ParseDateRfc822
dResult := oCkString:ParseDateRfc822() // returns Date

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

More Information and Examples
top
Pluralize
oCkString:Pluralize()

Pluralizes an English word.

More Information and Examples
top
Prepend
oCkString:Prepend(cStr)

Prepends str to this instance.

top
PunyDecode
oCkString:PunyDecode()
Introduced in version 9.5.0.52

In-place decodes the string from punycode.

top
PunyEncode
oCkString:PunyEncode()
Introduced in version 9.5.0.52

In-place encodes the string to punycode.

top
RemoveAnsiChar
oCkString:RemoveAnsiChar(nCh)

Removes all occurrences of ch from the string.

top
ReplaceAll
oCkString:ReplaceAll(cFindStr, cReplaceStr)

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

top
ReplaceAnsiChar
oCkString:ReplaceAnsiChar(nFindCh, nReplaceCh)

Replaces all occurrences of findCh with replaceCh.

top
ReplaceFirst
oCkString:ReplaceFirst(cFindStr, cReplaceStr)

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

top
Right
cResult := oCkString:Right(nNumChars) // returns Character

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

Returns NIL on failure

top
SaveToFile
nSuccess := oCkString:SaveToFile(cPath, cCharsetEncoding) // returns Numeric (1/0)

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

More Information and Examples
top
Shorten
oCkString:Shorten(nNumChars)

Removes the final numChars from the string.

top
StrComp
nResult := oCkString:StrComp(cStr, lCaseSensitive) // returns Numeric

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
oCkString:StripHtml()

Strips HTML tags from a string.

More Information and Examples
top
ToCRLF
oCkString:ToCRLF()

Converts all line endings to CRLF.

top
ToLF
oCkString:ToLF()

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

top
Trim
oCkString:Trim()

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

top
Trim2
oCkString:Trim2()

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

top
TrimInside
oCkString: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
oCkString:Unpluralize()

Unpluralizes an English word.

More Information and Examples
top