TCkStringArray Delphi ActiveX Reference Documentation

TCkStringArray

Current Version: 9.5.0.75

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

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. See also: ActiveX Registration Tutorial
  3. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TCkStringArray;
...
begin
obj := TCkStringArray.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

Count
property Count: Integer readonly

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.

top
Crlf
property Crlf: Integer

If 1, strings are always automatically converted to use CRLF line endings. If 0, strings are automatically converted to use bare LF line endings.

top
DebugLogFilePath
property DebugLogFilePath: WideString

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
property LastErrorHtml: WideString readonly

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
property LastErrorText: WideString readonly

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
property LastErrorXml: WideString readonly

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
property LastMethodSuccess: Integer
Introduced in version 9.5.0.52

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
LastStringResult
property LastStringResult: WideString readonly
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
property LastStringResultLen: Integer readonly
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
Length
property Length: Integer readonly

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

top
Trim
property Trim: Integer

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

top
Unique
property Unique: Integer

If 1, 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 0.

top
VerboseLogging
property VerboseLogging: Integer

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

top
Version
property Version: WideString readonly

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

top

Methods

Append
function Append(str: WideString): Integer;

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

Returns 1 for success, 0 for failure.

top
AppendSerialized
function AppendSerialized(encodedStr: WideString): Integer;

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

Returns 1 for success, 0 for failure.

top
Clear
procedure Clear();

Remove all strings from the internal collection.

top
Contains
function Contains(str: WideString): Integer;

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

top
Find
function Find(findStr: WideString; startIndex: Integer): Integer;

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.

top
FindFirstMatch
function FindFirstMatch(matchPattern: WideString; startIndex: Integer): Integer;

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.

top
GetString
function GetString(index: Integer): WideString;

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

Returns a zero-length WideString on failure

top
InsertAt
procedure InsertAt(index: Integer; str: WideString);

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

top
LastString
function LastString(): WideString;

Returns the last string in the internal collection.

Returns a zero-length WideString on failure

top
LoadFromFile
function LoadFromFile(path: WideString): Integer;

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.

Returns 1 for success, 0 for failure.

top
LoadFromFile2
function LoadFromFile2(path: WideString; charset: WideString): Integer;

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.

Returns 1 for success, 0 for failure.

top
LoadFromText
procedure LoadFromText(str: WideString);

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

top
LoadTaskResult
function LoadTaskResult(task: TChilkatTask): Integer;
Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top
Pop
function Pop(): WideString;

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

Returns a zero-length WideString on failure

top
Prepend
procedure Prepend(str: WideString);

Adds a string to the beginning of the internal collection.

top
Remove
procedure Remove(str: WideString);

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

top
RemoveAt
function RemoveAt(index: Integer): Integer;

Removes the string at a particular index.

top
ReplaceAt
procedure ReplaceAt(index: Integer; str: WideString);
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveNthToFile
function SaveNthToFile(index: Integer; saveToPath: WideString): Integer;

Saves the Nth string in the collection to a file.

Returns 1 for success, 0 for failure.

top
SaveToFile
function SaveToFile(path: WideString): Integer;

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 1 for success, 0 for failure.

top
SaveToFile2
function SaveToFile2(saveToPath: WideString; charset: WideString): Integer;

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

Returns 1 for success, 0 for failure.

top
SaveToText
function SaveToText(): WideString;

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

Returns a zero-length WideString on failure

top
Serialize
function Serialize(): WideString;

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 a zero-length WideString on failure

top
Sort
procedure Sort(ascending: Integer);

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

top
SplitAndAppend
procedure SplitAndAppend(str: WideString; boundary: WideString);

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

top
Subtract
procedure Subtract(stringArrayObj: TCkStringArray);

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

top
Union
procedure Union(stringArrayObj: TCkStringArray);

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

top