---
product: Chilkat
product_version: 11.7.0
language: wcpp
language_label: Unicode C++
class: StringArray
class_name: CkStringArrayW
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wcppCkStringArrayWRef.html
---
# Chilkat StringArray — Unicode C++ — v11.7.0

> Chilkat 11.7.0 · language=wcpp · class=StringArray (CkStringArrayW)
> 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/wcpp/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**

```cpp
// Local variable on the stack
CkStringArrayW obj;

// Dynamically allocate/delete
CkStringArrayW *pObj = new CkStringArrayW();
// ...
delete pObj;
```

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 Unicode C++.

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` | `void get_DebugLogFilePath(CkString &str); const wchar_t *debugLogFilePath(void); void put_DebugLogFilePath(const wchar_t *str);` | 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` | `void get_LastErrorHtml(CkString &str); const wchar_t *lastErrorHtml(void);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void get_LastErrorText(CkString &str); const wchar_t *lastErrorText(void);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void get_LastErrorXml(CkString &str); const wchar_t *lastErrorXml(void);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess(void); void put_LastMethodSuccess(bool newVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `bool get_VerboseLogging(void); void put_VerboseLogging(bool newVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void get_Version(CkString &str); const wchar_t *version(void);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Count` | property, read-only | `int get_Count(void);` |
| `Crlf` | property, read/write | `bool get_Crlf(void); void put_Crlf(bool newVal);` |
| `Length` | property, read-only | `int get_Length(void);` |
| `Trim` | property, read/write | `bool get_Trim(void); void put_Trim(bool newVal);` |
| `Unique` | property, read/write | `bool get_Unique(void); void put_Unique(bool newVal);` |
| `Append` | method | `bool Append(const wchar_t *str);` |
| `AppendSerialized` | method | `bool AppendSerialized(const wchar_t *encodedStr);` |
| `Clear` | method | `void Clear(void);` |
| `Contains` | method | `bool Contains(const wchar_t *str);` |
| `Find` | method | `int Find(const wchar_t *findStr, int startIndex);` |
| `FindFirstMatch` | method | `int FindFirstMatch(const wchar_t *matchPattern, int startIndex);` |
| `GetString` | method | `bool GetString(int index, CkString &outStr); const wchar_t *getString(int index);` |
| `GetStringLen` | method | `int GetStringLen(int index);` |
| `InsertAt` | method | `void InsertAt(int index, const wchar_t *str);` |
| `LastString` | method | `bool LastString(CkString &outStr); const wchar_t *lastString(void);` |
| `LoadFromFile` | method | `bool LoadFromFile(const wchar_t *path);` |
| `LoadFromFile2` | method | `bool LoadFromFile2(const wchar_t *path, const wchar_t *charset);` |
| `LoadFromText` | method | `void LoadFromText(const wchar_t *str);` |
| `LoadTaskResult` | method | `bool LoadTaskResult(CkTaskW &task);` |
| `Pop` | method | `bool Pop(CkString &outStr); const wchar_t *pop(void);` |
| `Prepend` | method | `void Prepend(const wchar_t *str);` |
| `Remove` | method | `void Remove(const wchar_t *str);` |
| `RemoveAt` | method | `bool RemoveAt(int index);` |
| `ReplaceAt` | method | `void ReplaceAt(int index, const wchar_t *str);` |
| `SaveNthToFile` | method | `bool SaveNthToFile(int index, const wchar_t *saveToPath);` |
| `SaveToFile` | method | `bool SaveToFile(const wchar_t *path);` |
| `SaveToFile2` | method | `bool SaveToFile2(const wchar_t *saveToPath, const wchar_t *charset);` |
| `SaveToText` | method | `bool SaveToText(CkString &outStr); const wchar_t *saveToText(void);` |
| `Serialize` | method | `bool Serialize(CkString &outStr); const wchar_t *serialize(void);` |
| `Sort` | method | `void Sort(bool ascending);` |
| `SplitAndAppend` | method | `void SplitAndAppend(const wchar_t *str, const wchar_t *boundary);` |
| `StrAt` | method | `bool StrAt(int index, CkString &outStr); const wchar_t *strAt(int index);` |
| `Subtract` | method | `void Subtract(CkStringArrayW &stringArrayObj);` |
| `Union` | method | `void Union(CkStringArrayW &stringArrayObj);` |

## Properties

### StringArray.Count

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

```cpp
int get_Count(void);
```

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

```cpp
bool get_Crlf(void);

void put_Crlf(bool newVal);
```

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

```cpp
int get_Length(void);
```

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

### StringArray.Trim

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

```cpp
bool get_Trim(void);

void put_Trim(bool newVal);
```

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

```cpp
bool get_Unique(void);

void put_Unique(bool newVal);
```

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

```cpp
bool Append(const wchar_t *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 · wcpp · StringArray · AppendSerialized · method`

```cpp
bool AppendSerialized(const wchar_t *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 · wcpp · StringArray · Clear · method`

```cpp
void Clear(void);
```

Remove all strings from the internal collection.

### StringArray.Contains

`Chilkat 11.7.0 · wcpp · StringArray · Contains · method`

```cpp
bool Contains(const wchar_t *str);
```

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

### StringArray.Find

`Chilkat 11.7.0 · wcpp · StringArray · Find · method`

```cpp
int Find(const wchar_t *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 · wcpp · StringArray · FindFirstMatch · method`

```cpp
int FindFirstMatch(const wchar_t *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 · wcpp · StringArray · GetString · method`

```cpp
bool GetString(int index, CkString &outStr);

const wchar_t *getString(int index);
```

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

Returns true for success, false for failure.

### StringArray.GetStringLen

`Chilkat 11.7.0 · wcpp · StringArray · GetStringLen · method`

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

```cpp
void InsertAt(int index, const wchar_t *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 · wcpp · StringArray · LastString · method`

```cpp
bool LastString(CkString &outStr);

const wchar_t *lastString(void);
```

Returns the last string in the internal collection.

Returns true for success, false for failure.

### StringArray.LoadFromFile

`Chilkat 11.7.0 · wcpp · StringArray · LoadFromFile · method`

```cpp
bool LoadFromFile(const wchar_t *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 · wcpp · StringArray · LoadFromFile2 · method`

```cpp
bool LoadFromFile2(const wchar_t *path, const wchar_t *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 · wcpp · StringArray · LoadFromText · method`

```cpp
void LoadFromText(const wchar_t *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 · wcpp · StringArray · LoadTaskResult · method · since 9.5.0.52`

```cpp
bool LoadTaskResult(CkTaskW &task);
```

Loads the string collection from a completed asynchronous task.

Returns true for success, false for failure.

### StringArray.Pop

`Chilkat 11.7.0 · wcpp · StringArray · Pop · method`

```cpp
bool Pop(CkString &outStr);

const wchar_t *pop(void);
```

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

Returns true for success, false for failure.

### StringArray.Prepend

`Chilkat 11.7.0 · wcpp · StringArray · Prepend · method`

```cpp
void Prepend(const wchar_t *str);
```

Adds a string to the beginning of the internal collection.

### StringArray.Remove

`Chilkat 11.7.0 · wcpp · StringArray · Remove · method`

```cpp
void Remove(const wchar_t *str);
```

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

### StringArray.RemoveAt

`Chilkat 11.7.0 · wcpp · StringArray · RemoveAt · method`

```cpp
bool RemoveAt(int index);
```

Removes the string at a particular index.

Returns true for success, false for failure.

### StringArray.ReplaceAt

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

```cpp
void ReplaceAt(int index, const wchar_t *str);
```

Replaces the string at a specified index.

### StringArray.SaveNthToFile

`Chilkat 11.7.0 · wcpp · StringArray · SaveNthToFile · method`

```cpp
bool SaveNthToFile(int index, const wchar_t *saveToPath);
```

Saves the Nth string in the collection to a file.

Returns true for success, false for failure.

### StringArray.SaveToFile

`Chilkat 11.7.0 · wcpp · StringArray · SaveToFile · method`

```cpp
bool SaveToFile(const wchar_t *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 · wcpp · StringArray · SaveToFile2 · method`

```cpp
bool SaveToFile2(const wchar_t *saveToPath, const wchar_t *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 · wcpp · StringArray · SaveToText · method`

```cpp
bool SaveToText(CkString &outStr);

const wchar_t *saveToText(void);
```

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

Returns true for success, false for failure.

### StringArray.Serialize

`Chilkat 11.7.0 · wcpp · StringArray · Serialize · method`

```cpp
bool Serialize(CkString &outStr);

const wchar_t *serialize(void);
```

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 true for success, false for failure.

### StringArray.Sort

`Chilkat 11.7.0 · wcpp · StringArray · Sort · method`

```cpp
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 · wcpp · StringArray · SplitAndAppend · method`

```cpp
void SplitAndAppend(const wchar_t *str, const wchar_t *boundary);
```

Splits a string at a character or substring boundary and adds each resulting string to the internal collection.

### StringArray.StrAt

`Chilkat 11.7.0 · wcpp · StringArray · StrAt · method`

```cpp
bool StrAt(int index, CkString &outStr);

const wchar_t *strAt(int index);
```

Returns the string at a specific index.

Returns true for success, false for failure.

### StringArray.Subtract

`Chilkat 11.7.0 · wcpp · StringArray · Subtract · method`

```cpp
void Subtract(CkStringArrayW &stringArrayObj);
```

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

### StringArray.Union

`Chilkat 11.7.0 · wcpp · StringArray · Union · method`

```cpp
void Union(CkStringArrayW &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/wcpp/classes/Task.md)