StringTable Perl Reference Documentation
CkStringTable
Current Version: 10.1.2
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->new();
Properties
Count
$intVal = $stringTable->get_Count();
The number of strings in the table.
topDebugLogFilePath
# $ckStr is a CkString
$stringTable->get_DebugLogFilePath($ckStr);
$strVal = $stringTable->debugLogFilePath();
$stringTable->put_DebugLogFilePath($strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
# $ckStr is a CkString
$stringTable->get_LastErrorHtml($ckStr);
$strVal = $stringTable->lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
# $ckStr is a CkString
$stringTable->get_LastErrorText($ckStr);
$strVal = $stringTable->lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
# $ckStr is a CkString
$stringTable->get_LastErrorXml($ckStr);
$strVal = $stringTable->lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
$boolVal = $stringTable->get_LastMethodSuccess();
$stringTable->put_LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topUtf8
$boolVal = $stringTable->get_Utf8();
$stringTable->put_Utf8($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
$boolVal = $stringTable->get_VerboseLogging();
$stringTable->put_VerboseLogging($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
$stringTable->get_Version($ckStr);
$strVal = $stringTable->version();
Methods
Append
$status = $stringTable->Append($value);
AppendFromFile
# $charset is a string
# $path is a string
$status = $stringTable->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
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
$retInt = $stringTable->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)
$status = $stringTable->GetStrings($startIdx, $count, $crlf, $outStr);
$retStr = $stringTable->getStrings($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
$retInt = $stringTable->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
$status = $stringTable->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
$status = $stringTable->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
$status = $stringTable->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)
$status = $stringTable->StringAt($index, $outStr);
$retStr = $stringTable->stringAt($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