--- product: Chilkat product_version: 11.7.0 language: dataflex language_label: DataFlex class: StringTable license: free deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/dataflexStringTableRef.html --- # Chilkat StringTable — DataFlex — v11.7.0 > Chilkat 11.7.0 · language=dataflex · class=StringTable > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/StringTable.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/guide.md`. ## Purpose **Store, load, search, sort, split, retrieve, and save ordered lists of strings.** `Chilkat.StringTable` is a simple ordered collection of strings. It can append strings directly, load one string per line from files or `StringBuilder`, search for substrings or wildcard matches, sort the collection, split strings into entries, retrieve strings by index, export the table as line-delimited text, and save the result to a file. **Ordered string collection** Store a list of strings in insertion order and retrieve individual entries by zero-based index. **Append and import** Add strings directly, append strings from a file, or load line-delimited text from a `StringBuilder`. **Search strings** Find entries containing a substring or matching a wildcard pattern when filtering or locating text values. **Sort entries** Sort the string collection when deterministic ordering or user-facing display order is needed. **Split into entries** Split delimited text into separate string-table entries for easier indexing, searching, sorting, or saving. **Export and save** Convert the table back to line-delimited text, copy it to a `StringBuilder`, or save the collection to a file. **Common pattern:** Use `StringTable` when application code needs a lightweight ordered list of text values. Append or load the strings, search or sort as needed, retrieve entries by index with `StringAt` or `StringAtSb`, then export the final list as line-delimited text or save it to a file. For an extended overview, see [StringTable Class Overview](https://www.chilkatsoft.com/stringtable_class_overview.asp). ## Object creation, unlocking and error handling **Object Creation** ```dataflex // (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoStringTable Get Create(RefClass(cComChilkatStringTable)) to hoStringTable ``` 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` | | `Append` | method | `Function ComAppend String value Returns Boolean` | | `AppendFromFile` | method | `Function ComAppendFromFile Integer maxLineLen String charset String path Returns Boolean` | | `AppendFromSb` | method | `Function ComAppendFromSb cComChilkatStringBuilder sb Returns Boolean` | | `Clear` | method | `Procedure ComClear` | | `FindMatch` | method | `Function ComFindMatch cComChilkatStringBuilder sb Boolean caseSensitive Returns Integer` | | `FindSubstring` | method | `Function ComFindSubstring Integer startIndex String substr Boolean caseSensitive Returns Integer` | | `GetStrings` | method | `Function ComGetStrings Integer startIdx Integer count Boolean crlf Returns String` | | `IntAt` | method | `Function ComIntAt Integer index Returns Integer` | | `SaveToFile` | method | `Function ComSaveToFile String charset Boolean bCrlf String path Returns Boolean` | | `Sort` | method | `Function ComSort Boolean ascending Boolean caseSensitive Returns Boolean` | | `SplitAndAppend` | method | `Function ComSplitAndAppend String inStr String delimiterChar Boolean exceptDoubleQuoted Boolean exceptEscaped Returns Boolean` | | `StringAt` | method | `Function ComStringAt Integer index Returns String` | | `StringAtSb` | method | `Function ComStringAtSb Integer index cComChilkatStringBuilder sb Returns Boolean` | | `ToSb` | method | `Function ComToSb cComChilkatStringBuilder sb Returns Boolean` | | `WordFollowing` | method | `Function ComWordFollowing cComChilkatStringBuilder sb Boolean captureEmailAddr cComChilkatStringBuilder sbWord Returns Integer` | ## Properties ### StringTable.Count `Chilkat 11.7.0 · dataflex · StringTable · Count · property · read-only · since 9.5.0.62` ```dataflex Function ComCount Returns Integer ``` The number of strings in the table. ## Methods ### StringTable.Append `Chilkat 11.7.0 · dataflex · StringTable · Append · method · since 9.5.0.62` ```dataflex Function ComAppend String value Returns Boolean ``` Appends a string to the table. Returns True for success, False for failure. ### StringTable.AppendFromFile `Chilkat 11.7.0 · dataflex · StringTable · AppendFromFile · method · since 9.5.0.62` ```dataflex Function ComAppendFromFile Integer maxLineLen String charset String path Returns Boolean ``` Appends strings, one per line, from a file. Each line in the `path` should be no longer than the length specified in `maxLineLen`. The `charset` indicates the character encoding of the contents of the file, such as `utf-8`, `iso-8859-1`, `Shift_JIS`, etc. Returns True for success, False for failure. ### StringTable.AppendFromSb `Chilkat 11.7.0 · dataflex · StringTable · AppendFromSb · method · since 9.5.0.62` ```dataflex Function ComAppendFromSb cComChilkatStringBuilder sb Returns Boolean ``` Appends strings, one per line, from the contents of a StringBuilder object. Returns True for success, False for failure. ### StringTable.Clear `Chilkat 11.7.0 · dataflex · StringTable · Clear · method · since 9.5.0.62` ```dataflex Procedure ComClear ``` Removes all the strings from the table. ### StringTable.FindMatch `Chilkat 11.7.0 · dataflex · StringTable · FindMatch · method · since 11.1.0` ```dataflex Function ComFindMatch cComChilkatStringBuilder sb Boolean caseSensitive Returns Integer ``` This string table object holds strings with wildcards. The method returns the index of the wildcarded string that matches the text in `sb`, or -1 if no match is found. `caseSensitive` specifies whether the matching should be case-sensitive. ### StringTable.FindSubstring `Chilkat 11.7.0 · dataflex · StringTable · FindSubstring · method · since 9.5.0.77` ```dataflex Function ComFindSubstring Integer startIndex String substr Boolean caseSensitive Returns Integer ``` Return the index of the first string in the table containing `substr`. Begins searching strings starting at `startIndex`. If `caseSensitive` is `True`, then the search is case sensitive. If `caseSensitive` is `False` then the search is case insensitive. Returns -1 if the `substr` is not found. ### StringTable.GetStrings `Chilkat 11.7.0 · dataflex · StringTable · GetStrings · method · since 9.5.0.87` ```dataflex Function ComGetStrings Integer startIdx Integer count Boolean crlf Returns String ``` Return the number of strings specified by `count`, one per line, starting at `startIdx`. To return the entire table, pass 0 values for both `startIdx` and `count`. Set `crlf` equal to `True` to emit with CRLF line endings, or `False` to emit LF-only line endings. The last string is emitted includes the line ending. Returns `null` on failure ### StringTable.IntAt `Chilkat 11.7.0 · dataflex · StringTable · IntAt · method · since 9.5.0.63` ```dataflex Function ComIntAt Integer index Returns Integer ``` Returns the Nth string in the table, converted to an integer value. The `index` is 0-based. (The first string is at index 0.) Returns -1 if no string is found at the specified index. Returns 0 if the string at the specified index exist, but is not an integer. ### StringTable.SaveToFile `Chilkat 11.7.0 · dataflex · StringTable · SaveToFile · method · since 9.5.0.62` ```dataflex Function ComSaveToFile String charset Boolean bCrlf String path Returns Boolean ``` Saves the string table to a file. The `charset` is the character encoding to use, such as `utf-8`, `iso-8859-1`, `windows-1252`, `Shift_JIS`, `gb2312`, etc. If `bCrlf` is `True`, then CRLF line endings are used, otherwise LF-only line endings are used. Returns True for success, False for failure. ### StringTable.Sort `Chilkat 11.7.0 · dataflex · StringTable · Sort · method · since 9.5.0.87` ```dataflex Function ComSort Boolean ascending Boolean caseSensitive Returns Boolean ``` 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`. Returns True for success, False for failure. ### StringTable.SplitAndAppend `Chilkat 11.7.0 · dataflex · StringTable · SplitAndAppend · method · since 9.5.0.62` ```dataflex Function ComSplitAndAppend String inStr String delimiterChar Boolean exceptDoubleQuoted Boolean exceptEscaped Returns Boolean ``` Splits a string into parts based on a single character `delimiterChar`. If `exceptDoubleQuoted` is `True`, then the delimiter char found between double quotes is not treated as a delimiter. If `exceptEscaped` is `True`, then an escaped (with a backslash) delimiter char is not treated as a delimiter. Returns True for success, False for failure. ### StringTable.StringAt `Chilkat 11.7.0 · dataflex · StringTable · StringAt · method · since 9.5.0.62` ```dataflex Function ComStringAt Integer index Returns String ``` Returns the Nth string in the table. The `index` is 0-based. (The first string is at index 0.) Returns `null` on failure ### StringTable.StringAtSb `Chilkat 11.7.0 · dataflex · StringTable · StringAtSb · method · since 11.2.0` ```dataflex Function ComStringAtSb Integer index cComChilkatStringBuilder sb Returns Boolean ``` Appends the Nth string in the table to `sb`. The `index` is 0-based. (The first string is at index 0.) Returns True for success, False for failure. ### StringTable.ToSb `Chilkat 11.7.0 · dataflex · StringTable · ToSb · method · since 11.3.0` ```dataflex Function ComToSb cComChilkatStringBuilder sb Returns Boolean ``` Appends the entire string table to `sb` using CRLF line endings. Returns True for success, False for failure. ### StringTable.WordFollowing `Chilkat 11.7.0 · dataflex · StringTable · WordFollowing · method · since 11.1.0` ```dataflex Function ComWordFollowing cComChilkatStringBuilder sb Boolean captureEmailAddr cComChilkatStringBuilder sbWord Returns Integer ``` The method performs a case-insensitive search to return the index of a table entry matching `sb`, or -1 if there is no match. Set `captureEmailAddr` to `True` if the target word is expected to be an email address, otherwise set `captureEmailAddr` to `False`. `sbWord` will receive the word (email address) following the matched text. This method helps replace the outdated Chilkat Bounce class, which was used for identifying and categorizing bounced email types. ## Related classes [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/dataflex/classes/StringBuilder.md)