StringArray C Reference Documentation
StringArray
Current Version: 9.5.0.98
Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.
Create/Dispose
HCkStringArray instance = CkStringArray_Create(); // ... CkStringArray_Dispose(instance);
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.
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
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.
topCrlf
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.
topDebugLogFilePath
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
void CkStringArray_putLastMethodSuccess(HCkStringArray cHandle, BOOL newVal);
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.
topLength
The number of strings contained within the internal collection. (Identical to the Count property.)
topTrim
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.
topUnique
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.
topUtf8
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.
topVerboseLogging
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.
topVersion
const char *CkStringArray_version(HCkStringArray cHandle);
Methods
Append
Appends a string to the end of the internal ordered collection.
Returns TRUE for success, FALSE for failure.
topAppendSerialized
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.
topClear
Remove all strings from the internal collection.
topContains
Returns TRUE if the string is present in the internal collection. The string comparisons are case sensitive.
topFind
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.
topFindFirstMatch
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.
topGetString
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.
topGetStringLen
Returns Nth string's length, in characters. The first string is located at index 0.
topInsertAt
Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.
topLastString
const char *CkStringArray_lastString(HCkStringArray cHandle);
LoadFromFile
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.
topLoadFromFile2
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.
topLoadFromText
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.
topLoadTaskResult
Loads the string collection from a completed asynchronous task.
Returns TRUE for success, FALSE for failure.
topPop
const char *CkStringArray_pop(HCkStringArray cHandle);
Returns the last string and removes it from the internal collection.
Returns TRUE for success, FALSE for failure.
topPrepend
Adds a string to the beginning of the internal collection.
topRemove
Removes all strings equal to the string argument from the internal collection.
topRemoveAt
Removes the string at a particular index.
topReplaceAt
Replaces the string at a specified index.
topSaveNthToFile
SaveToFile
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.
topSaveToFile2
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.
topSaveToText
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.
topSerialize
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.
topSort
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.
topSplitAndAppend
Splits a string at a character or substring boundary and adds each resulting string to the internal collection.
topStrAt
const char *CkStringArray_strAt(HCkStringArray cHandle, int index);
Subtract
Subtracts the strings contained within stringArrayObj from the caller's internal collection.
topUnion
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