StringArray 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

HCkStringArray instance = CkStringArray_Create();
// ...
CkStringArray_Dispose(instance);
HCkStringArray CkStringArray_Create(void);

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

void CkStringArray_Dispose(HCkStringArray handle);

Objects created by calling CkStringArray_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 CkStringArray_Dispose.

Properties

Count
int CkStringArray_getCount(HCkStringArray 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 CkStringArray_getCrlf(HCkStringArray cHandle);
void CkStringArray_putCrlf(HCkStringArray 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 CkStringArray_getDebugLogFilePath(HCkStringArray cHandle, HCkString retval);
void CkStringArray_putDebugLogFilePath(HCkStringArray cHandle, const char *newVal);
const char *CkStringArray_debugLogFilePath(HCkStringArray 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 CkStringArray_getLastErrorHtml(HCkStringArray cHandle, HCkString retval);
const char *CkStringArray_lastErrorHtml(HCkStringArray 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 CkStringArray_getLastErrorText(HCkStringArray cHandle, HCkString retval);
const char *CkStringArray_lastErrorText(HCkStringArray 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 CkStringArray_getLastErrorXml(HCkStringArray cHandle, HCkString retval);
const char *CkStringArray_lastErrorXml(HCkStringArray 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 CkStringArray_getLastMethodSuccess(HCkStringArray cHandle);
void CkStringArray_putLastMethodSuccess(HCkStringArray 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 CkStringArray_getLength(HCkStringArray cHandle);

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

top
Trim
BOOL CkStringArray_getTrim(HCkStringArray cHandle);
void CkStringArray_putTrim(HCkStringArray 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 CkStringArray_getUnique(HCkStringArray cHandle);
void CkStringArray_putUnique(HCkStringArray 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
Utf8
BOOL CkStringArray_getUtf8(HCkStringArray cHandle);
void CkStringArray_putUtf8(HCkStringArray cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkStringArray_getVerboseLogging(HCkStringArray cHandle);
void CkStringArray_putVerboseLogging(HCkStringArray 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 CkStringArray_getVersion(HCkStringArray cHandle, HCkString retval);
const char *CkStringArray_version(HCkStringArray cHandle);

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

top

Methods

Append
BOOL CkStringArray_Append(HCkStringArray cHandle, const char *str);

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

Returns TRUE for success, FALSE for failure.

top
AppendSerialized
BOOL CkStringArray_AppendSerialized(HCkStringArray cHandle, const char *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 CkStringArray_Clear(HCkStringArray cHandle);

Remove all strings from the internal collection.

top
Contains
BOOL CkStringArray_Contains(HCkStringArray cHandle, const char *str);

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

top
Find
int CkStringArray_Find(HCkStringArray cHandle, const char *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 CkStringArray_FindFirstMatch(HCkStringArray cHandle, const char *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 CkStringArray_GetString(HCkStringArray cHandle, int index, HCkString outStr);
const char *CkStringArray_getString(HCkStringArray 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 CkStringArray_GetStringLen(HCkStringArray cHandle, int index);

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

top
InsertAt
void CkStringArray_InsertAt(HCkStringArray cHandle, int index, const char *str);

Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.

top
LastString
BOOL CkStringArray_LastString(HCkStringArray cHandle, HCkString outStr);
const char *CkStringArray_lastString(HCkStringArray cHandle);

Returns the last string in the internal collection.

Returns TRUE for success, FALSE for failure.

top
LoadFromFile
BOOL CkStringArray_LoadFromFile(HCkStringArray cHandle, const char *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 CkStringArray_LoadFromFile2(HCkStringArray cHandle, const char *path, const char *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 CkStringArray_LoadFromText(HCkStringArray cHandle, const char *str);

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

top
LoadTaskResult
BOOL CkStringArray_LoadTaskResult(HCkStringArray cHandle, HCkTask 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 CkStringArray_Pop(HCkStringArray cHandle, HCkString outStr);
const char *CkStringArray_pop(HCkStringArray cHandle);

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

Returns TRUE for success, FALSE for failure.

top
Prepend
void CkStringArray_Prepend(HCkStringArray cHandle, const char *str);

Adds a string to the beginning of the internal collection.

top
Remove
void CkStringArray_Remove(HCkStringArray cHandle, const char *str);

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

top
RemoveAt
BOOL CkStringArray_RemoveAt(HCkStringArray cHandle, int index);

Removes the string at a particular index.

top
ReplaceAt
void CkStringArray_ReplaceAt(HCkStringArray cHandle, int index, const char *str);
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveLastError
BOOL CkStringArray_SaveLastError(HCkStringArray cHandle, const char *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 CkStringArray_SaveNthToFile(HCkStringArray cHandle, int index, const char *saveToPath);

Saves the Nth string in the collection to a file.

Returns TRUE for success, FALSE for failure.

top
SaveToFile
BOOL CkStringArray_SaveToFile(HCkStringArray cHandle, const char *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 CkStringArray_SaveToFile2(HCkStringArray cHandle, const char *saveToPath, const char *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 CkStringArray_SaveToText(HCkStringArray cHandle, HCkString outStr);
const char *CkStringArray_saveToText(HCkStringArray 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 CkStringArray_Serialize(HCkStringArray cHandle, HCkString outStr);
const char *CkStringArray_serialize(HCkStringArray 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 CkStringArray_Sort(HCkStringArray 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 CkStringArray_SplitAndAppend(HCkStringArray cHandle, const char *str, const char *boundary);

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

top
StrAt
BOOL CkStringArray_StrAt(HCkStringArray cHandle, int index, HCkString outStr);
const char *CkStringArray_strAt(HCkStringArray cHandle, int index);

Returns the string at a specific index.

Returns TRUE for success, FALSE for failure.

top
Subtract
void CkStringArray_Subtract(HCkStringArray cHandle, HCkStringArray stringArrayObj);

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

top
Union
void CkStringArray_Union(HCkStringArray cHandle, HCkStringArray 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