StringBuilder Delphi DLL 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.

Create/Dispose

var
myObject: HCkStringBuilder;

begin
myObject := CkStringBuilder_Create();

// ...

CkStringBuilder_Dispose(myObject);
end;
function CkStringBuilder_Create: HCkStringBuilder; stdcall;

Creates an instance of the HCkStringBuilder object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkStringBuilder_Dispose(handle: HCkStringBuilder); stdcall;

Objects created by calling CkStringBuilder_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

IntValue
function CkStringBuilder_getIntValue(objHandle: HCkStringBuilder): Integer; stdcall;
procedure CkStringBuilder_putIntValue(objHandle: HCkStringBuilder; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.58

Returns the content of the string converted to an integer.

top
LastMethodSuccess
function CkStringBuilder_getLastMethodSuccess(objHandle: HCkStringBuilder): wordbool; stdcall;
procedure CkStringBuilder_putLastMethodSuccess(objHandle: HCkStringBuilder; newPropVal: wordbool); stdcall;

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Length
function CkStringBuilder_getLength(objHandle: HCkStringBuilder): Integer; stdcall;
Introduced in version 9.5.0.58

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

top

Methods

Append
function CkStringBuilder_Append(objHandle: HCkStringBuilder;
    value: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.58

Appends a copy of the specified string to this instance.

Returns True for success, False for failure.

top
AppendBd
function CkStringBuilder_AppendBd(objHandle: HCkStringBuilder;
    binData: HCkBinData;
    charset: PWideChar;
    offset: Integer;
    numBytes: Integer): wordbool; stdcall;
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 True for success, False for failure.

top
AppendEncoded
function CkStringBuilder_AppendEncoded(objHandle: HCkStringBuilder;
    binaryData: HCkByteData;
    encoding: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.58

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

Returns True for success, False for failure.

top
AppendInt
function CkStringBuilder_AppendInt(objHandle: HCkStringBuilder;
    value: Integer): wordbool; stdcall;
Introduced in version 9.5.0.58

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

Returns True for success, False for failure.

top
AppendInt64
function CkStringBuilder_AppendInt64(objHandle: HCkStringBuilder;
    value: Int64): wordbool; stdcall;
Introduced in version 9.5.0.58

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

Returns True for success, False for failure.

top
AppendLine
function CkStringBuilder_AppendLine(objHandle: HCkStringBuilder;
    value: PWideChar;
    crlf: wordbool): wordbool; stdcall;
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 True, then a CRLF line ending is used. Otherwise a LF line ending is used.

Returns True for success, False for failure.

top
AppendSb
function CkStringBuilder_AppendSb(objHandle: HCkStringBuilder;
    sb: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

Appends the contents of another StringBuilder to this instance.

Returns True for success, False for failure.

top
Clear
procedure CkStringBuilder_Clear(objHandle: HCkStringBuilder) stdcall;
Introduced in version 9.5.0.58

Removes all characters from the current StringBuilder instance.

top
Contains
function CkStringBuilder_Contains(objHandle: HCkStringBuilder;
    str: PWideChar;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.58

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

top
ContainsWord
function CkStringBuilder_ContainsWord(objHandle: HCkStringBuilder;
    word: PWideChar;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.69

Returns True 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 True. For case-insensitive, set caseSensitive equal to False.

top
ContentsEqual
function CkStringBuilder_ContentsEqual(objHandle: HCkStringBuilder;
    str: PWideChar;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.62

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

top
ContentsEqualSb
function CkStringBuilder_ContentsEqualSb(objHandle: HCkStringBuilder;
    sb: HCkStringBuilder;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.62

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

top
Decode
function CkStringBuilder_Decode(objHandle: HCkStringBuilder;
    encoding: PWideChar;
    charset: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

More Information and Examples
top
Encode
function CkStringBuilder_Encode(objHandle: HCkStringBuilder;
    encoding: PWideChar;
    charset: PWideChar): wordbool; stdcall;
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 True for success, False for failure.

top
EndsWith
function CkStringBuilder_EndsWith(objHandle: HCkStringBuilder;
    substr: PWideChar;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.62

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

top
EntityDecode
function CkStringBuilder_EntityDecode(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

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

Returns True for success, False for failure.

More Information and Examples
top
GetAfterBetween
function CkStringBuilder_GetAfterBetween(objHandle: HCkStringBuilder;
    searchAfter: PWideChar;
    beginMark: PWideChar;
    endMark: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__getAfterBetween(objHandle: HCkStringBuilder;
    searchAfter: PWideChar;
    beginMark: PWideChar;
    endMark: PWideChar): PWideChar; stdcall;
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 True for success, False for failure.

top
GetAsString
function CkStringBuilder_GetAsString(objHandle: HCkStringBuilder;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__getAsString(objHandle: HCkStringBuilder): PWideChar; stdcall;
Introduced in version 9.5.0.58

Returns the contents as a string.

Returns True for success, False for failure.

top
GetBetween
function CkStringBuilder_GetBetween(objHandle: HCkStringBuilder;
    beginMark: PWideChar;
    endMark: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__getBetween(objHandle: HCkStringBuilder;
    beginMark: PWideChar;
    endMark: PWideChar): PWideChar; stdcall;
Introduced in version 9.5.0.62

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

Returns True for success, False for failure.

More Information and Examples
top
GetDecoded
function CkStringBuilder_GetDecoded(objHandle: HCkStringBuilder;
    encoding: PWideChar;
    outBytes: HCkByteData): wordbool; stdcall;
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 True for success, False for failure.

top
GetEncoded
function CkStringBuilder_GetEncoded(objHandle: HCkStringBuilder;
    encoding: PWideChar;
    charset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__getEncoded(objHandle: HCkStringBuilder;
    encoding: PWideChar;
    charset: PWideChar): PWideChar; stdcall;
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 True for success, False for failure.

top
GetNth
function CkStringBuilder_GetNth(objHandle: HCkStringBuilder;
    index: Integer;
    delimiterChar: PWideChar;
    exceptDoubleQuoted: wordbool;
    exceptEscaped: wordbool;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__getNth(objHandle: HCkStringBuilder;
    index: Integer;
    delimiterChar: PWideChar;
    exceptDoubleQuoted: wordbool;
    exceptEscaped: wordbool): PWideChar; stdcall;
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 True, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is True, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns True for success, False for failure.

More Information and Examples
top
LastNLines
function CkStringBuilder_LastNLines(objHandle: HCkStringBuilder;
    numLines: Integer;
    bCrlf: wordbool;
    outStr: HCkString): wordbool; stdcall;
function CkStringBuilder__lastNLines(objHandle: HCkStringBuilder;
    numLines: Integer;
    bCrlf: wordbool): PWideChar; stdcall;
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 True, then the line endings of the returned string are converted to CRLF, otherwise the line endings are converted to LF-only.

Returns True for success, False for failure.

More Information and Examples
top
LoadFile
function CkStringBuilder_LoadFile(objHandle: HCkStringBuilder;
    path: PWideChar;
    charset: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.62

Loads the contents of a file.

Returns True for success, False for failure.

More Information and Examples
top
Prepend
function CkStringBuilder_Prepend(objHandle: HCkStringBuilder;
    value: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.61

Prepends a copy of the specified string to this instance.

Returns True for success, False for failure.

top
PunyDecode
function CkStringBuilder_PunyDecode(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.71

In-place decodes the string from punycode.

Returns True for success, False for failure.

top
PunyEncode
function CkStringBuilder_PunyEncode(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.71

In-place encodes the string to punycode.

Returns True for success, False for failure.

top
Replace
function CkStringBuilder_Replace(objHandle: HCkStringBuilder;
    value: PWideChar;
    replacement: PWideChar): Integer; stdcall;
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
function CkStringBuilder_ReplaceAfterFinal(objHandle: HCkStringBuilder;
    marker: PWideChar;
    replacement: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.73

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

Returns True for success, False for failure.

top
ReplaceAllBetween
function CkStringBuilder_ReplaceAllBetween(objHandle: HCkStringBuilder;
    beginMark: PWideChar;
    endMark: PWideChar;
    replacement: PWideChar;
    replaceMarks: wordbool): wordbool; stdcall;
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 True.

Returns True for success, False for failure.

top
ReplaceBetween
function CkStringBuilder_ReplaceBetween(objHandle: HCkStringBuilder;
    beginMark: PWideChar;
    endMark: PWideChar;
    value: PWideChar;
    replacement: PWideChar): Integer; stdcall;
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
function CkStringBuilder_ReplaceI(objHandle: HCkStringBuilder;
    value: PWideChar;
    replacement: Integer): Integer; stdcall;
Introduced in version 9.5.0.67

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

top
ReplaceWord
function CkStringBuilder_ReplaceWord(objHandle: HCkStringBuilder;
    value: PWideChar;
    replacement: PWideChar): Integer; stdcall;
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
procedure CkStringBuilder_SecureClear(objHandle: HCkStringBuilder) stdcall;
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
function CkStringBuilder_SetNth(objHandle: HCkStringBuilder;
    index: Integer;
    value: PWideChar;
    delimiterChar: PWideChar;
    exceptDoubleQuoted: wordbool;
    exceptEscaped: wordbool): wordbool; stdcall;
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 True, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is True, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns True for success, False for failure.

More Information and Examples
top
SetString
function CkStringBuilder_SetString(objHandle: HCkStringBuilder;
    value: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.61

Sets this instance to a copy of the specified string.

Returns True for success, False for failure.

top
StartsWith
function CkStringBuilder_StartsWith(objHandle: HCkStringBuilder;
    substr: PWideChar;
    caseSensitive: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.62

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

top
ToCRLF
function CkStringBuilder_ToCRLF(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

Converts line endings to CRLF (Windows) format.

Returns True for success, False for failure.

top
ToLF
function CkStringBuilder_ToLF(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

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

Returns True for success, False for failure.

top
ToLowercase
function CkStringBuilder_ToLowercase(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

Converts the contents to lowercase.

Returns True for success, False for failure.

top
ToUppercase
function CkStringBuilder_ToUppercase(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

Converts the contents to uppercase.

Returns True for success, False for failure.

top
Trim
function CkStringBuilder_Trim(objHandle: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.62

Trims whitespace from both ends of the string.

Returns True for success, False for failure.

top
TrimInsideSpaces
function CkStringBuilder_TrimInsideSpaces(objHandle: HCkStringBuilder): wordbool; stdcall;
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 True for success, False for failure.

top
WriteFile
function CkStringBuilder_WriteFile(objHandle: HCkStringBuilder;
    path: PWideChar;
    charset: PWideChar;
    emitBom: wordbool): wordbool; stdcall;
Introduced in version 9.5.0.62

Writes the contents to a file. If emitBom is True, 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 True for success, False for failure.

top
WriteFileIfModified
function CkStringBuilder_WriteFileIfModified(objHandle: HCkStringBuilder;
    path: PWideChar;
    charset: PWideChar;
    emitBom: wordbool): wordbool; stdcall;
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 True, 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 True for success, False for failure.

top