StringArray DataFlex 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

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoStringArray
Get Create(RefClass(cComCkStringArray)) to hoStringArray

Properties

Count
Function ComCount Returns Integer

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
Function ComCrlf Returns Boolean
Procedure Set ComCrlf Boolean value

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

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
Function ComLastBinaryResult Returns Variant
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 True. 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
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
Introduced in version 9.5.0.52

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
LastStringResult
Function ComLastStringResult Returns String
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 True. 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
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
Length
Function ComLength Returns Integer

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

top
Trim
Function ComTrim Returns Boolean
Procedure Set ComTrim Boolean value

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

top
Unique
Function ComUnique Returns Boolean
Procedure Set ComUnique Boolean value

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.

top
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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.

top
Version
Function ComVersion Returns String

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

top

Methods

Append
Function ComAppend String str Returns Boolean

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

Returns True for success, False for failure.

top
AppendSerialized
Function ComAppendSerialized String encodedStr Returns 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 True for success, False for failure.

top
Clear
Procedure ComClear

Remove all strings from the internal collection.

top
Contains
Function ComContains String str Returns Boolean

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

top
Find
Function ComFind String findStr Integer startIndex Returns 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 ComFindFirstMatch String matchPattern Integer startIndex Returns 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 ComGetString Integer index Returns String

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

Returns null on failure

top
InsertAt
Procedure ComInsertAt Integer index String str

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

top
LastString
Function ComLastString Returns String

Returns the last string in the internal collection.

Returns null on failure

top
LoadFromFile
Function ComLoadFromFile String path Returns 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 True for success, False for failure.

top
LoadFromFile2
Function ComLoadFromFile2 String path String charset Returns 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 True for success, False for failure.

top
LoadFromText
Procedure ComLoadFromText String str

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

top
LoadTaskResult
Function ComLoadTaskResult cComChilkatTask task Returns Boolean
Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns True for success, False for failure.

top
Pop
Function ComPop Returns String

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

Returns null on failure

top
Prepend
Procedure ComPrepend String str

Adds a string to the beginning of the internal collection.

top
Remove
Procedure ComRemove String str

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

top
RemoveAt
Function ComRemoveAt Integer index Returns Boolean

Removes the string at a particular index.

top
ReplaceAt
Procedure ComReplaceAt Integer index String str
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveNthToFile
Function ComSaveNthToFile Integer index String saveToPath Returns Boolean

Saves the Nth string in the collection to a file.

Returns True for success, False for failure.

top
SaveToFile
Function ComSaveToFile String path Returns 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 True for success, False for failure.

top
SaveToFile2
Function ComSaveToFile2 String saveToPath String charset Returns Boolean

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.

top
SaveToText
Function ComSaveToText Returns String

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

Returns null on failure

top
Serialize
Function ComSerialize Returns String

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 null on failure

top
Sort
Procedure ComSort Boolean ascending

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.

top
SplitAndAppend
Procedure ComSplitAndAppend String str String boundary

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

top
Subtract
Procedure ComSubtract cComCkStringArray stringArrayObj

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

top
Union
Procedure ComUnion cComCkStringArray stringArrayObj

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