---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: StringTable
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_StringTableRef.html
---
# Chilkat StringTable — PowerBuilder — v11.7.0

> Chilkat 11.7.0 · language=powerbuilder · class=StringTable
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/StringTable.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/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**

```powerbuilder
oleobject loo_StringTable
integer li_rc

loo_StringTable = create oleobject
li_rc = loo_StringTable.ConnectToNewObject("Chilkat.StringTable")
if li_rc < 0 then
    destroy loo_StringTable
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_StringTable ...

destroy loo_StringTable
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.StringTable.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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 PowerBuilder.

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` | `string DebugLogFilePath` | 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` | `blob LastBinaryResult (read-only)` | 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` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | 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` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `long Count (read-only)` |
| `Append` | method | `long Append(string value)` |
| `AppendFromFile` | method | `long AppendFromFile(long maxLineLen, string charset, string path)` |
| `AppendFromSb` | method | `long AppendFromSb(ChilkatStringBuilder sb)` |
| `Clear` | method | `Clear()` |
| `FindMatch` | method | `long FindMatch(ChilkatStringBuilder sb, long caseSensitive)` |
| `FindSubstring` | method | `long FindSubstring(long startIndex, string substr, long caseSensitive)` |
| `GetStrings` | method | `string GetStrings(long startIdx, long count, long crlf)` |
| `IntAt` | method | `long IntAt(long index)` |
| `SaveToFile` | method | `long SaveToFile(string charset, long bCrlf, string path)` |
| `Sort` | method | `long Sort(long ascending, long caseSensitive)` |
| `SplitAndAppend` | method | `long SplitAndAppend(string inStr, string delimiterChar, long exceptDoubleQuoted, long exceptEscaped)` |
| `StringAt` | method | `string StringAt(long index)` |
| `StringAtSb` | method | `long StringAtSb(long index, ChilkatStringBuilder sb)` |
| `ToSb` | method | `long ToSb(ChilkatStringBuilder sb)` |
| `WordFollowing` | method | `long WordFollowing(ChilkatStringBuilder sb, long captureEmailAddr, ChilkatStringBuilder sbWord)` |

## Properties

### StringTable.Count

`Chilkat 11.7.0 · powerbuilder · StringTable · Count · property · read-only · since 9.5.0.62`

```powerbuilder
long Count (read-only)
```

The number of strings in the table.

## Methods

### StringTable.Append

`Chilkat 11.7.0 · powerbuilder · StringTable · Append · method · since 9.5.0.62`

```powerbuilder
long Append(string value)
```

Appends a string to the table.

Returns 1 for success, 0 for failure.

### StringTable.AppendFromFile

`Chilkat 11.7.0 · powerbuilder · StringTable · AppendFromFile · method · since 9.5.0.62`

```powerbuilder
long AppendFromFile(long maxLineLen, string charset, string path)
```

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 1 for success, 0 for failure.

### StringTable.AppendFromSb

`Chilkat 11.7.0 · powerbuilder · StringTable · AppendFromSb · method · since 9.5.0.62`

```powerbuilder
long AppendFromSb(ChilkatStringBuilder sb)
```

Appends strings, one per line, from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

### StringTable.Clear

`Chilkat 11.7.0 · powerbuilder · StringTable · Clear · method · since 9.5.0.62`

```powerbuilder
Clear()
```

Removes all the strings from the table.

### StringTable.FindMatch

`Chilkat 11.7.0 · powerbuilder · StringTable · FindMatch · method · since 11.1.0`

```powerbuilder
long FindMatch(ChilkatStringBuilder sb, long caseSensitive)
```

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 · powerbuilder · StringTable · FindSubstring · method · since 9.5.0.77`

```powerbuilder
long FindSubstring(long startIndex, string substr, long caseSensitive)
```

Return the index of the first string in the table containing `substr`. Begins searching strings starting at `startIndex`. If `caseSensitive` is `1`, then the search is case sensitive. If `caseSensitive` is `0` then the search is case insensitive. Returns -1 if the `substr` is not found.

### StringTable.GetStrings

`Chilkat 11.7.0 · powerbuilder · StringTable · GetStrings · method · since 9.5.0.87`

```powerbuilder
string GetStrings(long startIdx, long count, long crlf)
```

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 `1` to emit with CRLF line endings, or `0` 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 · powerbuilder · StringTable · IntAt · method · since 9.5.0.63`

```powerbuilder
long IntAt(long index)
```

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 · powerbuilder · StringTable · SaveToFile · method · since 9.5.0.62`

```powerbuilder
long SaveToFile(string charset, long bCrlf, string path)
```

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 `1`, then CRLF line endings are used, otherwise LF-only line endings are used.

Returns 1 for success, 0 for failure.

### StringTable.Sort

`Chilkat 11.7.0 · powerbuilder · StringTable · Sort · method · since 9.5.0.87`

```powerbuilder
long Sort(long ascending, long caseSensitive)
```

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`.

Returns 1 for success, 0 for failure.

### StringTable.SplitAndAppend

`Chilkat 11.7.0 · powerbuilder · StringTable · SplitAndAppend · method · since 9.5.0.62`

```powerbuilder
long SplitAndAppend(string inStr, string delimiterChar, long exceptDoubleQuoted, long exceptEscaped)
```

Splits a string into parts based on a single character `delimiterChar`. If `exceptDoubleQuoted` is `1`, then the delimiter char found between double quotes is not treated as a delimiter. If `exceptEscaped` is `1`, then an escaped (with a backslash) delimiter char is not treated as a delimiter.

Returns 1 for success, 0 for failure.

### StringTable.StringAt

`Chilkat 11.7.0 · powerbuilder · StringTable · StringAt · method · since 9.5.0.62`

```powerbuilder
string StringAt(long index)
```

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 · powerbuilder · StringTable · StringAtSb · method · since 11.2.0`

```powerbuilder
long StringAtSb(long index, ChilkatStringBuilder sb)
```

Appends the Nth string in the table to `sb`. The `index` is 0-based. (The first string is at index 0.)

Returns 1 for success, 0 for failure.

### StringTable.ToSb

`Chilkat 11.7.0 · powerbuilder · StringTable · ToSb · method · since 11.3.0`

```powerbuilder
long ToSb(ChilkatStringBuilder sb)
```

Appends the entire string table to `sb` using CRLF line endings.

Returns 1 for success, 0 for failure.

### StringTable.WordFollowing

`Chilkat 11.7.0 · powerbuilder · StringTable · WordFollowing · method · since 11.1.0`

```powerbuilder
long WordFollowing(ChilkatStringBuilder sb, long captureEmailAddr, ChilkatStringBuilder sbWord)
```

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 `1` if the target word is expected to be an email address, otherwise set `captureEmailAddr` to `0`. `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/powerbuilder/classes/StringBuilder.md)

