StringArray Chilkat2 Perl Reference Documentation
Chilkat2::StringArray
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.StringArray
Store strings in an internal ordered collection and retrieve them by
zero-based index using
Append, prepend, insert, replace, remove, clear, or pop strings as the
collection changes.
Load one string per line from files or text, and save the collection back
to files or a single line-delimited string.
Use charset-specific load and save methods when working with UTF-8,
UTF-16, or other non-ANSI text encodings.
Check for exact strings, find values from a starting index, match
wildcard patterns, and sort ascending or descending.
Serialize the collection for later restoration, split text into entries,
and combine or subtract collections with set-style operations.
Manage an ordered collection of strings, with StringTable recommended for new code.
Chilkat.StringArray is an ordered string-collection class that
can append, prepend, insert, replace, remove, pop, and retrieve strings by
index. It can load one string per line from files or in-memory text, save the
collection back to text or files, enforce uniqueness, trim incoming values,
normalize line endings, search by exact value or wildcard pattern, sort
entries, split text into entries, serialize and restore the collection, and
perform set-style operations such as union and subtraction.
Chilkat.StringTable instead of
Chilkat.StringArray. StringTable provides a simpler,
faster, and more memory-efficient way to manage ordered lists of strings.
Use StringArray primarily when maintaining existing code or when
a specific API or older example already uses it.
Ordered string collection
GetString, StrAt, or
LastString.
Add and modify entries
Load and save text
Charset-aware file I/O
Search, match, and sort
Serialize and combine
StringArray, optionally set Trim,
Crlf, or Unique, then append strings directly or
load them from a file or text block. Search, sort, split, remove, union, or
subtract entries as needed, then save the result with
SaveToText, SaveToFile, or
SaveToFile2. For new code that only needs an ordered list of
strings, use Chilkat.StringTable instead.
Array,
Chilkat.StringArray is a Chilkat object that manages an ordered
string collection. It should not be confused with a native array type in a
programming language.
Object Creation
use Chilkat2;
my $stringArray = Chilkat2::StringArray->new;
# or set properties (and RaiseError) at creation:
# my $stringArray = Chilkat2::StringArray->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/StringArray.pm file holds only this class's documentation (perldoc Chilkat2::StringArray).
Perl frees the object when its last reference goes (undef $stringArray, 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::StringArray';): 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::StringArray'), 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 = $stringArray->Count;
The number of strings contained within the object's internal array (i.e. ordered collection).
Important: This is an object that contains a collection of strings. Although the class/object name includes the word Array, it should not be confused with an array in the sense of the primitive array type used in a given programming language.
Crlf
my $boolVal = $stringArray->Crlf;
$stringArray->Crlf($boolVal);
If 1, strings are always automatically converted to use CRLF line endings. If 0, strings are automatically converted to use bare LF line endings.
DebugLogFilePath
my $strVal = $stringArray->DebugLogFilePath;
$stringArray->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 = $stringArray->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 = $stringArray->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 = $stringArray->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 = $stringArray->LastMethodSuccess;
$stringArray->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.
Length
my $intVal = $stringArray->Length;
The number of strings contained within the internal collection. (Identical to the Count property.)
topTrim
my $boolVal = $stringArray->Trim;
$stringArray->Trim($boolVal);
If 1, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.
Unique
my $boolVal = $stringArray->Unique;
$stringArray->Unique($boolVal);
If 1, then duplicates are not allowed. When an attempt is made to insert a string that already exists, the duplicate insertion is silently suppressed and no error is returned. The default value is 0.
VerboseLogging
my $boolVal = $stringArray->VerboseLogging;
$stringArray->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 = $stringArray->Version;
Methods
Append
# $success is true or false
my $success = $stringArray->Append($str);
Appends a string to the end of the internal ordered collection.
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.
AppendSerialized
# $success is true or false
my $success = $stringArray->AppendSerialized($encodedStr);
Appends multiple strings to the end of the internal ordered collection. The $encodedStr is what is returned from the Serialize method (see below).
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
Contains
# $flag is true or false
my $flag = $stringArray->Contains($str);
Returns 1 if the string is present in the internal collection. The string comparisons are case sensitive.
Never dies: false is an answer, not a failure.
topFind
# $startIndex is an integer
# $n is an integer
my $n = $stringArray->Find($findStr, $startIndex);
Finds the index of the first string equal to $findStr. The search begins at $startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.
FindFirstMatch
# $startIndex is an integer
# $n is an integer
my $n = $stringArray->FindFirstMatch($matchPattern, $startIndex);
Finds the first string that matches the $matchPattern. The search begins at $startIndex. If the string is not found, -1 is returned. The first string in the array is at index 0.
The $matchPattern may contain zero or more asterisk chars, each of which matches 0 or more of any character.
GetString
# $str is a string or undef
my $str = $stringArray->GetString($index);
Returns the string at an indexed location within the internal collection. The first string is located 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.
GetStringLen
# $n is an integer
my $n = $stringArray->GetStringLen($index);
Returns Nth string's length, in characters. The first string is located at index 0.
topInsertAt
# $str is a string
$stringArray->InsertAt($index, $str);
Inserts a string into the internal collection at a specified index. Using index 0 will insert at the beginning.
Returns the object, so calls can be chained.
topLastString
my $str = $stringArray->LastString();
Returns the last string in the internal collection.
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.
LoadFromFile
# $success is true or false
my $success = $stringArray->LoadFromFile($path);
Loads strings from a file (one per line) into the internal collection. It is assumed the file contains ANSI strings. To load from a file containing non-ANSI strings (such as utf-8), call LoadFromFile2 instead.
Note: This method appends the strings in $path to the existing collection of strings contained in this 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.
LoadFromFile2
# $charset is a string
# $success is true or false
my $success = $stringArray->LoadFromFile2($path, $charset);
Loads strings from a file (one per line) into the internal collection. The $charset specifies the character encoding (such as utf-8) of the strings contained in the file.
Note: This method appends the strings in $path to the existing collection of strings contained in this 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.
LoadFromText
$stringArray->LoadFromText($str);
Loads strings from an in-memory string (one per line) into the internal collection.
Note: This method appends the strings in $str to the existing collection of strings contained in this object.
Returns the object, so calls can be chained.
topPop
my $str = $stringArray->Pop();
Returns the last string and removes it from the internal collection.
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.
Prepend
$stringArray->Prepend($str);
Adds a string to the beginning of the internal collection.
Returns the object, so calls can be chained.
topRemove
$stringArray->Remove($str);
Removes all strings equal to the string argument from the internal collection.
Returns the object, so calls can be chained.
topRemoveAt
# $success is true or false
my $success = $stringArray->RemoveAt($index);
Removes the string at a particular index.
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.
ReplaceAt
# $str is a string
$stringArray->ReplaceAt($index, $str);
SaveNthToFile
# $saveToPath is a string
# $success is true or false
my $success = $stringArray->SaveNthToFile($index, $saveToPath);
Saves the Nth string in the collection to a file.
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.
SaveToFile
# $success is true or false
my $success = $stringArray->SaveToFile($path);
Saves the collection of strings to a file, one string per line. Strings are saved using the ANSI charset. (Call SaveToFile2 to specify a charset, such as utf-8)
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.
SaveToFile2
# $charset is a string
# $success is true or false
my $success = $stringArray->SaveToFile2($saveToPath, $charset);
Saves the collection of strings to a file, one string per line. Strings are saved using the specified $charset.
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.
SaveToText
my $str = $stringArray->SaveToText();
Writes the collection of strings to a single string, one per line (separated by CRLF line endings).
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.
Serialize
my $str = $stringArray->Serialize();
Returns an string which is an encoded representation of all the strings in the collection. The string collection can be re-created by calling the AppendSerialized method.
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.
Sort
$stringArray->Sort($ascending);
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 the object, so calls can be chained.
topSplitAndAppend
# $boundary is a string
$stringArray->SplitAndAppend($str, $boundary);
Splits a string at a character or substring boundary and adds each resulting string to the internal collection.
Returns the object, so calls can be chained.
topStrAt
# $str is a string or undef
my $str = $stringArray->StrAt($index);
Returns the string at a specific index.
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.
Subtract
$stringArray->Subtract($stringArrayObj);
Subtracts the strings contained within $stringArrayObj from the caller's internal collection.
Returns the object, so calls can be chained.
topUnion
$stringArray->Union($stringArrayObj);
Performs the union set-operator. The result is that the caller will have a string collection that is the union of itself and $stringArrayObj.
Returns the object, so calls can be chained.
top