StringArray Unicode C Reference Documentation

StringArray

Current Version: 9.5.0.73

Class/object for managing and manipulating collections of strings. Contains an ordered collection 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.

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

top
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, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

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

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

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

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

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

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
BOOL CkStringArrayW_getLastMethodSuccess(HCkStringArrayW cHandle);
void CkStringArrayW_putLastMethodSuccess(HCkStringArrayW cHandle, BOOL newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Length
int CkStringArrayW_getLength(HCkStringArrayW cHandle);

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

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

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

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

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

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

top

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.

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

top
Clear
void CkStringArrayW_Clear(HCkStringArrayW cHandle);

Remove all strings from the internal collection.

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

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

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

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

top
GetStringLen
int CkStringArrayW_GetStringLen(HCkStringArrayW cHandle, int index);

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

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

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

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

Returns TRUE for success, FALSE for failure.

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

Returns TRUE for success, FALSE for failure.

top
LoadFromText
void CkStringArrayW_LoadFromText(HCkStringArrayW cHandle, const wchar_t *str);

Loads strings from an in-memory string (one per line) into the internal collection.

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

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

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

Adds a string to the beginning of the internal collection.

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

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

top
RemoveAt
BOOL CkStringArrayW_RemoveAt(HCkStringArrayW cHandle, int index);

Removes the string at a particular index.

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

top
SaveLastError
BOOL CkStringArrayW_SaveLastError(HCkStringArrayW cHandle, const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

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

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

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

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

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

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

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

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

top
Subtract
void CkStringArrayW_Subtract(HCkStringArrayW cHandle, HCkStringArrayW stringArrayObj);

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

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

top