---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: StringTable
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_StringTableRef.html
---
# Chilkat StringTable — SQL Server — v11.7.0

> Chilkat 11.7.0 · language=sqlserver · 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/sqlserver/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**

```sql
DECLARE @hr int
DECLARE @stringTable int
EXEC @hr = sp_OACreate 'Chilkat.StringTable', @stringTable OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @stringTable ...

EXEC @hr = sp_OADestroy @stringTable
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.StringTable.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @stringTable, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `EXEC sp_OAGetProperty @stringTable, 'Count', @iValue OUT` |
| `Append` | method | `EXEC sp_OAMethod @stringTable, 'Append', @success OUT, @value` |
| `AppendFromFile` | method | `EXEC sp_OAMethod @stringTable, 'AppendFromFile', @success OUT, @maxLineLen, @charset, @path` |
| `AppendFromSb` | method | `EXEC sp_OAMethod @stringTable, 'AppendFromSb', @success OUT, @sb` |
| `Clear` | method | `EXEC sp_OAMethod @stringTable, 'Clear', NULL` |
| `FindMatch` | method | `EXEC sp_OAMethod @stringTable, 'FindMatch', @iResult OUT, @sb, @caseSensitive` |
| `FindSubstring` | method | `EXEC sp_OAMethod @stringTable, 'FindSubstring', @iResult OUT, @startIndex, @substr, @caseSensitive` |
| `GetStrings` | method | `EXEC sp_OAMethod @stringTable, 'GetStrings', @sResult OUT, @startIdx, @count, @crlf` |
| `IntAt` | method | `EXEC sp_OAMethod @stringTable, 'IntAt', @iResult OUT, @index` |
| `SaveToFile` | method | `EXEC sp_OAMethod @stringTable, 'SaveToFile', @success OUT, @charset, @bCrlf, @path` |
| `Sort` | method | `EXEC sp_OAMethod @stringTable, 'Sort', @success OUT, @ascending, @caseSensitive` |
| `SplitAndAppend` | method | `EXEC sp_OAMethod @stringTable, 'SplitAndAppend', @success OUT, @inStr, @delimiterChar, @exceptDoubleQuoted, @exceptEscaped` |
| `StringAt` | method | `EXEC sp_OAMethod @stringTable, 'StringAt', @sResult OUT, @index` |
| `StringAtSb` | method | `EXEC sp_OAMethod @stringTable, 'StringAtSb', @success OUT, @index, @sb` |
| `ToSb` | method | `EXEC sp_OAMethod @stringTable, 'ToSb', @success OUT, @sb` |
| `WordFollowing` | method | `EXEC sp_OAMethod @stringTable, 'WordFollowing', @iResult OUT, @sb, @captureEmailAddr, @sbWord` |

## Properties

### StringTable.Count

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

```sql
EXEC sp_OAGetProperty @stringTable, 'Count', @iValue OUT
```

The number of strings in the table.

## Methods

### StringTable.Append

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

```sql
EXEC sp_OAMethod @stringTable, 'Append', @success OUT, @value
```

Appends a string to the table.

Returns 1 for success, 0 for failure.

### StringTable.AppendFromFile

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

```sql
EXEC sp_OAMethod @stringTable, 'AppendFromFile', @success OUT, @maxLineLen, @charset, @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 · sqlserver · StringTable · AppendFromSb · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @stringTable, 'AppendFromSb', @success OUT, @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 · sqlserver · StringTable · Clear · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @stringTable, 'Clear', NULL
```

Removes all the strings from the table.

### StringTable.FindMatch

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

```sql
EXEC sp_OAMethod @stringTable, 'FindMatch', @iResult OUT, @sb, @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 · sqlserver · StringTable · FindSubstring · method · since 9.5.0.77`

```sql
EXEC sp_OAMethod @stringTable, 'FindSubstring', @iResult OUT, @startIndex, @substr, @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 · sqlserver · StringTable · GetStrings · method · since 9.5.0.87`

```sql
EXEC sp_OAMethod @stringTable, 'GetStrings', @sResult OUT, @startIdx, @count, @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 · sqlserver · StringTable · IntAt · method · since 9.5.0.63`

```sql
EXEC sp_OAMethod @stringTable, 'IntAt', @iResult OUT, @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 · sqlserver · StringTable · SaveToFile · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @stringTable, 'SaveToFile', @success OUT, @charset, @bCrlf, @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 · sqlserver · StringTable · Sort · method · since 9.5.0.87`

```sql
EXEC sp_OAMethod @stringTable, 'Sort', @success OUT, @ascending, @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 · sqlserver · StringTable · SplitAndAppend · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @stringTable, 'SplitAndAppend', @success OUT, @inStr, @delimiterChar, @exceptDoubleQuoted, @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 · sqlserver · StringTable · StringAt · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @stringTable, 'StringAt', @sResult OUT, @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 · sqlserver · StringTable · StringAtSb · method · since 11.2.0`

```sql
EXEC sp_OAMethod @stringTable, 'StringAtSb', @success OUT, @index, @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 · sqlserver · StringTable · ToSb · method · since 11.3.0`

```sql
EXEC sp_OAMethod @stringTable, 'ToSb', @success OUT, @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 · sqlserver · StringTable · WordFollowing · method · since 11.1.0`

```sql
EXEC sp_OAMethod @stringTable, 'WordFollowing', @iResult OUT, @sb, @captureEmailAddr, @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/sqlserver/classes/StringBuilder.md)

