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

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

```python
obj = chilkat2.StringArray()
```

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

Minimal complete program:

```python
import chilkat2

# Required once per process. Any string unlocks a 30-day trial; use your purchased code in production.
glob = chilkat2.Global()
if not glob.UnlockBundle("Anything for 30-day trial"):
    print(glob.LastErrorText)
    raise SystemExit(1)

stringArray = chilkat2.StringArray()

success = stringArray.Append("<str>")
if not success:
    print(stringArray.LastErrorText)   # full diagnostic of what went wrong
    raise SystemExit(1)
```

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. |
| `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` | `bool LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `bool VerboseLogging` | read/write | If set to `True`, 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 | `int Count (read-only)` |
| `Crlf` | property, read/write | `bool Crlf` |
| `Length` | property, read-only | `int Length (read-only)` |
| `Trim` | property, read/write | `bool Trim` |
| `Unique` | property, read/write | `bool Unique` |
| `Append` | method | `bool Append(string str)` |
| `AppendSerialized` | method | `bool AppendSerialized(string encodedStr)` |
| `Clear` | method | `void Clear()` |
| `Contains` | method | `bool Contains(string str)` |
| `Find` | method | `int Find(string findStr, int startIndex)` |
| `FindFirstMatch` | method | `int FindFirstMatch(string matchPattern, int startIndex)` |
| `GetString` | method | `string GetString(int index)` |
| `GetStringLen` | method | `int GetStringLen(int index)` |
| `InsertAt` | method | `void InsertAt(int index, string str)` |
| `LastString` | method | `string LastString()` |
| `LoadFromFile` | method | `bool LoadFromFile(string path)` |
| `LoadFromFile2` | method | `bool LoadFromFile2(string path, string charset)` |
| `LoadFromText` | method | `void LoadFromText(string str)` |
| `LoadTaskResult` | method | `bool LoadTaskResult(Task task)` |
| `Pop` | method | `string Pop()` |
| `Prepend` | method | `void Prepend(string str)` |
| `Remove` | method | `void Remove(string str)` |
| `RemoveAt` | method | `bool RemoveAt(int index)` |
| `ReplaceAt` | method | `void ReplaceAt(int index, string str)` |
| `SaveNthToFile` | method | `bool SaveNthToFile(int index, string saveToPath)` |
| `SaveToFile` | method | `bool SaveToFile(string path)` |
| `SaveToFile2` | method | `bool SaveToFile2(string saveToPath, string charset)` |
| `SaveToText` | method | `string SaveToText()` |
| `Serialize` | method | `string Serialize()` |
| `Sort` | method | `void Sort(bool ascending)` |
| `SplitAndAppend` | method | `void SplitAndAppend(string str, string boundary)` |
| `Subtract` | method | `void Subtract(StringArray stringArrayObj)` |
| `Union` | method | `void Union(StringArray stringArrayObj)` |

## Properties

### StringArray.Count

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

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

```python
bool Crlf
```

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 · python · StringArray · Length · property · read-only`

```python
int Length (read-only)
```

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

### StringArray.Trim

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

```python
bool Trim
```

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 · python · StringArray · Unique · property · read/write`

```python
bool Unique
```

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 · python · StringArray · Append · method`

```python
bool Append(string str)
```

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

Returns True for success, False for failure.

### StringArray.AppendSerialized

`Chilkat 11.7.0 · python · StringArray · AppendSerialized · method`

```python
bool 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 True for success, False for failure.

### StringArray.Clear

`Chilkat 11.7.0 · python · StringArray · Clear · method`

```python
void Clear()
```

Remove all strings from the internal collection.

### StringArray.Contains

`Chilkat 11.7.0 · python · StringArray · Contains · method`

```python
bool Contains(string str)
```

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

### StringArray.Find

`Chilkat 11.7.0 · python · StringArray · Find · method`

```python
int Find(string findStr, int 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 · python · StringArray · FindFirstMatch · method`

```python
int FindFirstMatch(string matchPattern, int 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 · python · StringArray · GetString · method`

```python
string GetString(int index)
```

Returns the string at an indexed location within the internal collection. The first string is located at index 0.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### StringArray.GetStringLen

`Chilkat 11.7.0 · python · StringArray · GetStringLen · method`

```python
int GetStringLen(int index)
```

Returns Nth string's length, in characters. The first string is located at index 0.

### StringArray.InsertAt

`Chilkat 11.7.0 · python · StringArray · InsertAt · method`

```python
void InsertAt(int 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 · python · StringArray · LastString · method`

```python
string LastString()
```

Returns the last string in the internal collection.

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### StringArray.LoadFromFile

`Chilkat 11.7.0 · python · StringArray · LoadFromFile · method`

```python
bool 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 True for success, False for failure.

### StringArray.LoadFromFile2

`Chilkat 11.7.0 · python · StringArray · LoadFromFile2 · method`

```python
bool 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 True for success, False for failure.

### StringArray.LoadFromText

`Chilkat 11.7.0 · python · StringArray · LoadFromText · method`

```python
void 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 · python · StringArray · LoadTaskResult · method · since 9.5.0.52`

```python
bool LoadTaskResult(Task task)
```

Loads the string collection from a completed asynchronous task.

Returns True for success, False for failure.

### StringArray.Pop

`Chilkat 11.7.0 · python · StringArray · Pop · method`

```python
string Pop()
```

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

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### StringArray.Prepend

`Chilkat 11.7.0 · python · StringArray · Prepend · method`

```python
void Prepend(string str)
```

Adds a string to the beginning of the internal collection.

### StringArray.Remove

`Chilkat 11.7.0 · python · StringArray · Remove · method`

```python
void Remove(string str)
```

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

### StringArray.RemoveAt

`Chilkat 11.7.0 · python · StringArray · RemoveAt · method`

```python
bool RemoveAt(int index)
```

Removes the string at a particular index.

Returns True for success, False for failure.

### StringArray.ReplaceAt

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

```python
void ReplaceAt(int index, string str)
```

Replaces the string at a specified index.

### StringArray.SaveNthToFile

`Chilkat 11.7.0 · python · StringArray · SaveNthToFile · method`

```python
bool SaveNthToFile(int index, string saveToPath)
```

Saves the Nth string in the collection to a file.

Returns True for success, False for failure.

### StringArray.SaveToFile

`Chilkat 11.7.0 · python · StringArray · SaveToFile · method`

```python
bool 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 True for success, False for failure.

### StringArray.SaveToFile2

`Chilkat 11.7.0 · python · StringArray · SaveToFile2 · method`

```python
bool 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 True for success, False for failure.

### StringArray.SaveToText

`Chilkat 11.7.0 · python · StringArray · SaveToText · method`

```python
string SaveToText()
```

Writes the collection of strings to a single string, one per line (separated by CRLF line endings).

Returns an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### StringArray.Serialize

`Chilkat 11.7.0 · python · StringArray · Serialize · method`

```python
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 an empty string on failure. Check the `LastMethodSuccess` property to determine success or failure.

### StringArray.Sort

`Chilkat 11.7.0 · python · StringArray · Sort · method`

```python
void Sort(bool 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 · python · StringArray · SplitAndAppend · method`

```python
void 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 · python · StringArray · Subtract · method`

```python
void Subtract(StringArray stringArrayObj)
```

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

### StringArray.Union

`Chilkat 11.7.0 · python · StringArray · Union · method`

```python
void Union(StringArray 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/python/classes/Task.md)