StringBuilder Tcl Reference Documentation

StringBuilder

Current Version: 9.5.0.73

A simple class for building strings. (Represents a mutable string of characters.)

Note: This class was introduced in Chilkat v9.5.0.58.

Object Creation

set myStringBuilder [new CkStringBuilder]

Properties

IntValue
integer
set intVal [CkStringBuilder_get_IntValue $myStringBuilder]
CkStringBuilder_put_IntValue $myStringBuilder $intVal
Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

top
LastMethodSuccess
boolean 1/0
set boolVal [CkStringBuilder_get_LastMethodSuccess $myStringBuilder]
CkStringBuilder_put_LastMethodSuccess $myStringBuilder $boolVal

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Length
integer
set intVal [CkStringBuilder_get_Length $myStringBuilder]
Introduced in version 9.5.0.58

The number of characters of the string contained within this instance.

top
Utf8
boolean 1/0
set boolVal [CkStringBuilder_get_Utf8 $myStringBuilder]
CkStringBuilder_put_Utf8 $myStringBuilder $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top

Methods

Append
# value is a string
set status [CkStringBuilder_Append $value]
Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns 1 for success, 0 for failure.

top
AppendBd
# binData is a CkBinData
# charset is a string
# offset is an integer
# numBytes is an integer
set status [CkStringBuilder_AppendBd $binData $charset $offset $numBytes]
Introduced in version 9.5.0.64

Appends the contents of binData. The charset specifies the character encoding of the bytes contained in binData. The charset can be any of the supported encodings listed at Chilkat Supported Character Encodings. To append the entire contents of binData, set offset and numBytes equal to zero. To append a range of binData, set the offset and numBytes to specify the range.

Returns 1 for success, 0 for failure.

top
AppendEncoded
# binaryData is a CkByteData
# encoding is a string
set status [CkStringBuilder_AppendEncoded $binaryData $encoding]
Introduced in version 9.5.0.58

Appends binary data using the encoding specified by encoding, such as "base64", "hex", etc.

Returns 1 for success, 0 for failure.

top
AppendInt
# value is an integer
set status [CkStringBuilder_AppendInt $value]
Introduced in version 9.5.0.58

Appends the string representation of a specified 32-bit signed integer to this instance.

Returns 1 for success, 0 for failure.

top
AppendInt64
# value is a 64-bit integer
set status [CkStringBuilder_AppendInt64 $value]
Introduced in version 9.5.0.58

Appends the string representation of a specified 64-bit signed integer to this instance.

Returns 1 for success, 0 for failure.

top
AppendLine
# value is a string
# crlf is a boolean
set status [CkStringBuilder_AppendLine $value $crlf]
Introduced in version 9.5.0.65

Appends the value followed by a CRLF or LF to the end of the curent StringBuilder object. If crlf is 1, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns 1 for success, 0 for failure.

top
AppendSb
# sb is a CkStringBuilder
set status [CkStringBuilder_AppendSb $sb]
Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns 1 for success, 0 for failure.

top
Clear
CkStringBuilder_Clear
Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

top
Contains
# str is a string
# caseSensitive is a boolean
set retBool [CkStringBuilder_Contains $str $caseSensitive]
Introduced in version 9.5.0.58

Returns 1 if the str is contained within this object. For case sensitive matching, set caseSensitive equal to 1. For case-insensitive, set caseSensitive equal to 0.

top
ContainsWord
# word is a string
# caseSensitive is a boolean
set retBool [CkStringBuilder_ContainsWord $word $caseSensitive]
Introduced in version 9.5.0.69

Returns 1 if the word is contained within this object, but only if it is a whole word. This method is limited to finding whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

For case sensitive matching, set caseSensitive equal to 1. For case-insensitive, set caseSensitive equal to 0.

top
ContentsEqual
# str is a string
# caseSensitive is a boolean
set retBool [CkStringBuilder_ContentsEqual $str $caseSensitive]
Introduced in version 9.5.0.62

Returns 1 if the contents of this object equals the str. Returns 0 if unequal. For case insensitive equality, set caseSensitive equal to 0.

top
ContentsEqualSb
# sb is a CkStringBuilder
# caseSensitive is a boolean
set retBool [CkStringBuilder_ContentsEqualSb $sb $caseSensitive]
Introduced in version 9.5.0.62

Returns 1 if the contents of this object equals the sb. Returns 0 if unequal. For case insensitive equality, set caseSensitive equal to 0.

top
Decode
# encoding is a string
# charset is a string
set status [CkStringBuilder_Decode $encoding $charset]
Introduced in version 9.5.0.62

Decodes and replaces the contents with the decoded string. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: This method can only be called if the encoded content decodes to a string. The charset indicates the charset to be used in intepreting the decoded bytes. For example, the charset can be "utf-8", "utf-16", "iso-8859-1", "shift_JIS", etc.

