Functions
const char *	LuaHashMap_GetValueStringForKeyString (LuaHashMap restrict hash_map, const char restrict key_string)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyStringWithLength (LuaHashMap restrict hash_map, const char restrict key_string, size_t *restrict value_string_length_return, size_t key_string_length)
	Returns the value for specified key in the hash table.

void *	LuaHashMap_GetValuePointerForKeyString (LuaHashMap restrict hash_map, const char restrict key_string)
	Returns the value for specified key in the hash table.

void *	LuaHashMap_GetValuePointerForKeyStringWithLength (LuaHashMap restrict hash_map, const char restrict key_string, size_t key_string_length)
	Returns the value for specified key in the hash table.

lua_Number	LuaHashMap_GetValueNumberForKeyString (LuaHashMap restrict hash_map, const char restrict key_string)
	Returns the value for specified key in the hash table.

lua_Number	LuaHashMap_GetValueNumberForKeyStringWithLength (LuaHashMap restrict hash_map, const char restrict key_string, size_t key_string_length)
	Returns the value for specified key in the hash table.

lua_Integer	LuaHashMap_GetValueIntegerForKeyString (LuaHashMap restrict hash_map, const char restrict key_string)
	Returns the value for specified key in the hash table.

lua_Integer	LuaHashMap_GetValueIntegerForKeyStringWithLength (LuaHashMap restrict hash_map, const char restrict key_string, size_t key_string_length)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyPointer (LuaHashMap hash_map, void key_pointer)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyPointerWithLength (LuaHashMap hash_map, void key_pointer, size_t *value_string_length_return)
	Returns the value for specified key in the hash table.

void *	LuaHashMap_GetValuePointerForKeyPointer (LuaHashMap hash_map, void key_pointer)
	Returns the value for specified key in the hash table.

lua_Number	LuaHashMap_GetValueNumberForKeyPointer (LuaHashMap hash_map, void key_pointer)
	Returns the value for specified key in the hash table.

lua_Integer	LuaHashMap_GetValueIntegerForKeyPointer (LuaHashMap hash_map, void key_pointer)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyNumberWithLength (LuaHashMap restrict hash_map, lua_Number key_number, size_t restrict value_string_length_return)
	Returns the value for specified key in the hash table.

void *	LuaHashMap_GetValuePointerForKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
	Returns the value for specified key in the hash table.

lua_Number	LuaHashMap_GetValueNumberForKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
	Returns the value for specified key in the hash table.

lua_Integer	LuaHashMap_GetValueIntegerForKeyNumber (LuaHashMap *hash_map, lua_Number key_number)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
	Returns the value for specified key in the hash table.

const char *	LuaHashMap_GetValueStringForKeyIntegerWithLength (LuaHashMap restrict hash_map, lua_Integer key_integer, size_t restrict value_string_length_return)
	Returns the value for specified key in the hash table.

void *	LuaHashMap_GetValuePointerForKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
	Returns the value for specified key in the hash table.

lua_Number	LuaHashMap_GetValueNumberForKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
	Returns the value for specified key in the hash table.

lua_Integer	LuaHashMap_GetValueIntegerForKeyInteger (LuaHashMap *hash_map, lua_Integer key_integer)
	Returns the value for specified key in the hash table.

Detailed Description

Function Documentation

