Module: kamailio
Branch: master
Commit: 42c8595e58e31806ecfc6201d47d7c5957e7522c
URL: 
https://github.com/kamailio/kamailio/commit/42c8595e58e31806ecfc6201d47d7c5957e7522c

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date: 2018-04-20T12:38:17+02:00

pv: docs for xavp_params_implode(...) function

---

Modified: src/modules/pv/doc/pv_admin.xml

---

Diff:  
https://github.com/kamailio/kamailio/commit/42c8595e58e31806ecfc6201d47d7c5957e7522c.diff
Patch: 
https://github.com/kamailio/kamailio/commit/42c8595e58e31806ecfc6201d47d7c5957e7522c.patch

---

diff --git a/src/modules/pv/doc/pv_admin.xml b/src/modules/pv/doc/pv_admin.xml
index 61209f1898..f5faa0ab11 100644
--- a/src/modules/pv/doc/pv_admin.xml
+++ b/src/modules/pv/doc/pv_admin.xml
@@ -292,6 +292,37 @@ xavp_params_explode("a=b;c=d;e=d", "x");
 #    $xavp(x=&gt;a) = "b";
 #    $xavp(x=&gt;c) = "d";
 #    $xavp(x=&gt;e) = "f";
+...
+                               </programlisting>
+                       </example>
+               </section>
+               <section id="pv.f.xavp_params_implode">
+                       <title>
+                               <function 
moreinfo="none">xavp_params_implode(xname, pvname)</function>
+                       </title>
+                       <para>
+                               Serialize the subfields in an XAVP to a 
parameters string format.
+                       </para>
+                       <para>
+                               The first parameter has to be the name of XAVP 
(only the string
+                               name, not the in $xavp(name)). The second 
parameter
+                               is the name of output variable (in full name, 
like $var(output)).
+                       </para>
+                       <para>
+                               The value is stored as string type.
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               <title><function>xavp_params_implode</function> 
usage</title>
+                               <programlisting format="linespecific">
+...
+$xavp(x=&gt;e) = "f";
+$xavp(x[0]=&gt;c) = "d";
+$xavp(x[0]=&gt;a) = "b";
+xavp_params_implode("x", "$var(out)");
+# results in: $var(out) is "a=b;c=d;e=f;"
 ...
                                </programlisting>
                        </example>


_______________________________________________
Kamailio (SER) - Development Mailing List
[email protected]
https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to