Hashtable Objective-C Reference Documentation

CkoHashtable

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

CkoHashtable *obj = [[CkoHashtable alloc] init];

Properties

Count
@property (nonatomic, readonly, copy) NSNumber *Count;
Introduced in version 9.5.0.97

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

top
DebugLogFilePath
@property (nonatomic, copy) NSString *DebugLogFilePath;

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.

More Information and Examples
top
LastErrorHtml
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorText
@property (nonatomic, readonly, copy) NSString *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.

top
LastErrorXml
@property (nonatomic, readonly, copy) NSString *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.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicates the success or failure of the most recent method call: YES means success, NO 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.

top
VerboseLogging
@property (nonatomic) BOOL VerboseLogging;

If set to YES, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is NO. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
@property (nonatomic, readonly, copy) NSString *Version;

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AddFromXmlSb
- (BOOL)AddFromXmlSb:(CkoStringBuilder *)sbXml;
Introduced in version 9.5.0.64

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

Returns YES for success, NO for failure.

More Information and Examples
top
AddInt
- (BOOL)AddInt:(NSString *)key
    value:(NSNumber *)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 YES if a new hash entry was added or replaced. Returns NO if an out-of-memory condition occurred.

Returns YES for success, NO for failure.

top
AddQueryParams
- (BOOL)AddQueryParams:(NSString *)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 YES for success, NO for failure.

More Information and Examples
top
AddStr
- (BOOL)AddStr:(NSString *)key
    value:(NSString *)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 YES if a new hash entry was added or replaced. Returns NO if an out-of-memory condition occurred.

Returns YES for success, NO for failure.

top
Clear
- (void)Clear;
Introduced in version 9.5.0.51

Removes all elements from the Hashtable.

top
ClearWithNewCapacity
- (BOOL)ClearWithNewCapacity:(NSNumber *)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 YES for success, NO for failure.

top
Contains
- (BOOL)Contains:(NSString *)key;
Introduced in version 9.5.0.51

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

top
ContainsIntKey
- (BOOL)ContainsIntKey:(NSNumber *)key;
Introduced in version 9.5.0.64

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

top
GetKeys
- (BOOL)GetKeys:(CkoStringTable *)strTable;
Introduced in version 9.5.0.62

Appends the complete set of hashtable key strings to strTable.

Returns YES for success, NO for failure.

More Information and Examples
top
LookupInt
- (NSNumber *)LookupInt:(NSString *)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
- (NSString *)LookupStr:(NSString *)key;
Introduced in version 9.5.0.51

Returns the string value associated with the specified key.

Returns nil on failure

top
Remove
- (BOOL)Remove:(NSString *)key;
Introduced in version 9.5.0.51

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

top
ToQueryString
- (NSString *)ToQueryString;
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 nil on failure

More Information and Examples
top
ToXmlSb
- (BOOL)ToXmlSb:(CkoStringBuilder *)sbXml;
Introduced in version 9.5.0.64

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

Returns YES for success, NO for failure.

More Information and Examples
top