StringTable ActiveX Reference Documentation

StringTable

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

(Visual Basic 6.0)
Dim obj As New ChilkatStringTable

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

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

Introduced in version 9.5.0.62

The number of strings in the table.

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.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

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).

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.

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.

Concept of LastErrorText

LastErrorText Standard Information

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

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.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

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).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

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.

Version As String (read-only)

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

Methods

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.

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.

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.

(Classic ASP) Load StringTable from a StringBuilder

(Visual FoxPro) Load StringTable from a StringBuilder

(PowerBuilder) Load StringTable from a StringBuilder

(SQL Server) Load StringTable from a StringBuilder

(Visual Basic 6.0) Load StringTable from a StringBuilder

(VBScript) Load StringTable from a StringBuilder

Clear()

Introduced in version 9.5.0.62

Removes all the strings from the table.

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.

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.

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.

(Classic ASP) StringTable SplitAndAppend Example

(Visual FoxPro) StringTable SplitAndAppend Example

(PowerBuilder) StringTable SplitAndAppend Example

(SQL Server) StringTable SplitAndAppend Example

(Visual Basic 6.0) StringTable SplitAndAppend Example

(VBScript) StringTable SplitAndAppend Example

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