StringTable Unicode C Reference Documentation

StringTable

Current Version: 9.5.0.73

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

HCkStringTableW instance = CkStringTableW_Create();
// ...
CkStringTableW_Dispose(instance);
HCkStringTableW CkStringTableW_Create(void);

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

void CkStringTableW_Dispose(HCkStringTableW handle);

Objects created by calling CkStringTableW_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 CkStringTableW_Dispose.

Properties

Count
int CkStringTableW_getCount(HCkStringTableW cHandle);
Introduced in version 9.5.0.62

The number of strings in the table.

top
DebugLogFilePath
void CkStringTableW_getDebugLogFilePath(HCkStringTableW cHandle, HCkString retval);
void CkStringTableW_putDebugLogFilePath(HCkStringTableW cHandle, const wchar_t *newVal);
const wchar_t *CkStringTableW_debugLogFilePath(HCkStringTableW 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 CkStringTableW_getLastErrorHtml(HCkStringTableW cHandle, HCkString retval);
const wchar_t *CkStringTableW_lastErrorHtml(HCkStringTableW 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 CkStringTableW_getLastErrorText(HCkStringTableW cHandle, HCkString retval);
const wchar_t *CkStringTableW_lastErrorText(HCkStringTableW 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 CkStringTableW_getLastErrorXml(HCkStringTableW cHandle, HCkString retval);
const wchar_t *CkStringTableW_lastErrorXml(HCkStringTableW 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 CkStringTableW_getLastMethodSuccess(HCkStringTableW cHandle);
void CkStringTableW_putLastMethodSuccess(HCkStringTableW 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
VerboseLogging
BOOL CkStringTableW_getVerboseLogging(HCkStringTableW cHandle);
void CkStringTableW_putVerboseLogging(HCkStringTableW 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 CkStringTableW_getVersion(HCkStringTableW cHandle, HCkString retval);
const wchar_t *CkStringTableW_version(HCkStringTableW cHandle);

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

top

Methods

Append
BOOL CkStringTableW_Append(HCkStringTableW cHandle, const wchar_t *value);
Introduced in version 9.5.0.62

Appends a string to the table.

Returns TRUE for success, FALSE for failure.

top
AppendFromFile
BOOL CkStringTableW_AppendFromFile(HCkStringTableW cHandle, int maxLineLen, const wchar_t *charset, const wchar_t *path);
Introduced in version 9.5.0.62

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.

top
AppendFromSb
BOOL CkStringTableW_AppendFromSb(HCkStringTableW cHandle, HCkStringBuilderW sb);
Introduced in version 9.5.0.62

Appends strings, one per line, from the contents of a StringBuilder object.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
Clear
void CkStringTableW_Clear(HCkStringTableW cHandle);
Introduced in version 9.5.0.62

Removes all the strings from the table.

top
IntAt
int CkStringTableW_IntAt(HCkStringTableW cHandle, int index);
Introduced in version 9.5.0.63

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.

top
SaveLastError
BOOL CkStringTableW_SaveLastError(HCkStringTableW 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
SaveToFile
BOOL CkStringTableW_SaveToFile(HCkStringTableW cHandle, const wchar_t *charset, BOOL bCrlf, const wchar_t *path);
Introduced in version 9.5.0.62

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.

top
SplitAndAppend
BOOL CkStringTableW_SplitAndAppend(HCkStringTableW cHandle, const wchar_t *inStr, const wchar_t *delimiterChar, BOOL exceptDoubleQuoted, BOOL exceptEscaped);
Introduced in version 9.5.0.62

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.

More Information and Examples
top
StringAt
BOOL CkStringTableW_StringAt(HCkStringTableW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkStringTableW_stringAt(HCkStringTableW cHandle, int index);
Introduced in version 9.5.0.62

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