CkString PowerBuilder Reference Documentation

CkString

Current Version: 11.6.0

The Chilkat string class.

Object Creation

oleobject loo_CkString
integer li_rc

loo_CkString = create oleobject
li_rc = loo_CkString.ConnectToNewObject("Chilkat.CkString")
if li_rc < 0 then
    destroy loo_CkString
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_CkString ...

destroy loo_CkString

PowerBuilder uses the Chilkat ActiveX through an oleobject: declare the variable, create it, connect it to the Chilkat class with ConnectToNewObject, and destroy it when finished. A negative return code from ConnectToNewObject means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an HttpResponse or JsonObject) are also oleobject variables and must likewise be destroyed. A method that fails to return an object returns null; test with IsNull(). In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always oleobject.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as ConnectToNewObject("Chilkat.CkString.11") for Chilkat v11.*.*.

Members typed blob exchange binary data as a Variant byte array. The PowerBuilder examples instead use the BinData-based alternatives (methods ending in Bd), which keep binary data inside Chilkat objects.

Properties

NumArabic
long NumArabic (read-only)
Introduced in version 9.5.0.25

The number of Arabic characters contained in this string.

top
NumAscii
long NumAscii (read-only)
Introduced in version 9.5.0.25

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

top
NumCentralEuro
long NumCentralEuro (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
long NumChars (read-only)

To be documented soon...

top
NumChinese
long NumChinese (read-only)
Introduced in version 9.5.0.25

The number of Chinese characters contained in this string.

top
NumCyrillic
long NumCyrillic (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
long NumGreek (read-only)
Introduced in version 9.5.0.25

The number of Greek characters contained in this string.

top
NumHebrew
long NumHebrew (read-only)
Introduced in version 9.5.0.25

The number of Hebrew characters contained in this string.

top
NumJapanese
long NumJapanese (read-only)
Introduced in version 9.5.0.25

The number of Japanese characters contained in this string.

top
NumKorean
long NumKorean (read-only)
Introduced in version 9.5.0.25

The number of Korean characters contained in this string.

top
NumLatin
long NumLatin (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
long NumThai (read-only)
Introduced in version 9.5.0.25

The number of Thai characters contained in this string.

top
SizeAnsi
long SizeAnsi (read-only)

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

top
SizeUtf8
long SizeUtf8 (read-only)

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

top
Str
string Str

The string value of this object.

top

Methods

AnsiCharAt
long AnsiCharAt(long index)

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

top
Append
Append(string str)

The str is appended to end of this instance.

top
AppendDateRfc3339
AppendDateRfc3339(datetime dt)

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

top
AppendDateRfc822
AppendDateRfc822(datetime dateTime)

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

top
AppendEncoded
AppendEncoded(string str, string encoding, string charset)

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
AppendMultibyte
AppendMultibyte(blob mbtext, string charsetEncoding)

Appends characters from a byte array. mbtext contains the character data. The input bytes are interpreted according to the character encoding specified by charsetEncoding.

More Information and Examples
top
AppendToFile
long AppendToFile(string path, string charsetEncoding)

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
long BeginsWith(string str)

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

top
ChopAfter
ChopAfter(string findStr)

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

top
ChopBefore
ChopBefore(string findStr)

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
long Contains(string substr)

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

top
EmitMultibyte
blob EmitMultibyte(string charsetEncoding)

Converts the string to a byte array using the character encoding specified by charsetEncoding.

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

top
EndsWith
long EndsWith(string substr)

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

top
GetEncoded
string GetEncoded(string binaryEncoding, string charsetEncoding)

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
long LastAnsiChar()

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

top
Left
string Left(long numChars)

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

Returns null on failure

top
Length
long Length()

Returns the length, in characters, of the string.

top
LoadFile
long LoadFile(string path, string charsetEncoding)

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
LoadXmlDoc
LoadXmlDoc(blob xmlDocumentBytes)

Loads an XML document into the CkString. The xmlDocumentBytes contains the raw bytes of the XML document. The reason for providing a separate method for loading an XML document is because the charset encoding is usually specified using a charset attribute at the beginning of the XML document. The LoadXmlDoc method reads just enough of the XML document to get the charset, and then it knows how to read and interpret the bytes of the entire XML document, so that the bytes of the characters are properly interpeted and loaded into the CkString object.

top
Matches
long Matches(string strPattern, long caseSensitive)

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
string Mid(long index, long numChars)

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
datetime ParseDateRfc3339()

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

More Information and Examples
top
ParseDateRfc822
datetime ParseDateRfc822()

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(string str)

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(long ch)

Removes all occurrences of ch from the string.

top
ReplaceAll
ReplaceAll(string findStr, string replaceStr)

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

top
ReplaceAnsiChar
ReplaceAnsiChar(long findCh, long replaceCh)

Replaces all occurrences of findCh with replaceCh.

top
ReplaceFirst
ReplaceFirst(string findStr, string replaceStr)

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

top
Right
string Right(long numChars)

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

Returns null on failure

top
SaveToFile
long SaveToFile(string path, string charsetEncoding)

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
Shorten(long numChars)

Removes the final numChars from the string.

top
StrComp
long StrComp(string str, long caseSensitive)

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