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

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

```powerbuilder
oleobject loo_StringArray
integer li_rc

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

// ... use loo_StringArray ...

destroy loo_StringArray
```

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.StringArray.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)` |
| `Crlf` | property, read/write | `long Crlf` |
| `Length` | property, read-only | `long Length (read-only)` |
| `Trim` | property, read/write | `long Trim` |
| `Unique` | property, read/write | `long Unique` |
| `Append` | method | `long Append(string str)` |
| `AppendSerialized` | method | `long AppendSerialized(string encodedStr)` |
| `Clear` | method | `Clear()` |
| `Contains` | method | `long Contains(string str)` |
| `Find` | method | `long Find(string findStr, long startIndex)` |
| `FindFirstMatch` | method | `long FindFirstMatch(string matchPattern, long startIndex)` |
| `GetString` | method | `string GetString(long index)` |
| `InsertAt` | method | `InsertAt(long index, string str)` |
| `LastString` | method | `string LastString()` |
| `LoadFromFile` | method | `long LoadFromFile(string path)` |
| `LoadFromFile2` | method | `long LoadFromFile2(string path, string charset)` |
| `LoadFromText` | method | `LoadFromText(string str)` |
| `LoadTaskResult` | method | `long LoadTaskResult(ChilkatTask task)` |
| `Pop` | method | `string Pop()` |
| `Prepend` | method | `Prepend(string str)` |
| `Remove` | method | `Remove(string str)` |
| `RemoveAt` | method | `long RemoveAt(long index)` |
| `ReplaceAt` | method | `ReplaceAt(long index, string str)` |
| `SaveNthToFile` | method | `long SaveNthToFile(long index, string saveToPath)` |
| `SaveToFile` | method | `long SaveToFile(string path)` |
| `SaveToFile2` | method | `long SaveToFile2(string saveToPath, string charset)` |
| `SaveToText` | method | `string SaveToText()` |
| `Serialize` | method | `string Serialize()` |
| `Sort` | method | `Sort(long ascending)` |
| `SplitAndAppend` | method | `SplitAndAppend(string str, string boundary)` |
| `Subtract` | method | `Subtract(CkStringArray stringArrayObj)` |
| `Union` | method | `Union(CkStringArray stringArrayObj)` |

## Properties

### StringArray.Count

`Chilkat 11.7.0 · powerbuilder · StringArray · Count · property · read-only`

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

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 · powerbuilder · StringArray · Crlf · property · read/write`

```powerbuilder
long Crlf
```

If `1`, strings are always automatically converted to use CRLF line endings. If `0`, strings are automatically converted to use bare LF line endings.

### StringArray.Length

`Chilkat 11.7.0 · powerbuilder · StringArray · Length · property · read-only`

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

The number of strings contained within the internal collection. (Identical to the Count property.)

### StringArray.Trim

`Chilkat 11.7.0 · powerbuilder · StringArray · Trim · property · read/write`

```powerbuilder
long Trim
```

If `1`, 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 · powerbuilder · StringArray · Unique · property · read/write`

```powerbuilder
long Unique
```

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

## Methods

### StringArray.Append

`Chilkat 11.7.0 · powerbuilder · StringArray · Append · method`

```powerbuilder
long Append(string str)
```

Appends a string to the end of the internal ordered collection.

Returns 1 for success, 0 for failure.

### StringArray.AppendSerialized

`Chilkat 11.7.0 · powerbuilder · StringArray · AppendSerialized · method`

```powerbuilder
long AppendSerialized(string encodedStr)
```

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.

### StringArray.Clear

`Chilkat 11.7.0 · powerbuilder · StringArray · Clear · method`

```powerbuilder
Clear()
```

Remove all strings from the internal collection.

### StringArray.Contains

`Chilkat 11.7.0 · powerbuilder · StringArray · Contains · method`

```powerbuilder
long Contains(string str)
```

Returns `1` if the string is present in the internal collection. The string comparisons are case sensitive.

### StringArray.Find

`Chilkat 11.7.0 · powerbuilder · StringArray · Find · method`

```powerbuilder
long Find(string findStr, long startIndex)
```

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 · powerbuilder · StringArray · FindFirstMatch · method`

