Module: kamailio
Branch: master
Commit: 8df69ebca23bde071b08b0ed5b8cd34b2d28446b
URL: 
https://github.com/kamailio/kamailio/commit/8df69ebca23bde071b08b0ed5b8cd34b2d28446b

Author: Daniel-Constantin Mierla <mico...@gmail.com>
Committer: Daniel-Constantin Mierla <mico...@gmail.com>
Date: 2024-06-25T13:00:08+02:00

pv: docs for xavp_xparams_explode(...)

---

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

---

Diff:  
https://github.com/kamailio/kamailio/commit/8df69ebca23bde071b08b0ed5b8cd34b2d28446b.diff
Patch: 
https://github.com/kamailio/kamailio/commit/8df69ebca23bde071b08b0ed5b8cd34b2d28446b.patch

---

diff --git a/src/modules/pv/doc/pv_admin.xml b/src/modules/pv/doc/pv_admin.xml
index 1f91e633a00..6a06bb717de 100644
--- a/src/modules/pv/doc/pv_admin.xml
+++ b/src/modules/pv/doc/pv_admin.xml
@@ -387,6 +387,39 @@ 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_xparams_explode">
+                       <title>
+                               <function 
moreinfo="none">xavp_xparams_explode(sparams, sep, xname)</function>
+                       </title>
+                       <para>
+                               Convert a parameters string in xavp attributes.
+                       </para>
+                       <para>
+                               The first parameter has to be a string in 
similar format of SIP header
+                               parameters (name1=value1;...;nameN=valueN), but 
the separator can
+                               be other character than ';'. The second 
parameter is the separator
+                               for the parameters list. The third parameter is 
the name of the
+                               root xavp to hold the pairs (nameX,valueX).
+                       </para>
+                       <para>
+                               The values are stored as string type.
+                       </para>
+                       <para>
+                       Function can be used from ANY ROUTE.
+                       </para>
+                       <example>
+                               
<title><function>xavp_xparams_explode</function> usage</title>
+                               <programlisting format="linespecific">
+...
+xavp_xparams_explode("a=b,c=d,e=d", ",", "x");
+# results in:
+#    $xavp(x=&gt;a) = "b";
+#    $xavp(x=&gt;c) = "d";
+#    $xavp(x=&gt;e) = "f";
 ...
                                </programlisting>
                        </example>
@@ -1132,4 +1165,3 @@ $ &kamcmd; pv.shvGet debug
        </section>
 
 </chapter>
-

_______________________________________________
Kamailio (SER) - Development Mailing List
To unsubscribe send an email to sr-dev-le...@lists.kamailio.org

Reply via email to