api doc: get_value_string(): mention composition in static buffer

Change-Id: I93dad98711ef69f8a1e196efa029a842a1ff5bd6
Reviewed-on: https://gerrit.osmocom.org/229
Reviewed-by: Harald Welte <laforge@gnumonks.org>
Tested-by: Jenkins Builder
This commit is contained in:
Neels Hofmeyr 2016-06-13 13:16:58 +02:00
parent 6cf8eba4ec
commit 8a3c83ed00
1 changed files with 4 additions and 0 deletions

View File

@ -43,6 +43,10 @@ static char namebuf[255];
* \param[in] vs Array of value_string tuples
* \param[in] val Value to be converted
* \returns pointer to human-readable string
*
* If val is found in vs, the array's string entry is returned. Otherwise, an
* "unknown" string containing the actual value is composed in a static buffer
* that is reused across invocations.
*/
const char *get_value_string(const struct value_string *vs, uint32_t val)
{