```powerbuilder
long FindFirstMatch(string matchPattern, long startIndex)
```

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 · powerbuilder · StringArray · GetString · method`

```powerbuilder
string GetString(long index)
```

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 · powerbuilder · StringArray · InsertAt · method`

```powerbuilder
InsertAt(long 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 · powerbuilder · StringArray · LastString · method`

```powerbuilder
string LastString()
```

Returns the last string in the internal collection.

Returns `null` on failure

### StringArray.LoadFromFile

`Chilkat 11.7.0 · powerbuilder · StringArray · LoadFromFile · method`

```powerbuilder
long LoadFromFile(string path)
```

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.

### StringArray.LoadFromFile2

`Chilkat 11.7.0 · powerbuilder · StringArray · LoadFromFile2 · method`

```powerbuilder
long LoadFromFile2(string path, string charset)
```

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.

### StringArray.LoadFromText

`Chilkat 11.7.0 · powerbuilder · StringArray · LoadFromText · method`

```powerbuilder
LoadFromText(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 · powerbuilder · StringArray · LoadTaskResult · method · since 9.5.0.52`

```powerbuilder
long LoadTaskResult(ChilkatTask task)
```

Loads the string collection from a completed asynchronous task.

Returns 1 for success, 0 for failure.

### StringArray.Pop

`Chilkat 11.7.0 · powerbuilder · StringArray · Pop · method`

```powerbuilder
string Pop()
```

Returns the last string and removes it from the internal collection.

Returns `null` on failure

### StringArray.Prepend

`Chilkat 11.7.0 · powerbuilder · StringArray · Prepend · method`

```powerbuilder
Prepend(string str)
```

Adds a string to the beginning of the internal collection.

### StringArray.Remove

`Chilkat 11.7.0 · powerbuilder · StringArray · Remove · method`

```powerbuilder
Remove(string str)
```

Removes all strings equal to the string argument from the internal collection.

### StringArray.RemoveAt

`Chilkat 11.7.0 · powerbuilder · StringArray · RemoveAt · method`

```powerbuilder
long RemoveAt(long index)
```

Removes the string at a particular index.

Returns 1 for success, 0 for failure.

### StringArray.ReplaceAt

`Chilkat 11.7.0 · powerbuilder · StringArray · ReplaceAt · method · since 9.5.0.52`

```powerbuilder
ReplaceAt(long index, string str)
```

Replaces the string at a specified index.

### StringArray.SaveNthToFile

`Chilkat 11.7.0 · powerbuilder · StringArray · SaveNthToFile · method`

```powerbuilder
long SaveNthToFile(long index, string saveToPath)
```

Saves the Nth string in the collection to a file.

Returns 1 for success, 0 for failure.

### StringArray.SaveToFile

`Chilkat 11.7.0 · powerbuilder · StringArray · SaveToFile · method`

```powerbuilder
long SaveToFile(string path)
```

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.

### StringArray.SaveToFile2

`Chilkat 11.7.0 · powerbuilder · StringArray · SaveToFile2 · method`

```powerbuilder
long SaveToFile2(string saveToPath, string charset)
```

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.

### StringArray.SaveToText

`Chilkat 11.7.0 · powerbuilder · StringArray · SaveToText · method`

```powerbuilder
string SaveToText()
```

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 · powerbuilder · StringArray · Serialize · method`

```powerbuilder
string Serialize()
```

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 · powerbuilder · StringArray · Sort · method`

```powerbuilder
Sort(long ascending)
```

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

### StringArray.SplitAndAppend

`Chilkat 11.7.0 · powerbuilder · StringArray · SplitAndAppend · method`

```powerbuilder
SplitAndAppend(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 · powerbuilder · StringArray · Subtract · method`

```powerbuilder
Subtract(CkStringArray stringArrayObj)
```

Subtracts the strings contained within `stringArrayObj` from the caller's internal collection.

### StringArray.Union

`Chilkat 11.7.0 · powerbuilder · StringArray · Union · method`

```powerbuilder
Union(CkStringArray 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/powerbuilder/classes/Task.md)

