jansson Update jansson_get doc with return values that was hidden in the source code
authorOlle E. Johansson <oej@edvina.net>
Thu, 21 Apr 2016 16:19:03 +0000 (18:19 +0200)
committerOlle E. Johansson <oej@edvina.net>
Thu, 21 Apr 2016 16:21:43 +0000 (18:21 +0200)
modules/jansson/README
modules/jansson/doc/jansson_admin.xml

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)
index baab686..344de6c 100644 (file)
@@ -72,6 +72,9 @@
         <para>
             The path string supports dot delimited notation (e.g. foo.bar.baz), array notation (e.g. [0]), or a combination of the two (e.g. foo.bar[0][1].baz).
         </para>
+        <para>
+            Returns FALSE if the data can not be parsed, TRUE otherwise.
+        </para>
         <para>
             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
         <title><function>jansson_get</function> usage</title>
         <programlisting format="linespecific">
 ...
-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)");
 ...
         </programlisting>
         </example>