CkStringArray Ruby Reference Documentation

CkStringArray

Current Version: 9.5.0.75

Class/object for managing and manipulating collections of strings. Contains an ordered collection of strings.

Object Creation

obj = Chilkat::CkStringArray.new()

Properties

Count
# intVal is an integer
intVal = stringArray.get_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.

top
Crlf
# boolVal is a boolean
boolVal = stringArray.get_Crlf();
stringArray.put_Crlf(boolVal);

If true, strings are always automatically converted to use CRLF line endings. If false, strings are automatically converted to use bare LF line endings.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
stringArray.get_DebugLogFilePath(ckStr);
strVal = stringArray.debugLogFilePath();
stringArray.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
stringArray.get_LastErrorHtml(ckStr);
strVal = stringArray.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
stringArray.get_LastErrorText(ckStr);
strVal = stringArray.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
stringArray.get_LastErrorXml(ckStr);
strVal = stringArray.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 = stringArray.get_LastMethodSuccess();
stringArray.put_LastMethodSuccess(boolVal);
Introduced in version 9.5.0.52

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
Length
# intVal is an integer
intVal = stringArray.get_Length();

The number of strings contained within the internal collection. (Identical to the Count property.)

top
Trim
# boolVal is a boolean
boolVal = stringArray.get_Trim();
stringArray.put_Trim(boolVal);

If true, whitespace, including carriage-returns and linefeeds, are automatically removed from the beginning and end of a string when added to the collection.

top
Unique
# boolVal is a boolean
boolVal = stringArray.get_Unique();
stringArray.put_Unique(boolVal);

If true, 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 false.

top
Utf8
# boolVal is a boolean
boolVal = stringArray.get_Utf8();
stringArray.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 = stringArray.get_VerboseLogging();
stringArray.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
stringArray.get_Version(ckStr);
strVal = stringArray.version();

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

top

Methods

Append
# str is a string
status = stringArray.Append(str);

Appends a string to the end of the internal ordered collection.

Returns true for success, false for failure.

top
AppendSerialized
# encodedStr is a string
status = 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 for success, false for failure.

top
Clear
stringArray.Clear();

Remove all strings from the internal collection.

top
Contains
# str is a string
retBool = stringArray.Contains(str);

Returns true if the string is present in the internal collection. The string comparisons are case sensitive.

top
Find
# findStr is a string
# startIndex is an integer
retInt = 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.

top
FindFirstMatch
# matchPattern is a string
# startIndex is an integer
retInt = 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.

top
GetString
# index is an integer
# outStr is a CkString (output)
status = stringArray.GetString(index, outStr);
retStr = stringArray.getString(index);

Returns the string at an indexed location within the internal collection. The first string is located at index 0.

Returns true for success, false for failure.

top
GetStringLen
# index is an integer
retInt = stringArray.GetStringLen(index);

Returns Nth string's length, in characters. The first string is located at index 0.

top
InsertAt
# index is an integer
# 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.

top
LastString
# outStr is a CkString (output)
status = stringArray.LastString(outStr);
retStr = stringArray.lastString();

Returns the last string in the internal collection.

Returns true for success, false for failure.

top
LoadFromFile
# path is a string
status = 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.

Returns true for success, false for failure.

top
LoadFromFile2
# path is a string
# charset is a string
status = 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.

Returns true for success, false for failure.

top
LoadFromText
# str is a string
stringArray.LoadFromText(str);

Loads strings from an in-memory string (one per line) into the internal collection.

top
LoadTaskResult
# task is a CkTask
status = stringArray.LoadTaskResult(task);
Introduced in version 9.5.0.52

Loads the string collection from a completed asynchronous task.

Returns true for success, false for failure.

top
Pop
# outStr is a CkString (output)
status = stringArray.Pop(outStr);
retStr = stringArray.pop();

Returns the last string and removes it from the internal collection.

Returns true for success, false for failure.

top
Prepend
# str is a string
stringArray.Prepend(str);

Adds a string to the beginning of the internal collection.

top
Remove
# str is a string
stringArray.Remove(str);

Removes all strings equal to the string argument from the internal collection.

top
RemoveAt
# index is an integer
retBool = stringArray.RemoveAt(index);

Removes the string at a particular index.

top
ReplaceAt
# index is an integer
# str is a string
stringArray.ReplaceAt(index, str);
Introduced in version 9.5.0.52

Replaces the string at a specified index.

top
SaveLastError
# path is a string
status = stringArray.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SaveNthToFile
# index is an integer
# saveToPath is a string
status = stringArray.SaveNthToFile(index, saveToPath);

Saves the Nth string in the collection to a file.

Returns true for success, false for failure.

top
SaveToFile
# path is a string
status = 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 for success, false for failure.

top
SaveToFile2
# saveToPath is a string
# charset is a string
status = 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 for success, false for failure.

top
SaveToText
# outStr is a CkString (output)
status = stringArray.SaveToText(outStr);
retStr = stringArray.saveToText();

Writes the collection of strings to a single string, one per line (separated by CRLF line endings).

Returns true for success, false for failure.

top
Serialize
# outStr is a CkString (output)
status = stringArray.Serialize(outStr);
retStr = 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 true for success, false for failure.

top
Sort
# ascending is a boolean
stringArray.Sort(ascending);

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.

top
SplitAndAppend
# str is a string
# 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.

top
StrAt
# index is an integer
# outStr is a CkString (output)
status = stringArray.StrAt(index, outStr);
retStr = stringArray.strAt(index);

Returns the string at a specific index.

Returns true for success, false for failure.

top
Subtract
# stringArrayObj is a CkStringArray
stringArray.Subtract(stringArrayObj);

Subtracts the strings contained within stringArrayObj from the caller's internal collection.

top
Union
# stringArrayObj is a CkStringArray
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.

top