StringTable ActiveX Reference Documentation

StringTable

Current Version: 9.5.0.97

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

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.StringTable")

(AutoIt)
$obj = ObjCreate("Chilkat_9_5_0.StringTable")

(Visual Basic 6.0)
Dim obj As New ChilkatStringTable

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.StringTable")

(Delphi)
obj := TChilkatStringTable.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.StringTable')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.StringTable")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringTable', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.StringTable");

Properties

Count
Count As Long (read-only)
Introduced in version 9.5.0.62

The number of strings in the table.

top
DebugLogFilePath
DebugLogFilePath As String

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
LastBinaryResult
LastBinaryResult As Variant (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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
LastErrorXml As String (read-only)

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
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
VerboseLogging As Long

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.

top
Version
Version As String (read-only)

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

top

Methods

Append
Append(value As String) As Long
Introduced in version 9.5.0.62

Appends a string to the table.

Returns 1 for success, 0 for failure.

top
AppendFromFile
AppendFromFile(ByVal maxLineLen As Long, charset As String, path As String) As Long
Introduced in version 9.5.0.62

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.

top
AppendFromSb
AppendFromSb(sb As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.62

Appends strings, one per line, from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

top
Clear
Clear()
Introduced in version 9.5.0.62

Removes all the strings from the table.

top
FindSubstring
FindSubstring(ByVal startIndex As Long, substr As String, ByVal caseSensitive As Long) As Long
Introduced in version 9.5.0.77

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.

top
GetStrings
GetStrings(ByVal startIdx As Long, ByVal count As Long, ByVal crlf As Long) As String
Introduced in version 9.5.0.87

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 Nothing on failure

top
IntAt
IntAt(ByVal index As Long) As Long
Introduced in version 9.5.0.63

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.

top
SaveToFile
SaveToFile(charset As String, ByVal bCrlf As Long, path As String) As Long
Introduced in version 9.5.0.62

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.

top
Sort
Sort(ByVal ascending As Long, ByVal caseSensitive As Long) As Long
Introduced in version 9.5.0.87

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.

top
SplitAndAppend
SplitAndAppend(inStr As String, delimiterChar As String, ByVal exceptDoubleQuoted As Long, ByVal exceptEscaped As Long) As Long
Introduced in version 9.5.0.62

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.

top
StringAt
StringAt(ByVal index As Long) As String
Introduced in version 9.5.0.62

Returns the Nth string in the table. The index is 0-based. (The first string is at index 0.)

Returns Nothing on failure

top