Dictionary

Category: Built-In Types

Brief Description

Dictionary type.

Member Functions

void	clear ( )
bool	empty ( )
void	erase ( var key )
bool	has ( var key )
bool	has_all ( Array keys )
int	hash ( )
Array	keys ( )
int	parse_json ( String json )
int	size ( )
String	to_json ( )

Description

Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are always passed by reference.

Member Function Description

• void clear ( )

Clear the dictionary, removing all key/value pairs.

• bool empty ( )

Return true if the dictionary is empty.

• void erase ( var key )

Erase a dictionary key/value pair by key.

• bool has ( var key )

Return true if the dictionary has a given key.

• bool has_all ( Array keys )

• int hash ( )

Return a hashed integer value representing the dictionary contents.

• Array keys ( )

Return the list of keys in the dictionary.

• int parse_json ( String json )

Parse json text to the dictionary. Return OK when successed or the error code when failed.

• int size ( )

Return the size of the dictionary (in pairs).

• String to_json ( )

Return the dictionary as json text.