StringArray Delphi DLL Reference Documentation

StringArray

Current Version: 10.1.2

Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.

Important: The Chilkat StringTable class is a better choice for a large number of strings.

Create/Dispose

var
myObject: HCkStringArray;

begin
myObject := CkStringArray_Create();

// ...

CkStringArray_Dispose(myObject);
end;

function CkStringArray_Create: HCkStringArray; stdcall;

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

Objects created by calling CkStringArray_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 CkStringArray_getCount(objHandle: HCkStringArray): Integer; stdcall;

The number of strings contained within the object's internal array (i.e. ordered collection).

Important: This is an object that contains a collection of strings. Although the class/object name includes the word "Array", it should not be confused with an array in the sense of the primitive array type used in a given programming language.

Crlf

function CkStringArray_getCrlf(objHandle: HCkStringArray): wordbool; stdcall;
procedure CkStringArray_putCrlf(objHandle: HCkStringArray; newPropVal: wordbool); stdcall;

If True, strings are always automatically converted to use CRLF line endings. If False, strings are automatically converted to use bare LF line endings.

DebugLogFilePath

procedure CkStringArray_getDebugLogFilePath(objHandle: HCkStringArray; outPropVal: HCkString); stdcall;
procedure CkStringArray_putDebugLogFilePath(objHandle: HCkStringArray; newPropVal: PWideChar); stdcall;
function CkStringArray__debugLogFilePath(objHandle: HCkStringArray): 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 CkStringArray_getLastErrorHtml(objHandle: HCkStringArray; outPropVal: HCkString); stdcall;
function CkStringArray__lastErrorHtml(objHandle: HCkStringArray): 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 CkStringArray_getLastErrorText(objHandle: HCkStringArray; outPropVal: HCkString); stdcall;
function CkStringArray__lastErrorText(objHandle: HCkStringArray): 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 CkStringArray_getLastErrorXml(objHandle: HCkStringArray; outPropVal: HCkString); stdcall;
function CkStringArray__lastErrorXml(objHandle: HCkStringArray): 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 CkStringArray_getLastMethodSuccess(objHandle: HCkStringArray): wordbool; stdcall;
procedure CkStringArray_putLastMethodSuccess(objHandle: HCkStringArray; 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.

Length

function CkStringArray_getLength(objHandle: HCkStringArray): Integer; stdcall;

The number of strings contained within the internal collection. (Identical to the Count property.)

Trim

function CkStringArray_getTrim(objHandle: HCkStringArray): wordbool; stdcall;
procedure CkStringArray_putTrim(objHandle: HCkStringArray; newPropVal: wordbool); stdcall;

If True, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.

Unique

function CkStringArray_getUnique(objHandle: HCkStringArray): wordbool; stdcall;
procedure CkStringArray_putUnique(objHandle: HCkStringArray; newPropVal: wordbool); stdcall;

If True, then duplicates are not allowed. When an attempt is made to insert a string that already exists, the duplicate insertion is silently suppressed and no error is returned. The default value is False.

VerboseLogging

function CkStringArray_getVerboseLogging(objHandle: HCkStringArray): wordbool; stdcall;
procedure CkStringArray_putVerboseLogging(objHandle: HCkStringArray; 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 CkStringArray_getVersion(objHandle: HCkStringArray; outPropVal: HCkString); stdcall;
function CkStringArray__version(objHandle: HCkStringArray): 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 CkStringArray_Append(objHandle: HCkStringArray;
str: PWideChar): wordbool; stdcall;

Appends a string to the end of the internal ordered collection.

Returns True for success, False for failure.

AppendSerialized

function CkStringArray_AppendSerialized(objHandle: HCkStringArray;
encodedStr: PWideChar): wordbool; stdcall;

Appends multiple strings to the end of the internal ordered collection. The encodedStr is what is returned from the Serialize method (see below).

Returns True for success, False for failure.

Clear

procedure CkStringArray_Clear(objHandle: HCkStringArray) stdcall;

Remove all strings from the internal collection.

Contains

function CkStringArray_Contains(objHandle: HCkStringArray;
str: PWideChar): wordbool; stdcall;

Returns True if the string is present in the internal collection. The string comparisons are case sensitive.

Find

function CkStringArray_Find(objHandle: HCkStringArray;
findStr: PWideChar;
startIndex: Integer): Integer; stdcall;

Finds the index of the first string equal to findStr. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.

FindFirstMatch

function CkStringArray_FindFirstMatch(objHandle: HCkStringArray;
matchPattern: PWideChar;
startIndex: Integer): Integer; stdcall;

Finds the first string that matches the matchPattern. The search begins at startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.

The matchPattern may contain zero or more asterisk chars, each of which matches 0 or more of any character.

GetString

function CkStringArray_GetString(objHandle: HCkStringArray;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkStringArray__getString(objHandle: HCkStringArray;
    index: Integer): PWideChar; stdcall;

Returns the string at an indexed location within the internal collection. The first string is located at index 0.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

GetStringLen

function CkStringArray_GetStringLen(objHandle: HCkStringArray;
index: Integer): Integer; stdcall;

Returns Nth string's length, in characters. The first string is located at index 0.

InsertAt

procedure CkStringArray_InsertAt(objHandle: HCkStringArray;
index: Integer;
str: PWideChar) stdcall;

Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.

LastString

function CkStringArray_LastString(objHandle: HCkStringArray;
outStr: HCkString): wordbool; stdcall;
function CkStringArray__lastString(objHandle: HCkStringArray): PWideChar; stdcall;

Returns the last string in the internal collection.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

LoadFromFile

function CkStringArray_LoadFromFile(objHandle: HCkStringArray;
path: PWideChar): wordbool; stdcall;

Loads strings from a file (one per line) into the internal collection. It is assumed the file contains ANSI strings. To load from a file containing non-ANSI strings (such as utf-8), call LoadFromFile2 instead.

Note: This method appends the strings in path to the existing collection of strings contained in this object.

Returns True for success, False for failure.

LoadFromFile2

function CkStringArray_LoadFromFile2(objHandle: HCkStringArray;
path: PWideChar;
charset: PWideChar): wordbool; stdcall;

Loads strings from a file (one per line) into the internal collection. The charset specifies the character encoding (such as utf-8) of the strings contained in the file.

Note: This method appends the strings in path to the existing collection of strings contained in this object.

Returns True for success, False for failure.

LoadFromText

procedure CkStringArray_LoadFromText(objHandle: HCkStringArray;
str: PWideChar) stdcall;

Loads strings from an in-memory string (one per line) into the internal collection.

Note: This method appends the strings in str to the existing collection of strings contained in this object.

LoadTaskResult

function CkStringArray_LoadTaskResult(objHandle: HCkStringArray;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns True for success, False for failure.

Pop

function CkStringArray_Pop(objHandle: HCkStringArray;
outStr: HCkString): wordbool; stdcall;
function CkStringArray__pop(objHandle: HCkStringArray): PWideChar; stdcall;

Returns the last string and removes it from the internal collection.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

Prepend

procedure CkStringArray_Prepend(objHandle: HCkStringArray;
str: PWideChar) stdcall;

Adds a string to the beginning of the internal collection.

Remove

procedure CkStringArray_Remove(objHandle: HCkStringArray;
str: PWideChar) stdcall;

Removes all strings equal to the string argument from the internal collection.

RemoveAt

function CkStringArray_RemoveAt(objHandle: HCkStringArray;
index: Integer): wordbool; stdcall;

Removes the string at a particular index.

ReplaceAt

procedure CkStringArray_ReplaceAt(objHandle: HCkStringArray;
index: Integer;
str: PWideChar) stdcall;

Introduced in version 9.5.0.52

Replaces the string at a specified index.

SaveNthToFile

function CkStringArray_SaveNthToFile(objHandle: HCkStringArray;
index: Integer;
saveToPath: PWideChar): wordbool; stdcall;

Saves the Nth string in the collection to a file.

Returns True for success, False for failure.

SaveToFile

function CkStringArray_SaveToFile(objHandle: HCkStringArray;
path: PWideChar): wordbool; stdcall;

Saves the collection of strings to a file, one string per line. Strings are saved using the ANSI charset. (Call SaveToFile2 to specify a charset, such as "utf-8")

Returns True for success, False for failure.

SaveToFile2

function CkStringArray_SaveToFile2(objHandle: HCkStringArray;
saveToPath: PWideChar;
charset: PWideChar): wordbool; stdcall;

Saves the collection of strings to a file, one string per line. Strings are saved using the specified charset.

Returns True for success, False for failure.

SaveToText

function CkStringArray_SaveToText(objHandle: HCkStringArray;
outStr: HCkString): wordbool; stdcall;
function CkStringArray__saveToText(objHandle: HCkStringArray): PWideChar; stdcall;

Writes the collection of strings to a single string, one per line (separated by CRLF line endings).

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

Serialize

function CkStringArray_Serialize(objHandle: HCkStringArray;
outStr: HCkString): wordbool; stdcall;
function CkStringArray__serialize(objHandle: HCkStringArray): PWideChar; stdcall;

Returns an string which is an encoded representation of all the strings in the collection. The string collection can be re-created by calling the AppendSerialized method.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

Sort

procedure CkStringArray_Sort(objHandle: HCkStringArray;
ascending: wordbool) stdcall;

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.

SplitAndAppend

procedure CkStringArray_SplitAndAppend(objHandle: HCkStringArray;
str: PWideChar;
boundary: PWideChar) stdcall;

Splits a string at a character or substring boundary and adds each resulting string to the internal collection.

StrAt

function CkStringArray_StrAt(objHandle: HCkStringArray;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkStringArray__strAt(objHandle: HCkStringArray;
    index: Integer): PWideChar; stdcall;

Returns the string at a specific index.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

Subtract

procedure CkStringArray_Subtract(objHandle: HCkStringArray;
stringArrayObj: HCkStringArray) stdcall;

Subtracts the strings contained within stringArrayObj from the caller's internal collection.

Union

procedure CkStringArray_Union(objHandle: HCkStringArray;
stringArrayObj: HCkStringArray) stdcall;

Performs the union set-operator. The result is that the caller will have a string collection that is the union of itself and stringArrayObj.