mirror/json-c
1
0
Fork 0
mirror of https://github.com/json-c/json-c.git synced 2026-03-22 22:49:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify json_object_get_string documentation of NULL handling & returning

Browse Source
This commit is contained in:
Mina Naguib
2016-02-07 20:55:25 -05:00
parent 537f8bcbdb
commit 138c2a6b97
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
json_object.h
View File

@@ -670,14 +670,19 @@ extern struct json_object* json_object_new_string_len(const char *s, int len);
/** Get the string value of a json_object
*
* If the passed object is not of type json_type_string then the JSON
* representation of the object is returned.
* If the passed object is of type json_type_null (i.e. obj == NULL),
* NULL is returned.
*
* If the passed object of type json_type_string, the string contents
* are returned.
*
* Otherwise the JSON representation of the object is returned.
*
* The returned string memory is managed by the json_object and will
* be freed when the reference count of the json_object drops to zero.
*
* @param obj the json_object instance
* @returns a string
* @returns a string or NULL
*/
extern const char* json_object_get_string(struct json_object *obj);