StringArray Unicode C Reference Documentation

StringArray

Current Version: 10.1.2

Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.

Important: The Chilkat StringTable class is a better choice for a large number of strings.

Create/Dispose

HCkStringArrayW instance = CkStringArrayW_Create();
// ...
CkStringArrayW_Dispose(instance);

HCkStringArrayW CkStringArrayW_Create(void);

Creates an instance of the HCkStringArrayW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkStringArrayW_Dispose(HCkStringArrayW handle);

Objects created by calling CkStringArrayW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkStringArrayW_Dispose.

Properties

Count

int CkStringArrayW_getCount(HCkStringArrayW cHandle);

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.

Crlf

BOOL CkStringArrayW_getCrlf(HCkStringArrayW cHandle);
void CkStringArrayW_putCrlf(HCkStringArrayW cHandle, 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.

DebugLogFilePath

void CkStringArrayW_getDebugLogFilePath(HCkStringArrayW cHandle, HCkString retval);
void CkStringArrayW_putDebugLogFilePath(HCkStringArrayW cHandle, const wchar_t *newVal);
const wchar_t *CkStringArrayW_debugLogFilePath(HCkStringArrayW cHandle);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

void CkStringArrayW_getLastErrorHtml(HCkStringArrayW cHandle, HCkString retval);
const wchar_t *CkStringArrayW_lastErrorHtml(HCkStringArrayW cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

void CkStringArrayW_getLastErrorText(HCkStringArrayW cHandle, HCkString retval);
const wchar_t *CkStringArrayW_lastErrorText(HCkStringArrayW cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkStringArrayW_getLastErrorXml(HCkStringArrayW cHandle, HCkString retval);
const wchar_t *CkStringArrayW_lastErrorXml(HCkStringArrayW cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

BOOL CkStringArrayW_getLastMethodSuccess(HCkStringArrayW cHandle);
void CkStringArrayW_putLastMethodSuccess(HCkStringArrayW cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

Length

int CkStringArrayW_getLength(HCkStringArrayW cHandle);

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

Trim

BOOL CkStringArrayW_getTrim(HCkStringArrayW cHandle);
void CkStringArrayW_putTrim(HCkStringArrayW cHandle, 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.

Unique

BOOL CkStringArrayW_getUnique(HCkStringArrayW cHandle);
void CkStringArrayW_putUnique(HCkStringArrayW cHandle, 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.

VerboseLogging

BOOL CkStringArrayW_getVerboseLogging(HCkStringArrayW cHandle);
void CkStringArrayW_putVerboseLogging(HCkStringArrayW cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

void CkStringArrayW_getVersion(HCkStringArrayW cHandle, HCkString retval);
const wchar_t *CkStringArrayW_version(HCkStringArrayW cHandle);

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Append

BOOL CkStringArrayW_Append(HCkStringArrayW cHandle, const wchar_t *str);

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

Returns TRUE for success, FALSE for failure.

AppendSerialized

BOOL CkStringArrayW_AppendSerialized(HCkStringArrayW cHandle, 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.

Clear

void CkStringArrayW_Clear(HCkStringArrayW cHandle);

Remove all strings from the internal collection.

Contains

BOOL CkStringArrayW_Contains(HCkStringArrayW cHandle, const wchar_t *str);

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

Find

int CkStringArrayW_Find(HCkStringArrayW cHandle, 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.

FindFirstMatch

int CkStringArrayW_FindFirstMatch(HCkStringArrayW cHandle, 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.

GetString

BOOL CkStringArrayW_GetString(HCkStringArrayW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkStringArrayW_getString(HCkStringArrayW cHandle, 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.

GetStringLen

int CkStringArrayW_GetStringLen(HCkStringArrayW cHandle, int index);

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

InsertAt

void CkStringArrayW_InsertAt(HCkStringArrayW cHandle, 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.

LastString

BOOL CkStringArrayW_LastString(HCkStringArrayW cHandle, const wchar_t *outStr);
const wchar_t *CkStringArrayW_lastString(HCkStringArrayW cHandle);

Returns the last string in the internal collection.

Returns TRUE for success, FALSE for failure.

LoadFromFile

BOOL CkStringArrayW_LoadFromFile(HCkStringArrayW cHandle, 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.

LoadFromFile2

BOOL CkStringArrayW_LoadFromFile2(HCkStringArrayW cHandle, 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.

LoadFromText

void CkStringArrayW_LoadFromText(HCkStringArrayW cHandle, 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.

LoadTaskResult

BOOL CkStringArrayW_LoadTaskResult(HCkStringArrayW cHandle, HCkTaskW task);

Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.

Pop

BOOL CkStringArrayW_Pop(HCkStringArrayW cHandle, const wchar_t *outStr);
const wchar_t *CkStringArrayW_pop(HCkStringArrayW cHandle);

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

Returns TRUE for success, FALSE for failure.

Prepend

void CkStringArrayW_Prepend(HCkStringArrayW cHandle, const wchar_t *str);

Adds a string to the beginning of the internal collection.

Remove

void CkStringArrayW_Remove(HCkStringArrayW cHandle, const wchar_t *str);

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

RemoveAt

BOOL CkStringArrayW_RemoveAt(HCkStringArrayW cHandle, int index);

Removes the string at a particular index.

ReplaceAt

void CkStringArrayW_ReplaceAt(HCkStringArrayW cHandle, int index, const wchar_t *str);

Introduced in version 9.5.0.52

Replaces the string at a specified index.

SaveNthToFile

BOOL CkStringArrayW_SaveNthToFile(HCkStringArrayW cHandle, int index, const wchar_t *saveToPath);

Saves the Nth string in the collection to a file.

Returns TRUE for success, FALSE for failure.

SaveToFile

BOOL CkStringArrayW_SaveToFile(HCkStringArrayW cHandle, 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.

SaveToFile2

BOOL CkStringArrayW_SaveToFile2(HCkStringArrayW cHandle, 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.

SaveToText

BOOL CkStringArrayW_SaveToText(HCkStringArrayW cHandle, const wchar_t *outStr);
const wchar_t *CkStringArrayW_saveToText(HCkStringArrayW cHandle);

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

Returns TRUE for success, FALSE for failure.

Serialize

BOOL CkStringArrayW_Serialize(HCkStringArrayW cHandle, const wchar_t *outStr);
const wchar_t *CkStringArrayW_serialize(HCkStringArrayW cHandle);

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.

Sort

void CkStringArrayW_Sort(HCkStringArrayW cHandle, 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.

SplitAndAppend

void CkStringArrayW_SplitAndAppend(HCkStringArrayW cHandle, 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.

StrAt

BOOL CkStringArrayW_StrAt(HCkStringArrayW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkStringArrayW_strAt(HCkStringArrayW cHandle, int index);

Returns the string at a specific index.

Returns TRUE for success, FALSE for failure.

Subtract

void CkStringArrayW_Subtract(HCkStringArrayW cHandle, HCkStringArrayW stringArrayObj);

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

Union

void CkStringArrayW_Union(HCkStringArrayW cHandle, HCkStringArrayW 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.