StringTable C Reference Documentation
StringTable
Current Version: 10.1.0
A memory efficient class for holding a large number of strings (accessible by index). The primary use is as a read-only table of strings that is built once and then used by the application.
This class is introduced in Chilkat v9.5.0.62.
Create/Dispose
HCkStringTable instance = CkStringTable_Create(); // ... CkStringTable_Dispose(instance);
Creates an instance of the HCkStringTable 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 CkStringTable_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 CkStringTable_Dispose.
Properties
Count
The number of strings in the table.
topDebugLogFilePath
void CkStringTable_putDebugLogFilePath(HCkStringTable cHandle, const char *newVal);
const char *CkStringTable_debugLogFilePath(HCkStringTable 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 *CkStringTable_lastErrorHtml(HCkStringTable 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 *CkStringTable_lastErrorText(HCkStringTable 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 *CkStringTable_lastErrorXml(HCkStringTable 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 CkStringTable_putLastMethodSuccess(HCkStringTable 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.
topUtf8
void CkStringTable_putUtf8(HCkStringTable 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 CkStringTable_putVerboseLogging(HCkStringTable 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 *CkStringTable_version(HCkStringTable cHandle);
Methods
Append
AppendFromFile
Appends strings, one per line, from a file. Each line in the path should be no longer than the length specified in maxLineLen. The charset indicates the character encoding of the contents of the file, such as "utf-8", "iso-8859-1", "Shift_JIS", etc.
Returns TRUE for success, FALSE for failure.
topAppendFromSb
Appends strings, one per line, from the contents of a StringBuilder object.
Returns TRUE for success, FALSE for failure.
Clear
Removes all the strings from the table.
topFindSubstring
Return the index of the first string in the table containing substr. Begins searching strings starting at startIndex. If caseSensitive is TRUE, then the search is case sensitive. If caseSensitive is FALSE then the search is case insensitive. Returns -1 if the substr is not found.
topGetStrings
const char *CkStringTable_getStrings(HCkStringTable cHandle, int startIdx, int count, BOOL crlf);
Return the number of strings specified by count, one per line, starting at startIdx. To return the entire table, pass 0 values for both startIdx and count. Set crlf equal to TRUE to emit with CRLF line endings, or FALSE to emit LF-only line endings. The last string is emitted includes the line ending.
Returns TRUE for success, FALSE for failure.
topIntAt
Returns the Nth string in the table, converted to an integer value. The index is 0-based. (The first string is at index 0.) Returns -1 if no string is found at the specified index. Returns 0 if the string at the specified index exist, but is not an integer.
topSaveToFile
Saves the string table to a file. The charset is the character encoding to use, such as "utf-8", "iso-8859-1", "windows-1252", "Shift_JIS", "gb2312", etc. If bCrlf is TRUE, then CRLF line endings are used, otherwise LF-only line endings are used.
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.
Returns TRUE for success, FALSE for failure.
topSplitAndAppend
Splits a string into parts based on a single character delimiterChar. If exceptDoubleQuoted is TRUE, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is TRUE, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns TRUE for success, FALSE for failure.
StringAt
const char *CkStringTable_stringAt(HCkStringTable cHandle, int index);
Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)
Returns TRUE for success, FALSE for failure.
top