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

Expand the doc for json_object_array_get_idx() to explain that it does not adjust refcounts.

Browse Source
This commit is contained in:
Eric Haszlakiewicz
2020-07-12 17:55:46 +00:00
parent 6542d33cd1
commit 2330c6f0de
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
json_object.h
View File

@@ -593,7 +593,15 @@ JSON_EXPORT int json_object_array_add(struct json_object *obj, struct json_objec
JSON_EXPORT int json_object_array_put_idx(struct json_object *obj, size_t idx,
struct json_object *val);
/** Get the element at specified index of the array (a json_object of type json_type_array)
/** Get the element at specified index of array `obj` (which must be a json_object of type json_type_array)
*
* *No* reference counts will be changed, and ownership of the returned
* object remains with `obj`. See json_object_object_get() for additional
* implications of this behavior.
*
* Calling this with anything other than a json_type_array will trigger
* an assert.
*
* @param obj the json_object instance
* @param idx the index to get the element at
* @returns the json_object at the specified index (or NULL)