From 269e86b72572a6ba546270e8d22409efc40c2fbd Mon Sep 17 00:00:00 2001 From: Petri Lehtinen Date: Mon, 20 Dec 2010 21:08:04 +0200 Subject: [PATCH] Emphasize the constness of the return value of json_string_value() Closes GH-7. --- doc/apiref.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/apiref.rst b/doc/apiref.rst index e37cb8c..dcc0cbf 100644 --- a/doc/apiref.rst +++ b/doc/apiref.rst @@ -306,6 +306,10 @@ U+10FFFF are allowed. Returns the associated value of *string* as a null terminated UTF-8 encoded string, or *NULL* if *string* is not a JSON string. + The retuned value is read-only and must not be modified or freed by + the user. It is valid as long as *string* exists, i.e. as long as + its reference count has not dropped to zero. + .. function:: int json_string_set(const json_t *string, const char *value) Sets the associated value of *string* to *value*. *value* must be a -- 2.1.4