lua_Integer LuaHashMap_GetValueIntegerForKeyInteger	(	LuaHashMap *	hash_map,
		lua_Integer	key_integer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <integer, integer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_integer	The key for the value.

Returns: Returns the value for the key. Returns 0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyInteger

lua_Integer LuaHashMap_GetValueIntegerForKeyNumber	(	LuaHashMap *	hash_map,
		lua_Number	key_number
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <number, integer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_number	The key for the value.

Returns: Returns the value for the key. Returns 0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyNumber

lua_Integer LuaHashMap_GetValueIntegerForKeyPointer	(	LuaHashMap *	hash_map,
		void *	key_pointer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <pointer, integer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_pointer	The key for the value.

Returns: Returns the value for the key. Returns 0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyPointer

lua_Integer LuaHashMap_GetValueIntegerForKeyString	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, integer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key for the value. NULL key strings disallowed and the operation will simply return NULL.

Returns: Returns the value for the key. Returns 0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyString

lua_Integer LuaHashMap_GetValueIntegerForKeyStringWithLength	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string,
		size_t	key_string_length
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, integer> 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 for the value. NULL key strings disallowed and the operation will simply return NULL.
key_string_length	The string length (strlen()) of the key string. (This does not count the \0 terminator character.)

Returns: Returns the value for the key. Returns 0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetValueIntegerForKeyString, LuaHashMap_GetIteratorForKeyString

lua_Number LuaHashMap_GetValueNumberForKeyInteger	(	LuaHashMap *	hash_map,
		lua_Integer	key_integer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <integer, number> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_integer	The key for the value.

Returns: Returns the value for the key. Returns 0.0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyInteger

lua_Number LuaHashMap_GetValueNumberForKeyNumber	(	LuaHashMap *	hash_map,
		lua_Number	key_number
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <number, number> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_number	The key for the value.

Returns: Returns the value for the key. Returns 0.0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyNumber

lua_Number LuaHashMap_GetValueNumberForKeyPointer	(	LuaHashMap *	hash_map,
		void *	key_pointer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <pointer, number> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_pointer	The key for the value.

Returns: Returns the value for the key. Returns 0.0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyPointer

lua_Number LuaHashMap_GetValueNumberForKeyString	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, number> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key for the value. NULL key strings disallowed and the operation will simply return NULL.

Returns: Returns the value for the key. Returns 0.0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyString

lua_Number LuaHashMap_GetValueNumberForKeyStringWithLength	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string,
		size_t	key_string_length
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, number> 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 for the value. NULL key strings disallowed and the operation will simply return NULL.
key_string_length	The string length (strlen()) of the key string. (This does not count the \0 terminator character.)

Returns: Returns the value for the key. Returns 0.0 if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetValueNumberForKeyString, LuaHashMap_GetIteratorForKeyString

void* LuaHashMap_GetValuePointerForKeyInteger	(	LuaHashMap *	hash_map,
		lua_Integer	key_integer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <integer, pointer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_integer	The key for the value.

Returns: Returns the value for the key. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyInteger

void* LuaHashMap_GetValuePointerForKeyNumber	(	LuaHashMap *	hash_map,
		lua_Number	key_number
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <number, pointer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_number	The key for the value.

Returns: Returns the value for the key. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyNumber

void* LuaHashMap_GetValuePointerForKeyPointer	(	LuaHashMap *	hash_map,
		void *	key_pointer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <pointer, pointer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_pointer	The key for the value.

Returns: Returns the value for the key. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyPointer

void* LuaHashMap_GetValuePointerForKeyString	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, pointer> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key for the value. NULL key strings disallowed and the operation will simply return NULL.

Returns: Returns the value for the key. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyString

void* LuaHashMap_GetValuePointerForKeyStringWithLength	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string,
		size_t	key_string_length
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, pointer> 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 for the value. NULL key strings disallowed and the operation will simply return NULL.
key_string_length	The string length (strlen()) of the key string. (This does not count the \0 terminator character.)

Returns: Returns the value for the key. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetValuePointerForKeyString, LuaHashMap_GetIteratorForKeyString

const char* LuaHashMap_GetValueStringForKeyInteger	(	LuaHashMap *	hash_map,
		lua_Integer	key_integer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <integer, string> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_integer	The key for the value.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyInteger, LuaHashMap_GetValueStringForKeyIntegerWithLength

const char* LuaHashMap_GetValueStringForKeyIntegerWithLength	(	LuaHashMap *restrict	hash_map,
		lua_Integer	key_integer,
		size_t *restrict	value_string_length_return
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <integer, 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_integer	The key for the value.
value_string_length_return	This returns by reference the string length (strlen()) of the returned value string. You may pass NULL to ignore this result.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyInteger, LuaHashMap_GetValueStringForKeyInteger

const char* LuaHashMap_GetValueStringForKeyNumber	(	LuaHashMap *	hash_map,
		lua_Number	key_number
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <number, string> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_number	The key for the value.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyNumber, LuaHashMap_GetValueStringForKeyNumberWithLength

const char* LuaHashMap_GetValueStringForKeyNumberWithLength	(	LuaHashMap *restrict	hash_map,
		lua_Number	key_number,
		size_t *restrict	value_string_length_return
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <number, 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_number	The key for the value.
value_string_length_return	This returns by reference the string length (strlen()) of the returned value string. You may pass NULL to ignore this result.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyNumber, LuaHashMap_GetValueStringForKeyNumber

const char* LuaHashMap_GetValueStringForKeyPointer	(	LuaHashMap *	hash_map,
		void *	key_pointer
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <pointer, string> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_pointer	The key for the value.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyPointer, LuaHashMap_GetValueStringForKeyPointerWithLength

const char* LuaHashMap_GetValueStringForKeyPointerWithLength	(	LuaHashMap *	hash_map,
		void *	key_pointer,
		size_t *	value_string_length_return
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <pointer, 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_pointer	The key for the value.
value_string_length_return	This returns by reference the string length (strlen()) of the returned value string. You may pass NULL to ignore this result.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetValueStringForKeyPointer, LuaHashMap_GetIteratorForKeyPointer

const char* LuaHashMap_GetValueStringForKeyString	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, string> version

Parameters

hash_map	The LuaHashMap instance to operate on.
key_string	The key for the value. NULL key strings disallowed and the operation will simply return NULL.

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetIteratorForKeyString, LuaHashMap_GetValueStringForKeyStringWithLength

const char* LuaHashMap_GetValueStringForKeyStringWithLength	(	LuaHashMap *restrict	hash_map,
		const char *restrict	key_string,
		size_t *restrict	value_string_length_return,
		size_t	key_string_length
	)

Returns the value for specified key in the hash table.

Returns the value for specified key in the hash table. <string, 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 for the value. NULL key strings disallowed and the operation will simply return NULL.
value_string_length_return	This returns by reference the string length (strlen()) of the returned value string. You may pass NULL to ignore this result.
key_string_length	The string length (strlen()) of the key string. (This does not count the \0 terminator character.)

Returns: Returns the Lua internalized pointer for the key string. Returns NULL if not found.

Note: Consider using the GetIteratorForKey family of functions if you need to distinguish between a failed look up and an empty value.

See Also: LuaHashMap_GetValueStringForKeyString, LuaHashMap_GetIteratorForKeyString

Functions

Detailed Description

Function Documentation