Hashtable Lianja Reference Documentation

Hashtable

Current Version: 9.5.0.97

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

loObject = createobject("CkHashtable")

Properties

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

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

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicate whether the last method call succeeded or failed. A value of .T. indicates success, a value of .F. 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 = .T. and failure = .F..
  • 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 .T.. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top

Methods

AddFromXmlSb
AddFromXmlSb(sbXml As CkStringBuilder) As Boolean
Introduced in version 9.5.0.64

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

Returns .T. for success, .F. for failure.

More Information and Examples
top
AddInt
AddInt(key As Character, value As Numeric) As Boolean
Introduced in version 9.5.0.51

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

Returns .T. for success, .F. for failure.

top
AddQueryParams
AddQueryParams(queryParams As Character) As Boolean
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 .T. for success, .F. for failure.

More Information and Examples
top
AddStr
AddStr(key As Character, value As Character) As Boolean
Introduced in version 9.5.0.51

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

Returns .T. for success, .F. for failure.

top
Clear
Clear()
Introduced in version 9.5.0.51

Removes all elements from the Hashtable.

top
ClearWithNewCapacity
ClearWithNewCapacity(capacity As Numeric) As Boolean
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 .T. for success, .F. for failure.

top
Contains
Contains(key As Character) As Boolean
Introduced in version 9.5.0.51

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

top
ContainsIntKey
ContainsIntKey(key As Numeric) As Boolean
Introduced in version 9.5.0.64

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

top
GetKeys
GetKeys(strTable As CkStringTable) As Boolean
Introduced in version 9.5.0.62

Appends the complete set of hashtable key strings to strTable.

Returns .T. for success, .F. for failure.

More Information and Examples
top
LookupInt
LookupInt(key As Character) As Numeric
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 Character) As Character
Introduced in version 9.5.0.51

Returns the string value associated with the specified key.

Returns .F. on failure

top
Remove
Remove(key As Character) As Boolean
Introduced in version 9.5.0.51

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

top
ToQueryString
ToQueryString() As Character
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 .F. on failure

More Information and Examples
top
ToXmlSb
ToXmlSb(sbXml As CkStringBuilder) As Boolean
Introduced in version 9.5.0.64

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

Returns .T. for success, .F. for failure.

More Information and Examples
top