CkHashtable Perl Reference Documentation

CkHashtable

Current Version: 9.5.0.75

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

$obj = chilkat::CkHashtable->new();

Properties

LastMethodSuccess
# $boolVal is a boolean
$boolVal = $hashtable->get_LastMethodSuccess();
$hashtable->put_LastMethodSuccess($boolVal);

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
Utf8
# $boolVal is a boolean
$boolVal = $hashtable->get_Utf8();
$hashtable->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top

Methods

AddFromXmlSb
# $sbXml is a CkStringBuilder
$status = $hashtable->AddFromXmlSb($sbXml);
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.

More Information and Examples
top
AddInt
# $key is a string
# $value is an integer
$status = $hashtable->AddInt($key, $value);
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
# $queryParams is a string
$status = $hashtable->AddQueryParams($queryParams);
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
# $key is a string
# $value is a string
$status = $hashtable->AddStr($key, $value);
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
$hashtable->Clear();
Introduced in version 9.5.0.51

Removes all elements from the Hashtable.

top
ClearWithNewCapacity
# $capacity is an integer
$status = $hashtable->ClearWithNewCapacity($capacity);
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
# $key is a string
$retBool = $hashtable->Contains($key);
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
# $key is an integer
$retBool = $hashtable->ContainsIntKey($key);
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
# $strTable is a CkStringTable
$status = $hashtable->GetKeys($strTable);
Introduced in version 9.5.0.62

Appends the complete set of hashtable key strings to strTable.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LookupInt
# $key is a string
$retInt = $hashtable->LookupInt($key);
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
# $key is a string
# $outStr is a CkString (output)
$status = $hashtable->LookupStr($key, $outStr);
$retStr = $hashtable->lookupStr($key);
Introduced in version 9.5.0.51

Returns the string value associated with the specified key.

Returns 1 for success, 0 for failure.

top
Remove
# $key is a string
$retBool = $hashtable->Remove($key);
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
ToXmlSb
# $sbXml is a CkStringBuilder
$status = $hashtable->ToXmlSb($sbXml);
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.

More Information and Examples
top