--- product: Chilkat product_version: 11.7.0 language: dataflex language_label: DataFlex class: StringArray license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/dataflexStringArrayRef.html --- # Chilkat StringArray — DataFlex — v11.7.0 > Chilkat 11.7.0 · language=dataflex · class=StringArray > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/StringArray.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/guide.md`. ## Purpose **Manage an ordered collection of strings, with StringTable recommended for new code.** `Chilkat.StringArray` is an ordered string-collection class that can append, prepend, insert, replace, remove, pop, and retrieve strings by index. It can load one string per line from files or in-memory text, save the collection back to text or files, enforce uniqueness, trim incoming values, normalize line endings, search by exact value or wildcard pattern, sort entries, split text into entries, serialize and restore the collection, and perform set-style operations such as union and subtraction. **Recommendation:** For new development, prefer `Chilkat.StringTable` instead of `Chilkat.StringArray`. `StringTable` provides a simpler, faster, and more memory-efficient way to manage ordered lists of strings. Use `StringArray` primarily when maintaining existing code or when a specific API or older example already uses it. **Ordered string collection** Store strings in an internal ordered collection and retrieve them by zero-based index using `GetString`, `StrAt`, or `LastString`. **Add and modify entries** Append, prepend, insert, replace, remove, clear, or pop strings as the collection changes. **Load and save text** Load one string per line from files or text, and save the collection back to files or a single line-delimited string. **Charset-aware file I/O** Use charset-specific load and save methods when working with UTF-8, UTF-16, or other non-ANSI text encodings. **Search, match, and sort** Check for exact strings, find values from a starting index, match wildcard patterns, and sort ascending or descending. **Serialize and combine** Serialize the collection for later restoration, split text into entries, and combine or subtract collections with set-style operations. **Common pattern:** Create a `StringArray`, optionally set `Trim`, `Crlf`, or `Unique`, then append strings directly or load them from a file or text block. Search, sort, split, remove, union, or subtract entries as needed, then save the result with `SaveToText`, `SaveToFile`, or `SaveToFile2`. For new code that only needs an ordered list of strings, use `Chilkat.StringTable` instead. **Naming note:** Although the class name contains `Array`, `Chilkat.StringArray` is a Chilkat object that manages an ordered string collection. It should not be confused with a native array type in a programming language. ## Object creation, unlocking and error handling **Object Creation** ```dataflex // (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoStringArray Get Create(RefClass(cComCkStringArray)) to hoStringArray ``` Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in DataFlex. How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `Function ComDebugLogFilePath Returns String Procedure Set ComDebugLogFilePath String value` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastBinaryResult` | `Function ComLastBinaryResult Returns Variant` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. | | `LastErrorHtml` | `Function ComLastErrorHtml Returns String` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `Function ComLastErrorText Returns String` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `Function ComLastErrorXml Returns String` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `Function ComLastMethodSuccess Returns Boolean Procedure Set ComLastMethodSuccess Boolean value` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `LastStringResult` | `Function ComLastStringResult Returns String` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. | | `LastStringResultLen` | `Function ComLastStringResultLen Returns Integer` | read-only | The length, in characters, of the string contained in the LastStringResult property. | | `VerboseLogging` | `Function ComVerboseLogging Returns Boolean Procedure Set ComVerboseLogging Boolean value` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `Function ComVersion Returns String` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `Count` | property, read-only | `Function ComCount Returns Integer` | | `Crlf` | property, read/write | `Function ComCrlf Returns Boolean Procedure Set ComCrlf Boolean value` | | `Length` | property, read-only | `Function ComLength Returns Integer` | | `Trim` | property, read/write | `Function ComTrim Returns Boolean Procedure Set ComTrim Boolean value` | | `Unique` | property, read/write | `Function ComUnique Returns Boolean Procedure Set ComUnique Boolean value` | | `Append` | method | `Function ComAppend String str Returns Boolean` | | `AppendSerialized` | method | `Function ComAppendSerialized String encodedStr Returns Boolean` | | `Clear` | method | `Procedure ComClear` | | `Contains` | method | `Function ComContains String str Returns Boolean` | | `Find` | method | `Function ComFind String findStr Integer startIndex Returns Integer` | | `FindFirstMatch` | method | `Function ComFindFirstMatch String matchPattern Integer startIndex Returns Integer` | | `GetString` | method | `Function ComGetString Integer index Returns String` | | `InsertAt` | method | `Procedure ComInsertAt Integer index String str` | | `LastString` | method | `Function ComLastString Returns String` | | `LoadFromFile` | method | `Function ComLoadFromFile String path Returns Boolean` | | `LoadFromFile2` | method | `Function ComLoadFromFile2 String path String charset Returns Boolean` | | `LoadFromText` | method | `Procedure ComLoadFromText String str` | | `LoadTaskResult` | method | `Function ComLoadTaskResult cComChilkatTask task Returns Boolean` | | `Pop` | method | `Function ComPop Returns String` | | `Prepend` | method | `Procedure ComPrepend String str` | | `Remove` | method | `Procedure ComRemove String str` | | `RemoveAt` | method | `Function ComRemoveAt Integer index Returns Boolean` | | `ReplaceAt` | method | `Procedure ComReplaceAt Integer index String str` | | `SaveNthToFile` | method | `Function ComSaveNthToFile Integer index String saveToPath Returns Boolean` | | `SaveToFile` | method | `Function ComSaveToFile String path Returns Boolean` | | `SaveToFile2` | method | `Function ComSaveToFile2 String saveToPath String charset Returns Boolean` | | `SaveToText` | method | `Function ComSaveToText Returns String` | | `Serialize` | method | `Function ComSerialize Returns String` | | `Sort` | method | `Procedure ComSort Boolean ascending` | | `SplitAndAppend` | method | `Procedure ComSplitAndAppend String str String boundary` | | `Subtract` | method | `Procedure ComSubtract cComCkStringArray stringArrayObj` | | `Union` | method | `Procedure ComUnion cComCkStringArray stringArrayObj` | ## Properties ### StringArray.Count `Chilkat 11.7.0 · dataflex · StringArray · Count · property · read-only` ```dataflex 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. ### StringArray.Crlf `Chilkat 11.7.0 · dataflex · StringArray · Crlf · property · read/write` ```dataflex 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. ### StringArray.Length `Chilkat 11.7.0 · dataflex · StringArray · Length · property · read-only` ```dataflex Function ComLength Returns Integer ``` The number of strings contained within the internal collection. (Identical to the Count property.) ### StringArray.Trim `Chilkat 11.7.0 · dataflex · StringArray · Trim · property · read/write` ```dataflex 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. ### StringArray.Unique `Chilkat 11.7.0 · dataflex · StringArray · Unique · property · read/write` ```dataflex 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`. ## Methods ### StringArray.Append `Chilkat 11.7.0 · dataflex · StringArray · Append · method` ```dataflex Function ComAppend String str Returns Boolean ``` Appends a string to the end of the internal ordered collection. Returns True for success, False for failure. ### StringArray.AppendSerialized `Chilkat 11.7.0 · dataflex · StringArray · AppendSerialized · method` ```dataflex 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. ### StringArray.Clear `Chilkat 11.7.0 · dataflex · StringArray · Clear · method` ```dataflex Procedure ComClear ``` Remove all strings from the internal collection. ### StringArray.Contains `Chilkat 11.7.0 · dataflex · StringArray · Contains · method` ```dataflex Function ComContains String str Returns Boolean ``` Returns `True` if the string is present in the internal collection. The string comparisons are case sensitive. ### StringArray.Find `Chilkat 11.7.0 · dataflex · StringArray · Find · method` ```dataflex 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. ### StringArray.FindFirstMatch `Chilkat 11.7.0 · dataflex · StringArray · FindFirstMatch · method` ```dataflex 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. ### StringArray.GetString `Chilkat 11.7.0 · dataflex · StringArray · GetString · method` ```dataflex 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 ### StringArray.InsertAt `Chilkat 11.7.0 · dataflex · StringArray · InsertAt · method` ```dataflex 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. ### StringArray.LastString `Chilkat 11.7.0 · dataflex · StringArray · LastString · method` ```dataflex Function ComLastString Returns String ``` Returns the last string in the internal collection. Returns `null` on failure ### StringArray.LoadFromFile `Chilkat 11.7.0 · dataflex · StringArray · LoadFromFile · method` ```dataflex 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. **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. ### StringArray.LoadFromFile2 `Chilkat 11.7.0 · dataflex · StringArray · LoadFromFile2 · method` ```dataflex 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. **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. ### StringArray.LoadFromText `Chilkat 11.7.0 · dataflex · StringArray · LoadFromText · method` ```dataflex Procedure ComLoadFromText String str ``` 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. ### StringArray.LoadTaskResult `Chilkat 11.7.0 · dataflex · StringArray · LoadTaskResult · method · since 9.5.0.52` ```dataflex Function ComLoadTaskResult cComChilkatTask task Returns Boolean ``` Loads the string collection from a completed asynchronous task. Returns True for success, False for failure. ### StringArray.Pop `Chilkat 11.7.0 · dataflex · StringArray · Pop · method` ```dataflex Function ComPop Returns String ``` Returns the last string and removes it from the internal collection. Returns `null` on failure ### StringArray.Prepend `Chilkat 11.7.0 · dataflex · StringArray · Prepend · method` ```dataflex Procedure ComPrepend String str ``` Adds a string to the beginning of the internal collection. ### StringArray.Remove `Chilkat 11.7.0 · dataflex · StringArray · Remove · method` ```dataflex Procedure ComRemove String str ``` Removes all strings equal to the string argument from the internal collection. ### StringArray.RemoveAt `Chilkat 11.7.0 · dataflex · StringArray · RemoveAt · method` ```dataflex Function ComRemoveAt Integer index Returns Boolean ``` Removes the string at a particular index. Returns True for success, False for failure. ### StringArray.ReplaceAt `Chilkat 11.7.0 · dataflex · StringArray · ReplaceAt · method · since 9.5.0.52` ```dataflex Procedure ComReplaceAt Integer index String str ``` Replaces the string at a specified index. ### StringArray.SaveNthToFile `Chilkat 11.7.0 · dataflex · StringArray · SaveNthToFile · method` ```dataflex 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. ### StringArray.SaveToFile `Chilkat 11.7.0 · dataflex · StringArray · SaveToFile · method` ```dataflex 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. ### StringArray.SaveToFile2 `Chilkat 11.7.0 · dataflex · StringArray · SaveToFile2 · method` ```dataflex 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. ### StringArray.SaveToText `Chilkat 11.7.0 · dataflex · StringArray · SaveToText · method` ```dataflex 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 ### StringArray.Serialize `Chilkat 11.7.0 · dataflex · StringArray · Serialize · method` ```dataflex 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 ### StringArray.Sort `Chilkat 11.7.0 · dataflex · StringArray · Sort · method` ```dataflex 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`. ### StringArray.SplitAndAppend `Chilkat 11.7.0 · dataflex · StringArray · SplitAndAppend · method` ```dataflex Procedure ComSplitAndAppend String str String boundary ``` Splits a string at a character or substring boundary and adds each resulting string to the internal collection. ### StringArray.Subtract `Chilkat 11.7.0 · dataflex · StringArray · Subtract · method` ```dataflex Procedure ComSubtract cComCkStringArray stringArrayObj ``` Subtracts the strings contained within `stringArrayObj` from the caller's internal collection. ### StringArray.Union `Chilkat 11.7.0 · dataflex · StringArray · Union · method` ```dataflex 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`. ## Related classes [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/Task.md)