StringTable Chilkat2 Perl Reference Documentation
Chilkat2::StringTable
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.StringTable
Store a list of strings in insertion order and retrieve individual
entries by zero-based index.
Add strings directly, append strings from a file, or load line-delimited
text from a
Find entries containing a substring or matching a wildcard pattern when
filtering or locating text values.
Sort the string collection when deterministic ordering or user-facing
display order is needed.
Split delimited text into separate string-table entries for easier
indexing, searching, sorting, or saving.
Convert the table back to line-delimited text, copy it to a
For an extended overview, see
StringTable Class Overview.
Store, load, search, sort, split, retrieve, and save ordered lists of strings.
Chilkat.StringTable is a simple ordered collection of strings.
It can append strings directly, load one string per line from files or
StringBuilder, search for substrings or wildcard matches, sort
the collection, split strings into entries, retrieve strings by index, export
the table as line-delimited text, and save the result to a file.
Ordered string collection
Append and import
StringBuilder.
Search strings
Sort entries
Split into entries
Export and save
StringBuilder, or save the collection to a file.
StringTable when application code needs a lightweight
ordered list of text values. Append or load the strings, search or sort as
needed, retrieve entries by index with StringAt or
StringAtSb, then export the final list as line-delimited text or
save it to a file.
Object Creation
use Chilkat2;
my $stringTable = Chilkat2::StringTable->new;
# or set properties (and RaiseError) at creation:
# my $stringTable = Chilkat2::StringTable->new(VerboseLogging => 1, RaiseError => 1);Creates the object. The optional pairs set writable properties (and RaiseError) in order, as if set one by one; an unknown or read-only name croaks. use Chilkat2; loads every class; the Chilkat2/StringTable.pm file holds only this class's documentation (perldoc Chilkat2::StringTable).
Perl frees the object when its last reference goes (undef $stringTable, or the variable going out of scope); there is nothing to close. Objects returned by methods are independent and freed the same way. The class may be subclassed (use parent -norequire, 'Chilkat2::StringTable';): an object is a blessed hash reference whose hash is free for the subclass's own fields.
When false (the default), a method that fails returns false (or undef), and the reason is in LastErrorText. When true, it dies with a Chilkat2::Error instead, as DBI does with its RaiseError. Objects returned by a method inherit the value of the object that returned them.
Errors
A Chilkat2::Error stringifies to the failed call's full LastErrorText, and has the methods text, class ('Chilkat2::StringTable'), method (the method name) and object. Methods that look something up and find nothing return undef without dying (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain boolean, and property reads and writes never fail for Chilkat reasons.
Misuse always croaks, with your file and line, whatever RaiseError is: a wrong number of arguments, a reference or undef where a string or number is expected, an object of the wrong class, an out-of-range integer, a string containing a NUL character, a wide character in a byte string, or a write to a read-only property.
Strings are Perl character strings in both directions (length, regexes and :encoding layers see characters); binary data (BinData) is a byte string. Unlocking: call Chilkat2::Global->new->UnlockBundle('...') once at startup.
Properties
Count
my $intVal = $stringTable->Count;
The number of strings in the table.
topDebugLogFilePath
my $strVal = $stringTable->DebugLogFilePath;
$stringTable->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
my $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
my $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
my $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
my $boolVal = $stringTable->LastMethodSuccess;
$stringTable->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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
VerboseLogging
my $boolVal = $stringTable->VerboseLogging;
$stringTable->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.
Version
my $strVal = $stringTable->Version;
Methods
Append
# $success is true or false
my $success = $stringTable->Append($value);
Appends a string to the table.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendFromFile
# $charset is a string
# $path is a string
# $success is true or false
my $success = $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 true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
AppendFromSb
# $success is true or false
my $success = $stringTable->AppendFromSb($sb);
Appends strings, one per line, from the contents of a StringBuilder object.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Clear
FindMatch
# $caseSensitive is a boolean
# $n is an integer
my $n = $stringTable->FindMatch($sb, $caseSensitive);
This string table object holds strings with wildcards. The method returns the index of the wildcarded string that matches the text in $sb, or -1 if no match is found. $caseSensitive specifies whether the matching should be case-sensitive.
FindSubstring
# $substr is a string
# $caseSensitive is a boolean
# $n is an integer
my $n = $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.
GetStrings
# $count is an integer
# $crlf is a boolean
# $str is a string or undef
my $str = $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 undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
IntAt
# $n is an integer
my $n = $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.
SaveToFile
# $bCrlf is a boolean
# $path is a string
# $success is true or false
my $success = $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 true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
Sort
# $caseSensitive is a boolean
# $success is true or false
my $success = $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 true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
SplitAndAppend
# $delimiterChar is a string
# $exceptDoubleQuoted is a boolean
# $exceptEscaped is a boolean
# $success is true or false
my $success = $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 true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
StringAt
# $str is a string or undef
my $str = $stringTable->StringAt($index);
Returns the Nth string in the table. The $index is 0-based. (The first string is at index 0.)
Returns undef on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
StringAtSb
# $sb is a Chilkat2::StringBuilder
# $success is true or false
my $success = $stringTable->StringAtSb($index, $sb);
Appends the Nth string in the table to $sb. The $index is 0-based. (The first string is at index 0.)
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
ToSb
# $success is true or false
my $success = $stringTable->ToSb($sb);
Appends the entire string table to $sb using CRLF line endings.
Returns true on success, false on failure; LastErrorText says why. With RaiseError on, a failure dies with a Chilkat2::Error instead (it stringifies to the LastErrorText); the object remains usable either way.
WordFollowing
# $captureEmailAddr is a boolean
# $sbWord is a Chilkat2::StringBuilder
# $n is an integer
my $n = $stringTable->WordFollowing($sb, $captureEmailAddr, $sbWord);
The method performs a case-insensitive search to return the index of a table entry matching $sb, or -1 if there is no match. Set $captureEmailAddr to 1 if the target word is expected to be an email address, otherwise set $captureEmailAddr to 0. $sbWord will receive the word (email address) following the matched text.
This method helps replace the outdated Chilkat Bounce class, which was used for identifying and categorizing bounced email types.