77,10 → 77,10 |
}; |
|
/** Adds the value with the key to the map. |
* @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 EINVAL if the map is not valid. |
* @returns EINVAL if the identifier parameter is NULL. |
91,15 → 91,15 |
int char_map_add( char_map_ref map, const char * identifier, size_t length, const int value ); |
|
/** Clears and destroys the map. |
* @param map The character string to integer map. Input/output parameter. |
* @param[in,out] map The character string to integer map. |
*/ |
void char_map_destroy( char_map_ref map ); |
|
/** Excludes the value assigned to the key from the map. |
* The entry is cleared from the map. |
* @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[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. |
* @returns The integral value assigned to the key character string. |
* @returns CHAR_MAP_NULL if the key is not assigned a value. |
*/ |
106,9 → 106,9 |
int char_map_exclude( char_map_ref map, const char * identifier, size_t length ); |
|
/** Returns the value 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 integral value assigned to the key character string. |
* @returns CHAR_MAP_NULL if the key is not assigned a value. |
*/ |
115,7 → 115,7 |
int char_map_find( const char_map_ref map, const char * identifier, size_t length ); |
|
/** Initializes the map. |
* @param map The character string to integer map. Input/output parameter. |
* @param[in,out] map The character string to integer map. |
* @returns EOK on success. |
* @returns EINVAL if the map parameter is NULL. |
* @returns ENOMEM if there is not enough memory left. |
123,10 → 123,10 |
int char_map_initialize( char_map_ref map ); |
|
/** Adds or updates the value with the key to the map. |
* @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 EINVAL if the map is not valid. |
* @returns EINVAL if the identifier parameter is NULL. |