StringArray PureBasic Reference Documentation
StringArray
Current Version: 10.1.2
Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.
Object Creation
obj.i = CkStringArray::ckCreate()
; Make sure to dispose of the object when finished like this:
CkStringArray::ckDispose(obj);
Properties
Count
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.
topCrlf
Declare setCkCrlf(obj.i, value.i)
If 1, strings are always automatically converted to use CRLF line endings. If 0, strings are automatically converted to use bare LF line endings.
topDebugLogFilePath
Declare setCkDebugLogFilePath(obj.i, value.s)
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.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
Declare setCkLastMethodSuccess(obj.i, value.i)
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
topLength
The number of strings contained within the internal collection. (Identical to the Count property.)
topTrim
Declare setCkTrim(obj.i, value.i)
If 1, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.
topUnique
Declare setCkUnique(obj.i, value.i)
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.
topVerboseLogging
Declare setCkVerboseLogging(obj.i, value.i)
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.
topVersion
Methods
Append
Appends a string to the end of the internal ordered collection.
Returns 1 for success, 0 for failure.
topAppendSerialized
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.
topClear
Remove all strings from the internal collection.
topContains
Returns 1 if the string is present in the internal collection. The string comparisons are case sensitive.
topFind
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.
topFindFirstMatch
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.
topGetString
Returns the string at an indexed location within the internal collection. The first string is located at index 0.
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
topGetStringLen
Returns Nth string's length, in characters. The first string is located at index 0.
topInsertAt
Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.
topLastString
Returns the last string in the internal collection.
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
topLoadFromFile
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 1 for success, 0 for failure.
topLoadFromFile2
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 1 for success, 0 for failure.
topLoadFromText
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.
topLoadTaskResult
Loads the string collection from a completed asynchronous task.
Returns 1 for success, 0 for failure.
topPop
Returns the last string and removes it from the internal collection.
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
topPrepend
Adds a string to the beginning of the internal collection.
topRemove
Removes all strings equal to the string argument from the internal collection.
topRemoveAt
Removes the string at a particular index.
topReplaceAt
Replaces the string at a specified index.
topSaveNthToFile
SaveToFile
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.
topSaveToFile2
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.
topSaveToText
Writes the collection of strings to a single string, one per line (separated by CRLF line endings).
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
topSerialize
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 an empty string on failure. Use the LastMethodSuccess property to check for success.
topSort
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.
topSplitAndAppend
Splits a string at a character or substring boundary and adds each resulting string to the internal collection.
topSubtract
Subtracts the strings contained within stringArrayObj from the caller's internal collection.
topUnion
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