StringArray Lianja Reference Documentation

StringArray

Current Version: 9.5.0.73

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

Object Creation

loObject = createobject("CkStringArray")

Properties

Count
Count As Numeric (read-only)

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
Crlf As Boolean

If .T., strings are always automatically converted to use CRLF line endings. If .F., strings are automatically converted to use bare LF line endings.

top
DebugLogFilePath
DebugLogFilePath As Character

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
LastErrorHtml
LastErrorHtml As Character (read-only)

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
LastErrorText As Character (read-only)

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
LastErrorXml As Character (read-only)

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
LastMethodSuccess As Boolean
Introduced in version 9.5.0.52

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

top
Length
Length As Numeric (read-only)

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

top
Trim
Trim As Boolean

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

top
Unique
Unique As Boolean

If .T., 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 .F..

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As Character (read-only)

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

top

Methods

Append
Append(str As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
AppendSerialized
AppendSerialized(encodedStr As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
Clear
Clear()

Remove all strings from the internal collection.

top
Contains
Contains(str As Character) As Boolean

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

top
Find
Find(findStr As Character, startIndex As Numeric) As Numeric

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
FindFirstMatch(matchPattern As Character, startIndex As Numeric) As Numeric

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
GetString(index As Numeric) As Character

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

Returns .F. on failure

top
GetStringLen
GetStringLen(index As Numeric) As Numeric

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

top
InsertAt
InsertAt(index As Numeric, str As Character)

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

top
LastString
LastString() As Character

Returns the last string in the internal collection.

Returns .F. on failure

top
LoadFromFile
LoadFromFile(path As Character) As Boolean

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 .T. for success, .F. for failure.

top
LoadFromFile2
LoadFromFile2(path As Character, charset As Character) As Boolean

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 .T. for success, .F. for failure.

top
LoadFromText
LoadFromText(str As Character)

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

top
LoadTaskResult
LoadTaskResult(task As CkTask) As Boolean
Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns .T. for success, .F. for failure.

top
Pop
Pop() As Character

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

Returns .F. on failure

top
Prepend
Prepend(str As Character)

Adds a string to the beginning of the internal collection.

top
Remove
Remove(str As Character)

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

top
RemoveAt
RemoveAt(index As Numeric) As Boolean

Removes the string at a particular index.

top
ReplaceAt
ReplaceAt(index As Numeric, str As Character)
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveLastError
SaveLastError(path As Character) As Boolean

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns .T. for success, .F. for failure.

top
SaveNthToFile
SaveNthToFile(index As Numeric, saveToPath As Character) As Boolean

Saves the Nth string in the collection to a file.

Returns .T. for success, .F. for failure.

top
SaveToFile
SaveToFile(path As Character) As Boolean

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 .T. for success, .F. for failure.

top
SaveToFile2
SaveToFile2(saveToPath As Character, charset As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
SaveToText
SaveToText() As Character

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

Returns .F. on failure

top
Serialize
Serialize() As Character

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 .F. on failure

top
Sort
Sort(ascending As Boolean)

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

top
SplitAndAppend
SplitAndAppend(str As Character, boundary As Character)

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

top
Subtract
Subtract(stringArrayObj As CkStringArray)

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

top
Union
Union(stringArrayObj As CkStringArray)

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