StringTable Delphi DLL Reference Documentation

StringTable

Current Version: 10.1.2

A memory efficient class for holding a large number of strings (accessible by index). The primary use is as a read-only table of strings that is built once and then used by the application.

This class is introduced in Chilkat v9.5.0.62.

Create/Dispose

var
myObject: HCkStringTable;

begin
myObject := CkStringTable_Create();

// ...

CkStringTable_Dispose(myObject);
end;

function CkStringTable_Create: HCkStringTable; stdcall;

Creates an instance of the HCkStringTable 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 CkStringTable_Dispose(handle: HCkStringTable); stdcall;

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

Properties

Count

function CkStringTable_getCount(objHandle: HCkStringTable): Integer; stdcall;

Introduced in version 9.5.0.62

The number of strings in the table.

DebugLogFilePath

procedure CkStringTable_getDebugLogFilePath(objHandle: HCkStringTable; outPropVal: HCkString); stdcall;
procedure CkStringTable_putDebugLogFilePath(objHandle: HCkStringTable; newPropVal: PWideChar); stdcall;
function CkStringTable__debugLogFilePath(objHandle: HCkStringTable): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkStringTable_getLastErrorHtml(objHandle: HCkStringTable; outPropVal: HCkString); stdcall;
function CkStringTable__lastErrorHtml(objHandle: HCkStringTable): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkStringTable_getLastErrorText(objHandle: HCkStringTable; outPropVal: HCkString); stdcall;
function CkStringTable__lastErrorText(objHandle: HCkStringTable): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkStringTable_getLastErrorXml(objHandle: HCkStringTable; outPropVal: HCkString); stdcall;
function CkStringTable__lastErrorXml(objHandle: HCkStringTable): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkStringTable_getLastMethodSuccess(objHandle: HCkStringTable): wordbool; stdcall;
procedure CkStringTable_putLastMethodSuccess(objHandle: HCkStringTable; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

VerboseLogging

function CkStringTable_getVerboseLogging(objHandle: HCkStringTable): wordbool; stdcall;
procedure CkStringTable_putVerboseLogging(objHandle: HCkStringTable; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

procedure CkStringTable_getVersion(objHandle: HCkStringTable; outPropVal: HCkString); stdcall;
function CkStringTable__version(objHandle: HCkStringTable): PWideChar; stdcall;

Version of the component/library, such as "10.1.0"

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Append

function CkStringTable_Append(objHandle: HCkStringTable;
value: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.62

Appends a string to the table.

Returns True for success, False for failure.

AppendFromFile

function CkStringTable_AppendFromFile(objHandle: HCkStringTable;
    maxLineLen: Integer;
    charset: PWideChar;
    path: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.62

Appends strings, one per line, from a file. Each line in the path should be no longer than the length specified in maxLineLen. The charset indicates the character encoding of the contents of the file, such as "utf-8", "iso-8859-1", "Shift_JIS", etc.

Returns True for success, False for failure.

AppendFromSb

function CkStringTable_AppendFromSb(objHandle: HCkStringTable;
sb: HCkStringBuilder): wordbool; stdcall;

Introduced in version 9.5.0.62

Appends strings, one per line, from the contents of a StringBuilder object.

Returns True for success, False for failure.

More Information and Examples

Load StringTable from a StringBuilder

Clear

procedure CkStringTable_Clear(objHandle: HCkStringTable) stdcall;

Introduced in version 9.5.0.62

Removes all the strings from the table.

FindSubstring

function CkStringTable_FindSubstring(objHandle: HCkStringTable;
    startIndex: Integer;
    substr: PWideChar;
    caseSensitive: wordbool): Integer; stdcall;

Introduced in version 9.5.0.77

Return the index of the first string in the table containing substr. Begins searching strings starting at startIndex. If caseSensitive is True, then the search is case sensitive. If caseSensitive is False then the search is case insensitive. Returns -1 if the substr is not found.

GetStrings

function CkStringTable_GetStrings(objHandle: HCkStringTable;
    startIdx: Integer;
    count: Integer;
    crlf: wordbool;
    outStr: HCkString): wordbool; stdcall;
function CkStringTable__getStrings(objHandle: HCkStringTable;
    startIdx: Integer;
    count: Integer;
    crlf: wordbool): PWideChar; stdcall;

Introduced in version 9.5.0.87

Return the number of strings specified by count, one per line, starting at startIdx. To return the entire table, pass 0 values for both startIdx and count. Set crlf equal to True to emit with CRLF line endings, or False to emit LF-only line endings. The last string is emitted includes the line ending.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

IntAt

function CkStringTable_IntAt(objHandle: HCkStringTable;
index: Integer): Integer; stdcall;

Introduced in version 9.5.0.63

Returns the Nth string in the table, converted to an integer value. The index is 0-based. (The first string is at index 0.) Returns -1 if no string is found at the specified index. Returns 0 if the string at the specified index exist, but is not an integer.

SaveToFile

function CkStringTable_SaveToFile(objHandle: HCkStringTable;
    charset: PWideChar;
    bCrlf: wordbool;
    path: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.62

Saves the string table to a file. The charset is the character encoding to use, such as "utf-8", "iso-8859-1", "windows-1252", "Shift_JIS", "gb2312", etc. If bCrlf is True, then CRLF line endings are used, otherwise LF-only line endings are used.

Returns True for success, False for failure.

Sort

function CkStringTable_Sort(objHandle: HCkStringTable;
ascending: wordbool;
caseSensitive: wordbool): wordbool; stdcall;

Introduced in version 9.5.0.87

Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to True, otherwise set ascending equal to False.

Returns True for success, False for failure.

SplitAndAppend

function CkStringTable_SplitAndAppend(objHandle: HCkStringTable;
    inStr: PWideChar;
    delimiterChar: PWideChar;
    exceptDoubleQuoted: wordbool;
    exceptEscaped: wordbool): wordbool; stdcall;

Introduced in version 9.5.0.62

Splits a string into parts based on a single character delimiterChar. 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

StringTable SplitAndAppend Example

StringAt

function CkStringTable_StringAt(objHandle: HCkStringTable;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkStringTable__stringAt(objHandle: HCkStringTable;
    index: Integer): PWideChar; stdcall;

Introduced in version 9.5.0.62

Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.