48,10 → 48,10 |
|
/** Adds the value with the key to the map. |
* Creates new nodes to map the key. |
* @param map The character string to integer map. Input/output parameter. |
* @param identifier The key zero ('\\0') terminated character string. The key character string is processed until the first terminating zero ('\\0') character after the given length is found. Input parameter. |
* @param length The key character string length. The parameter may be zero (0) which means that the string is processed until the terminating zero ('\\0') character is found. Input parameter. |
* @param value The integral value to be stored for the key character string. Input parameter. |
* @param[in,out] map The character string to integer map. |
* @param[in] identifier The key zero ('\\0') terminated character string. The key character string is processed until the first terminating zero ('\\0') character after the given length is found. |
* @param[in] length The key character string length. The parameter may be zero (0) which means that the string is processed until the terminating zero ('\\0') character is found. |
* @param[in] value The integral value to be stored for the key character string. |
* @returns EOK on success. |
* @returns ENOMEM if there is not enough memory left. |
* @returns EEXIST if the key character string is already used. |
59,9 → 59,9 |
int char_map_add_item( char_map_ref map, const char * identifier, size_t length, const int value ); |
|
/** Returns the node assigned to the key from the map. |
* @param map The character string to integer map. Input parameter. |
* @param identifier The key zero ('\\0') terminated character string. The key character string is processed until the first terminating zero ('\\0') character after the given length is found. Input parameter. |
* @param length The key character string length. The parameter may be zero (0) which means that the string is processed until the terminating zero ('\\0') character is found. Input parameter. |
* @param[in] map The character string to integer map. |
* @param[in] identifier The key zero ('\\0') terminated character string. The key character string is processed until the first terminating zero ('\\0') character after the given length is found. |
* @param[in] length The key character string length. The parameter may be zero (0) which means that the string is processed until the terminating zero ('\\0') character is found. |
* @returns The node holding the integral value assigned to the key character string. |
* @returns NULL if the key is not assigned a node. |
*/ |
68,7 → 68,7 |
char_map_ref char_map_find_node( const char_map_ref map, const char * identifier, const size_t length ); |
|
/** Returns the value assigned to the map. |
* @param map The character string to integer map. Input parameter. |
* @param[in] map The character string to integer map. |
* @returns The integral value assigned to the map. |
* @returns CHAR_MAP_NULL if the map is not assigned a value. |
*/ |
75,7 → 75,7 |
int char_map_get_value( const char_map_ref map ); |
|
/** Checks if the map is valid. |
* @param map The character string to integer map. Input parameter. |
* @param[in] map The character string to integer map. |
* @returns TRUE if the map is valid. |
* @returns FALSE otherwise. |
*/ |