Returns 1 for success, 0 for failure.

More Information and Examples
top
Encode
# encoding is a string
# charset is a string
set status [CkStringBuilder_Encode $encoding $charset]
Introduced in version 9.5.0.62

Encodes to base64, hex, quoted-printable, URL encoding, etc. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns 1 for success, 0 for failure.

top
EndsWith
# substr is a string
# caseSensitive is a boolean
set retBool [CkStringBuilder_EndsWith $substr $caseSensitive]
Introduced in version 9.5.0.62

Returns 1 if the string ends with substr. Otherwise returns 0. The comparison is case sensitive if caseSensitive is 1, and case insensitive if caseSensitive is 0.

top
EntityDecode
set status [CkStringBuilder_EntityDecode]
Introduced in version 9.5.0.62

Decodes HTML entities. See HTML entities for more information about HTML entities.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetAfterBetween
# searchAfter is a string
# beginMark is a string
# endMark is a string
# outStr is a CkString (output)
set status [CkStringBuilder_GetAfterBetween $searchAfter $beginMark $endMark $outStr]
set retStr [CkStringBuilder_getAfterBetween $myStringBuilder $searchAfter $beginMark $endMark]
Introduced in version 9.5.0.62

Begin searching after the 1st occurrence of searchAfter is found, and then return the substring found between the next occurrence of beginMark and the next occurrence of endMark.

Returns 1 for success, 0 for failure.

top
GetAsString
# outStr is a CkString (output)
set status [CkStringBuilder_GetAsString $outStr]
set retStr [CkStringBuilder_getAsString $myStringBuilder]
Introduced in version 9.5.0.58

Returns the contents as a string.

Returns 1 for success, 0 for failure.

top
GetBetween
# beginMark is a string
# endMark is a string
# outStr is a CkString (output)
set status [CkStringBuilder_GetBetween $beginMark $endMark $outStr]
set retStr [CkStringBuilder_getBetween $myStringBuilder $beginMark $endMark]
Introduced in version 9.5.0.62

Returns the substring found between the 1st occurrence of beginMark and the next occurrence of endMark.

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetDecoded
# encoding is a string
# outBytes is a CkByteData (output)
set status [CkStringBuilder_GetDecoded $encoding $outData]
Introduced in version 9.5.0.62

Decodes and returns the decoded bytes. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Returns 1 for success, 0 for failure.

top
GetEncoded
# encoding is a string
# charset is a string
# outStr is a CkString (output)
set status [CkStringBuilder_GetEncoded $encoding $charset $outStr]
set retStr [CkStringBuilder_getEncoded $myStringBuilder $encoding $charset]
Introduced in version 9.5.0.62

Returns the string contents encoded in an encoding such as base64, hex, quoted-printable, or URL-encoding. The encoding can be set to any of the following strings: "base64", "hex", "quoted-printable" (or "qp"), "url", "base32", "Q", "B", "url_rc1738", "url_rfc2396", "url_rfc3986", "url_oauth", "uu", "modBase64", or "html" (for HTML entity encoding). The full up-to-date list of supported binary encodings is available at the link entitled "Supported Binary Encodings" below.

Note: The Encode method modifies the content of this object. The GetEncoded method leaves this object's content unmodified.

Returns 1 for success, 0 for failure.

top
GetNth
# index is an integer
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
# outStr is a CkString (output)
set status [CkStringBuilder_GetNth $index $delimiterChar $exceptDoubleQuoted $exceptEscaped $outStr]
set retStr [CkStringBuilder_getNth $myStringBuilder $index $delimiterChar $exceptDoubleQuoted $exceptEscaped]
Introduced in version 9.5.0.62

Returns the Nth substring in string that is a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is 1, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is 1, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LastNLines
# numLines is an integer
# bCrlf is a boolean
# outStr is a CkString (output)
set status [CkStringBuilder_LastNLines $numLines $bCrlf $outStr]
set retStr [CkStringBuilder_lastNLines $myStringBuilder $numLines $bCrlf]
Introduced in version 9.5.0.62

Returns the last N lines of the text. If fewer than numLines lines exists, then all of the text is returned. If bCrlf is 1, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadFile
# path is a string
# charset is a string
set status [CkStringBuilder_LoadFile $path $charset]
Introduced in version 9.5.0.62

Loads the contents of a file.

Returns 1 for success, 0 for failure.

More Information and Examples
top
Prepend
# value is a string
set status [CkStringBuilder_Prepend $value]
Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns 1 for success, 0 for failure.

top
PunyDecode
set status [CkStringBuilder_PunyDecode]
Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns 1 for success, 0 for failure.

top
PunyEncode
set status [CkStringBuilder_PunyEncode]
Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns 1 for success, 0 for failure.

