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

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoHashtable
Get Create(RefClass(cComChilkatHashtable)) to hoHashtable

Properties

Count
Function ComCount Returns Integer
Introduced in version 9.5.0.97

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

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. 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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

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
LastStringResult
Function ComLastStringResult Returns String

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. 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
Function ComLastStringResultLen Returns Integer

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

top

Methods

AddFromXmlSb
Function ComAddFromXmlSb cComChilkatStringBuilder sbXml Returns Boolean
Introduced in version 9.5.0.64

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

Returns True for success, False for failure.

More Information and Examples
top
AddInt
Function ComAddInt String key Integer value Returns 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 True if a new hash entry was added or replaced. Returns False if an out-of-memory condition occurred.

Returns True for success, False for failure.

top
AddQueryParams
Function ComAddQueryParams String queryParams Returns 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 True for success, False for failure.

More Information and Examples
top
AddStr
Function ComAddStr String key String value Returns 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 True if a new hash entry was added or replaced. Returns False if an out-of-memory condition occurred.

Returns True for success, False for failure.

top
Clear
Procedure ComClear
Introduced in version 9.5.0.51

Removes all elements from the Hashtable.

top
ClearWithNewCapacity
Function ComClearWithNewCapacity Integer capacity Returns 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 True for success, False for failure.

top
Contains
Function ComContains String key Returns Boolean
Introduced in version 9.5.0.51

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

top
ContainsIntKey
Function ComContainsIntKey Integer key Returns Boolean
Introduced in version 9.5.0.64

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

top
GetKeys
Function ComGetKeys cComChilkatStringTable strTable Returns Boolean
Introduced in version 9.5.0.62

Appends the complete set of hashtable key strings to strTable.

Returns True for success, False for failure.

More Information and Examples
top
LookupInt
Function ComLookupInt String key Returns Integer
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
Function ComLookupStr String key Returns String
Introduced in version 9.5.0.51

Returns the string value associated with the specified key.

Returns null on failure

top
Remove
Function ComRemove String key Returns Boolean
Introduced in version 9.5.0.51

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

top
ToQueryString
Function ComToQueryString Returns 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 null on failure

More Information and Examples
top
ToXmlSb
Function ComToXmlSb cComChilkatStringBuilder sbXml Returns Boolean
Introduced in version 9.5.0.64

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

Returns True for success, False for failure.

More Information and Examples
top