CkStringTable Python Reference Documentation

CkStringTable

Current Version: 9.5.0.97

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.

Object Creation

obj = chilkat.CkStringTable()

Properties

Count
# intVal is an integer
intVal = stringTable.get_Count();
Introduced in version 9.5.0.62

The number of strings in the table.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
stringTable.get_DebugLogFilePath(ckStr);
strVal = stringTable.debugLogFilePath();
stringTable.put_DebugLogFilePath(strVal);

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
# strVal is a string
# ckStr is a CkString
stringTable.get_LastErrorHtml(ckStr);
strVal = stringTable.lastErrorHtml();

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
# strVal is a string
# ckStr is a CkString
stringTable.get_LastErrorText(ckStr);
strVal = stringTable.lastErrorText();

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
# strVal is a string
# ckStr is a CkString
stringTable.get_LastErrorXml(ckStr);
strVal = stringTable.lastErrorXml();

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
# boolVal is a boolean
boolVal = stringTable.get_LastMethodSuccess();
stringTable.put_LastMethodSuccess(boolVal);

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
Utf8
# boolVal is a boolean
boolVal = stringTable.get_Utf8();
stringTable.put_Utf8(boolVal);

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
# boolVal is a boolean
boolVal = stringTable.get_VerboseLogging();
stringTable.put_VerboseLogging(boolVal);

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
# strVal is a string
# ckStr is a CkString
stringTable.get_Version(ckStr);
strVal = stringTable.version();

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

More Information and Examples
top

Methods

Append
# value is a string
status = stringTable.Append(value);
Introduced in version 9.5.0.62

Appends a string to the table.

Returns True for success, False for failure.

top
AppendFromFile
# maxLineLen is an integer
# charset is a string
# path is a string
status = stringTable.AppendFromFile(maxLineLen, charset, 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
# sb is a CkStringBuilder
status = stringTable.AppendFromSb(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
stringTable.Clear();
Introduced in version 9.5.0.62

Removes all the strings from the table.

top
FindSubstring
# startIndex is an integer
# substr is a string
# caseSensitive is a boolean
retInt = stringTable.FindSubstring(startIndex, substr, caseSensitive);
Introduced in version 9.5.0.77

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.

top
GetStrings
# startIdx is an integer
# count is an integer
# crlf is a boolean
# outStr is a CkString (output)
status = stringTable.GetStrings(startIdx, count, crlf, outStr);
retStr = stringTable.getStrings(startIdx, count, crlf);
Introduced in version 9.5.0.87

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.

top
IntAt
# index is an integer
retInt = stringTable.IntAt(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
SaveToFile
# charset is a string
# bCrlf is a boolean
# path is a string
status = stringTable.SaveToFile(charset, bCrlf, 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
Sort
# ascending is a boolean
# caseSensitive is a boolean
status = stringTable.Sort(ascending, caseSensitive);
Introduced in version 9.5.0.87

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.

top
SplitAndAppend
# inStr is a string
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
status = stringTable.SplitAndAppend(inStr, delimiterChar, exceptDoubleQuoted, 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
# index is an integer
# outStr is a CkString (output)
status = stringTable.StringAt(index, outStr);
retStr = stringTable.stringAt(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