top
Replace
# value is a string
# replacement is a string
set retInt [CkStringBuilder_Replace $value $replacement]
Introduced in version 9.5.0.58

Replaces all occurrences of a specified string in this instance with another specified string. Returns the number of replacements.

top
ReplaceAfterFinal
# marker is a string
# replacement is a string
set status [CkStringBuilder_ReplaceAfterFinal $marker $replacement]
Introduced in version 9.5.0.73

Replaces the content found after the final occurrence of marker with replacement.

Returns 1 for success, 0 for failure.

top
ReplaceAllBetween
# beginMark is a string
# endMark is a string
# replacement is a string
# replaceMarks is a boolean
set status [CkStringBuilder_ReplaceAllBetween $beginMark $endMark $replacement $replaceMarks]
Introduced in version 9.5.0.64

Replaces the first occurrence of ALL the content found between beginMark and endMark with replacement. The beginMark and endMark are included in what is replaced if replaceMarks is 1.

Returns 1 for success, 0 for failure.

top
ReplaceBetween
# beginMark is a string
# endMark is a string
# value is a string
# replacement is a string
set retInt [CkStringBuilder_ReplaceBetween $beginMark $endMark $value $replacement]
Introduced in version 9.5.0.62

Replaces all occurrences of value with replacement, but only where value is found between beginMark and endMark. Returns the number of replacements made.

More Information and Examples
top
ReplaceI
# value is a string
# replacement is an integer
set retInt [CkStringBuilder_ReplaceI $value $replacement]
Introduced in version 9.5.0.67

Replaces all occurrences of value with the decimal integer replacement. Returns the number of replacements.

top
ReplaceWord
# value is a string
# replacement is a string
set retInt [CkStringBuilder_ReplaceWord $value $replacement]
Introduced in version 9.5.0.62

Replaces all word occurrences of a specified string in this instance with another specified string. Returns the number of replacements made.

Important: This method is limited to replacing whole words in strings that only contains characters in the Latin1 charset (i.e. iso-8859-1 or Windows-1252). A whole word can only contain alphanumeric chars where the alpha chars are restricted to those of the Latin1 alpha chars. (The underscore character is also considered part of a word.)

More Information and Examples
top
SecureClear
CkStringBuilder_SecureClear
Introduced in version 9.5.0.67

Removes all characters from the current StringBuilder instance, and write zero bytes to the allocated memory before deallocating.

top
SetNth
# index is an integer
# value is a string
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
set status [CkStringBuilder_SetNth $index $value $delimiterChar $exceptDoubleQuoted $exceptEscaped]
Introduced in version 9.5.0.62

Sets the Nth substring in string in a list delimted by delimiterChar. The first substring is at index 0. If exceptDoubleQuoted is 1, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is 1, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns 1 for success, 0 for failure.

More Information and Examples
top
SetString
# value is a string
set status [CkStringBuilder_SetString $value]
Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns 1 for success, 0 for failure.

top
StartsWith
# substr is a string
# caseSensitive is a boolean
set retBool [CkStringBuilder_StartsWith $substr $caseSensitive]
Introduced in version 9.5.0.62

Returns 1 if the string starts with substr. Otherwise returns 0. The comparison is case sensitive if caseSensitive is 1, and case insensitive if caseSensitive is 0.

top
ToCRLF
set status [CkStringBuilder_ToCRLF]
Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns 1 for success, 0 for failure.

top
ToLF
set status [CkStringBuilder_ToLF]
Introduced in version 9.5.0.62

Converts line endings to LF-only (UNIX) format.

Returns 1 for success, 0 for failure.

top
ToLowercase
set status [CkStringBuilder_ToLowercase]
Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns 1 for success, 0 for failure.

top
ToUppercase
set status [CkStringBuilder_ToUppercase]
Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns 1 for success, 0 for failure.

top
Trim
set status [CkStringBuilder_Trim]
Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns 1 for success, 0 for failure.

top
TrimInsideSpaces
set status [CkStringBuilder_TrimInsideSpaces]
Introduced in version 9.5.0.62

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

Returns 1 for success, 0 for failure.

top
WriteFile
# path is a string
# charset is a string
# emitBom is a boolean
set status [CkStringBuilder_WriteFile $path $charset $emitBom]
Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is 1, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns 1 for success, 0 for failure.

top
WriteFileIfModified
# path is a string
# charset is a string
# emitBom is a boolean
set status [CkStringBuilder_WriteFileIfModified $path $charset $emitBom]
Introduced in version 9.5.0.73

Writes the contents to a file, but only if it is a new file or if the contents are different than the existing file. If emitBom is 1, then the BOM (also known as a preamble), is emitted for charsets that define a BOM (such as utf-8, utf-16, utf-32, etc.)

Returns 1 for success, 0 for failure.

top