ExistsKey family of functions

Functions
bool	LuaHashMap_ExistsKeyString (LuaHashMap *restrict hash_map, const char *restrict key_string)
	Returns whether a key/value pair exists in the hash table for a specified key.
bool	LuaHashMap_ExistsKeyStringWithLength (LuaHashMap *restrict hash_map, const char *restrict key_string, size_t key_string_length)
	Returns whether a key/value pair exists in the hash table for a specified key.
bool	LuaHashMap_ExistsKeyPointer (LuaHashMap *hash_map, void *key_pointer)
	Returns whether a key/value pair exists in the hash table for a specified key.
bool	LuaHashMap_ExistsKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
	Returns whether a key/value pair exists in the hash table for a specified key.
bool	LuaHashMap_ExistsKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
	Returns whether a key/value pair exists in the hash table for a specified key.

Detailed Description

Function Documentation

bool LuaHashMap_ExistsKeyInteger	(	LuaHashMap *	hash_map,
		lua_Integer	key_integer
	)

Returns whether a key/value pair exists in the hash table for a specified key.

Returns whether a key/value pair exists in the hash table for a specified key. integer version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_integer	The key to test.

Returns

Returns true if the key/value pair exists in the hash table. Returns false otherwise.

Note

Consider using the GetIteratorForKey + GetCachedValue family of functions if you need to first check for existence and then retrieve the value if it exists.

See Also

LuaHashMap_GetIteratorForKeyInteger

bool LuaHashMap_ExistsKeyNumber	(	LuaHashMap *	hash_map,
		lua_Number	key_number
	)

Returns whether a key/value pair exists in the hash table for a specified key.

Returns whether a key/value pair exists in the hash table for a specified key. number version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_number	The key to test.

Returns

Returns true if the key/value pair exists in the hash table. Returns false otherwise.

Note

Consider using the GetIteratorForKey + GetCachedValue family of functions if you need to first check for existence and then retrieve the value if it exists.

See Also

LuaHashMap_GetIteratorForKeyNumber

bool LuaHashMap_ExistsKeyPointer	(	LuaHashMap *	hash_map,
		void *	key_pointer
	)

Returns whether a key/value pair exists in the hash table for a specified key.

Returns whether a key/value pair exists in the hash table for a specified key. pointer version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_pointer	The key to test.

Returns

Returns true if the key/value pair exists in the hash table. Returns false otherwise.

Note

Consider using the GetIteratorForKey + GetCachedValue family of functions if you need to first check for existence and then retrieve the value if it exists.

See Also

LuaHashMap_GetIteratorForKeyPointer

bool LuaHashMap_ExistsKeyString	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string
	)

Returns whether a key/value pair exists in the hash table for a specified key.

Returns whether a key/value pair exists in the hash table for a specified key. string version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key to test.

Returns

Returns true if the key/value pair exists in the hash table. Returns false otherwise.

Note

Consider using the GetIteratorForKey + GetCachedValue family of functions if you need to first check for existence and then retrieve the value if it exists.

See Also

LuaHashMap_GetIteratorForKeyString, LuaHashMap_ExistsKeyStringWithLength

bool LuaHashMap_ExistsKeyStringWithLength	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string,
		size_t	key_string_length
	)

Returns whether a key/value pair exists in the hash table for a specified key.

Returns whether a key/value pair exists in the hash table for a specified key. string version This version allows you to specify the string length for the string if you already know it as an optimization.

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key to test.
key_string_length	The string length (strlen()) of the key string. (This does not count the \0 terminator character.)

Returns

Returns true if the key/value pair exists in the hash table. Returns false otherwise.

Note

Consider using the GetIteratorForKey + GetCachedValue family of functions if you need to first check for existence and then retrieve the value if it exists.

See Also

LuaHashMap_GetIteratorForKeyString, LuaHashMap_ExistsKeyString