LuaHashMap  1.0.0
 All Data Structures Files Functions Variables Typedefs Macros Groups Pages
Functions
RemoveKey family of functions

Functions

void LuaHashMap_RemoveKeyString (LuaHashMap *restrict hash_map, const char *restrict key_string)
 Removes a key/value pair in the hash table for a specified key.
 
void LuaHashMap_RemoveKeyStringWithLength (LuaHashMap *restrict hash_map, const char *restrict key_string, size_t key_string_length)
 Removes a key/value pair in the hash table for a specified key.
 
void LuaHashMap_RemoveKeyPointer (LuaHashMap *hash_map, void *key_pointer)
 Removes a key/value pair in the hash table for a specified key.
 
void LuaHashMap_RemoveKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
 Removes a key/value pair in the hash table for a specified key.
 
void LuaHashMap_RemoveKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
 Removes a key/value pair in the hash table for a specified key.
 

Detailed Description

Function Documentation

void LuaHashMap_RemoveKeyInteger ( LuaHashMap hash_map,
lua_Integer  key_integer 
)

Removes a key/value pair in the hash table for a specified key.

Removes a key/value pair in the hash table for a specified key. integer version It is safe to try to remove a key that doesn't exist.

Parameters
hash_mapThe LuaHashMap instance to operate on.
key_integerThe key to remove.
void LuaHashMap_RemoveKeyNumber ( LuaHashMap hash_map,
lua_Number  key_number 
)

Removes a key/value pair in the hash table for a specified key.

Removes a key/value pair in the hash table for a specified key. number version It is safe to try to remove a key that doesn't exist.

Parameters
hash_mapThe LuaHashMap instance to operate on.
key_numberThe key to remove.
void LuaHashMap_RemoveKeyPointer ( LuaHashMap hash_map,
void *  key_pointer 
)

Removes a key/value pair in the hash table for a specified key.

Removes a key/value pair in the hash table for a specified key. pointer version It is safe to try to remove a key that doesn't exist.

Parameters
hash_mapThe LuaHashMap instance to operate on.
key_pointerThe key to remove.
void LuaHashMap_RemoveKeyString ( LuaHashMap *restrict  hash_map,
const char *restrict  key_string 
)

Removes a key/value pair in the hash table for a specified key.

Removes a key/value pair in the hash table for a specified key. string version It is safe to try to remove a key that doesn't exist.

Parameters
hash_mapThe LuaHashMap instance to operate on.
key_stringThe key to remove.
void LuaHashMap_RemoveKeyStringWithLength ( LuaHashMap *restrict  hash_map,
const char *restrict  key_string,
size_t  key_string_length 
)

Removes a key/value pair in the hash table for a specified key.

Removes a key/value pair 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. It is safe to try to remove a key that doesn't exist.

Parameters
hash_mapThe LuaHashMap instance to operate on.
key_stringThe key to remove.
key_string_lengthThe string length (strlen()) of the key string. (This does not count the \0 terminator character.)