Module: kamailio
Branch: master
Commit: fb2be3855c5971d312bad52ffc3c4cb99aeb63d8
URL: https://github.com/kamailio/kamailio/commit/fb2be3855c5971d312bad52ffc3c4cb…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2023-09-11T14:32:58+02:00
textops: docs for via_param_rm(...)
---
Modified: src/modules/textops/doc/textops_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/fb2be3855c5971d312bad52ffc3c4cb…
Patch: https://github.com/kamailio/kamailio/commit/fb2be3855c5971d312bad52ffc3c4cb…
---
diff --git a/src/modules/textops/doc/textops_admin.xml b/src/modules/textops/doc/textops_admin.xml
index 4af7a8bb805..9c121e51c70 100644
--- a/src/modules/textops/doc/textops_admin.xml
+++ b/src/modules/textops/doc/textops_admin.xml
@@ -2303,5 +2303,40 @@ msg_apply_changes();
</example>
</section>
+ <section id="textops.f.via_param_rm">
+ <title>
+ <function moreinfo="none">via_param_rm(name, idx)</function>
+ </title>
+ <para>
+ Remove parameter matching by name from Via body at the specified index.
+ The index starts from 0 (first Via body). Negative index counts from the
+ end of the list for Via header bodies (-1 is the last Via body).
+ </para>
+ <para>Meaning of the parameters is as follows:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>name</emphasis> - name of the parameter
+ </para>
+ </listitem>
+ <listitem>
+ <para><emphasis>idx</emphasis> - index of the Via body.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>The parameters can also be variables.</para>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+
+ <example>
+ <title><function>via_param_rm</function> usage</title>
+ <programlisting format="linespecific">
+...
+via_param_rm("p1", "0");
+...
+</programlisting>
+ </example>
+ </section>
+
</section>
</chapter>