core: add commment in function string_shared_get (returned value must not be changed)

v2.8-utf8proc
Sebastien Helleu 2013-08-17 17:44:10 +02:00
parent 674403f734
commit cc1523b654
1 changed files with 3 additions and 0 deletions

View File

@ -2341,6 +2341,9 @@ string_shared_free_key (struct t_hashtable *hashtable,
* reference count), NULL if error.
* The string returned has exactly same content as string received in argument,
* but the pointer to the string is different.
*
* IMPORTANT: the returned string must NEVER be changed in any way, because it
* is used itself as the key of the hashtable.
*/
const char *