StringTable Tcl 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.
Object Creation
set myStringTable [new CkStringTable]
Properties
Count
set intVal [CkStringTable_get_Count $myStringTable]
The number of strings in the table.
topDebugLogFilePath
# ckStr is a CkString
CkStringTable_get_DebugLogFilePath $myStringTable $ckStr
set strVal [CkStringTable_get_debugLogFilePath $myStringTable]
CkStringTable_put_DebugLogFilePath $myStringTable $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:
- 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
# ckStr is a CkString
CkStringTable_get_LastErrorHtml $myStringTable $ckStr
set strVal [CkStringTable_get_lastErrorHtml $myStringTable]
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
# ckStr is a CkString
CkStringTable_get_LastErrorText $myStringTable $ckStr
set strVal [CkStringTable_get_lastErrorText $myStringTable]
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
# ckStr is a CkString
CkStringTable_get_LastErrorXml $myStringTable $ckStr
set strVal [CkStringTable_get_lastErrorXml $myStringTable]
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
set boolVal [CkStringTable_get_LastMethodSuccess $myStringTable]
CkStringTable_put_LastMethodSuccess $myStringTable $boolVal
Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
- 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topUtf8
set boolVal [CkStringTable_get_Utf8 $myStringTable]
CkStringTable_put_Utf8 $myStringTable $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkStringTable_get_VerboseLogging $myStringTable]
CkStringTable_put_VerboseLogging $myStringTable $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
# ckStr is a CkString
CkStringTable_get_Version $myStringTable $ckStr
set strVal [CkStringTable_get_version $myStringTable]
Methods
Append
set status [CkStringTable_Append $value]
AppendFromFile
# charset is a string
# path is a string
set status [CkStringTable_AppendFromFile $maxLineLen $charset $path]
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 1 for success, 0 for failure.
topAppendFromSb
set status [CkStringTable_AppendFromSb $sb]
Appends strings, one per line, from the contents of a StringBuilder object.
Returns 1 for success, 0 for failure.
Clear
Removes all the strings from the table.
topFindSubstring
# substr is a string
# caseSensitive is a boolean
set retInt [CkStringTable_FindSubstring $startIndex $substr $caseSensitive]
Return the index of the first string in the table containing substr. Begins searching strings starting at startIndex. If caseSensitive is 1, then the search is case sensitive. If caseSensitive is 0 then the search is case insensitive. Returns -1 if the substr is not found.
topGetStrings
# count is an integer
# crlf is a boolean
# outStr is a CkString (output)
set status [CkStringTable_GetStrings $startIdx $count $crlf $outStr]
set retStr [CkStringTable_getStrings $myStringTable $startIdx $count $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 1 to emit with CRLF line endings, or 0 to emit LF-only line endings. The last string is emitted includes the line ending.
Returns 1 for success, 0 for failure.
topIntAt
set retInt [CkStringTable_IntAt $index]
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
# bCrlf is a boolean
# path is a string
set status [CkStringTable_SaveToFile $charset $bCrlf $path]
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 1, then CRLF line endings are used, otherwise LF-only line endings are used.
Returns 1 for success, 0 for failure.
topSort
# caseSensitive is a boolean
set status [CkStringTable_Sort $ascending $caseSensitive]
Sorts the strings in the collection in ascending or descending order. To sort in ascending order, set ascending to 1, otherwise set ascending equal to 0.
Returns 1 for success, 0 for failure.
topSplitAndAppend
# delimiterChar is a string
# exceptDoubleQuoted is a boolean
# exceptEscaped is a boolean
set status [CkStringTable_SplitAndAppend $inStr $delimiterChar $exceptDoubleQuoted $exceptEscaped]
Splits a string into parts based on a single character delimiterChar. If exceptDoubleQuoted is 1, then the delimiter char found between double quotes is not treated as a delimiter. If exceptEscaped is 1, then an escaped (with a backslash) delimiter char is not treated as a delimiter.
Returns 1 for success, 0 for failure.
StringAt
# outStr is a CkString (output)
set status [CkStringTable_StringAt $index $outStr]
set retStr [CkStringTable_stringAt $myStringTable $index]
Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)
Returns 1 for success, 0 for failure.
top