Hashtable ActiveX Reference Documentation

Hashtable

Current Version: 10.0.0

Represents a collection of key/value pairs that are stored in a hash table.

Note: This class was added in Chilkat v9.5.0.51

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Hashtable" instead of "Chilkat.Hashtable"
For a specific major version, use "Chilkat.Hashtable.<major_version>", such as "Chilkat.Hashtable.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Hashtable")

(AutoIt)
$obj = ObjCreate("Chilkat.Hashtable")

(Visual Basic 6.0)
Dim obj As New ChilkatHashtable

(VBScript)
set obj = CreateObject("Chilkat.Hashtable")

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

(FoxPro)
loObject = CreateObject('Chilkat.Hashtable')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Hashtable")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Hashtable', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Hashtable");

Properties

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

The number of items (strings/integers) contained in the hash table.

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

Methods

AddFromXmlSb
AddFromXmlSb(sbXml As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.64

Adds to the hash table from XML previously created by calling ToXmlSb.

Returns 1 for success, 0 for failure.

top
AddInt
AddInt(key As String, ByVal value As Long) As Long
Introduced in version 9.5.0.51

Adds or replaces an entry with the given key and integer value to the hash table. Returns 1 if a new hash entry was added or replaced. Returns 0 if an out-of-memory condition occurred.

Returns 1 for success, 0 for failure.

top
AddQueryParams
AddQueryParams(queryParams As String) As Long
Introduced in version 9.5.0.62

Adds URL query parameters into the hashtable. The queryParams has the form: "field1=value1&field2=value2&field3=value3...". It is assumed that the values are URL encoded, and this method automatically URL decodes the values prior to inserting into the hashtable.

Returns 1 for success, 0 for failure.

top
AddStr
AddStr(key As String, value As String) As Long
Introduced in version 9.5.0.51

Adds or replaces an entry with the given key and string value to the hash table. Returns 1 if a new hash entry was added or replaced. Returns 0 if an out-of-memory condition occurred.

Returns 1 for success, 0 for failure.

top
Clear
Clear()
Introduced in version 9.5.0.51

Removes all elements from the Hashtable.

top
ClearWithNewCapacity
ClearWithNewCapacity(ByVal capacity As Long) As Long
Introduced in version 9.5.0.51

Removes all elements from the Hashtable and re-sizes with the specified capacity.

The capacity is the number of buckets in the hash table. In the case of a "hash collision", a single bucket stores multiple entries, which must be searched sequentially. One rule of thumb is to set the capacity to twice the number of expected items to be hashed. It's also preferable to set the capacity to a prime number. (The 1st 10,000 prime numbers are listed here: https://primes.utm.edu/lists/small/10000.txt )

The initial default capacity of the hash table is 521.

Returns 1 for success, 0 for failure.

top
Contains
Contains(key As String) As Long
Introduced in version 9.5.0.51

Determines if a given key is contained within the hash table. Returns 1 if the key exists, otherwise returns 0.

top
ContainsIntKey
ContainsIntKey(ByVal key As Long) As Long
Introduced in version 9.5.0.64

Determines if a given key is contained within the hash table. Returns 1 if the key exists, otherwise returns 0.

top
GetKeys
GetKeys(strTable As ChilkatStringTable) As Long
Introduced in version 9.5.0.62

Appends the complete set of hashtable key strings to strTable.

Returns 1 for success, 0 for failure.

top
LookupInt
LookupInt(key As String) As Long
Introduced in version 9.5.0.51

Returns the integer value associated with the specified key. If the key is not in the hash table, the return value is 0.

top
LookupStr
LookupStr(key As String) As String
Introduced in version 9.5.0.51

Returns the string value associated with the specified key.

Returns Nothing on failure

top
Remove
Remove(key As String) As Long
Introduced in version 9.5.0.51

Removes the entry with the specified key from the hash table. Returns 1 if the key existed and was removed. Returns 0 if the key did not already exist.

top
ToQueryString
ToQueryString() As String
Introduced in version 9.5.0.92

Serializes the hash table to a query string such as key1=value1&key2=value2&key3=value3 where each value is URL encoded.

Returns Nothing on failure

top
ToXmlSb
ToXmlSb(sbXml As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.64

Serializes the hash table to XML format. The XML is appended to sbXml.

Returns 1 for success, 0 for failure.

top