Hashtable Perl Reference Documentation
CkHashtable
Current Version: 11.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
$obj = chilkat::CkHashtable->new();
Properties
Count
$intVal = $hashtable->get_Count();
The number of items (strings/integers) contained in the hash table.
topDebugLogFilePath
# $ckStr is a CkString
$hashtable->get_DebugLogFilePath($ckStr);
$strVal = $hashtable->debugLogFilePath();
$hashtable->put_DebugLogFilePath($strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
# $ckStr is a CkString
$hashtable->get_LastErrorHtml($ckStr);
$strVal = $hashtable->lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
# $ckStr is a CkString
$hashtable->get_LastErrorText($ckStr);
$strVal = $hashtable->lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
# $ckStr is a CkString
$hashtable->get_LastErrorXml($ckStr);
$strVal = $hashtable->lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
$boolVal = $hashtable->get_LastMethodSuccess();
$hashtable->put_LastMethodSuccess($boolVal);
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
VerboseLogging
$boolVal = $hashtable->get_VerboseLogging();
$hashtable->put_VerboseLogging($boolVal);
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
# $ckStr is a CkString
$hashtable->get_Version($ckStr);
$strVal = $hashtable->version();
Methods
AddFromXmlSb
Adds to the hash table from XML previously created by calling ToXmlSb.
Returns 1 for success, 0 for failure.
AddInt
# $value is an integer
$status = $hashtable->AddInt($key, $value);
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.
topAddQueryParams
$status = $hashtable->AddQueryParams($queryParams);
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.
AddStr
# $value is a string
$status = $hashtable->AddStr($key, $value);
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.
topClear
Removes all elements from the Hashtable.
topClearWithNewCapacity
$status = $hashtable->ClearWithNewCapacity($capacity);
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.
topContains
$retBool = $hashtable->Contains($key);
Determines if a given key is contained within the hash table. Returns 1 if the key exists, otherwise returns 0.
ContainsIntKey
$retBool = $hashtable->ContainsIntKey($key);
Determines if a given key is contained within the hash table. Returns 1 if the key exists, otherwise returns 0.
GetKeys
Appends the complete set of hashtable key strings to strTable.
Returns 1 for success, 0 for failure.
LookupInt
$retInt = $hashtable->LookupInt($key);
Returns the integer value associated with the specified key. If the key is not in the hash table, the return value is 0.
topLookupStr
# $outStr is a CkString (output)
$status = $hashtable->LookupStr($key, $outStr);
$retStr = $hashtable->lookupStr($key);
Returns the string value associated with the specified key.
Returns 1 for success, 0 for failure.
topRemove
$retBool = $hashtable->Remove($key);
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.
ToQueryString
$status = $hashtable->ToQueryString($outStr);
$retStr = $hashtable->toQueryString();
Serializes the hash table to a query string such as key1=value1&key2=value2&key3=value3 where each value is URL encoded.
Returns 1 for success, 0 for failure.
ToXmlSb
Serializes the hash table to XML format. The XML is appended to sbXml.
Returns 1 for success, 0 for failure.