jansson Update jansson_get doc with return values that was hidden in the source code
[sip-router] / modules / jansson / README
index 87d28a8..113fb9a 100644 (file)
@@ -110,6 +110,8 @@ Chapter 1. Admin Guide
    array notation (e.g. [0]), or a combination of the two (e.g.
    foo.bar[0][1].baz).
 
+   Returns FALSE if the data can not be parsed, TRUE otherwise.
+
    The function can put a string, integer, null, or new json string into
    destination. If the key/path can't be found in the JSON data structure,
    the pvar is not changed. If it had a previous value, that value remains
@@ -117,8 +119,10 @@ Chapter 1. Admin Guide
 
    Example 1.1. jansson_get usage
 ...
-jansson_get("inner.deep.list[3]", $var(myjson), "$var(n)");
-xlog("foo is $var(n)");
+if(!jansson_get("inner.deep.list[3]", $var(myjson), "$var(n)")) {
+        xlog("L_ERR", "Can't parse json data");
+}
+xlog("L_INFO", "foo is $var(n)");
 ...
 
 4.2. jansson_set(type, key/path, value, result)