[sr-dev] git:master:8616db85: siputils: docs for contact_param_rm()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 8616db8573b7d83b81c4177ac855a1fcbd792445
URL: https://github.com/kamailio/kamailio/commit/8616db8573b7d83b81c4177ac855a1fcbd792445

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-06-15T15:18:55+02:00

siputils: docs for contact_param_rm()

---

Modified: src/modules/siputils/doc/siputils_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/8616db8573b7d83b81c4177ac855a1fcbd792445.diff
Patch: https://github.com/kamailio/kamailio/commit/8616db8573b7d83b81c4177ac855a1fcbd792445.patch

---

diff --git a/src/modules/siputils/doc/siputils_admin.xml b/src/modules/siputils/doc/siputils_admin.xml
index 13b30ba447..6054ddf300 100644
--- a/src/modules/siputils/doc/siputils_admin.xml
+++ b/src/modules/siputils/doc/siputils_admin.xml
@@ -1253,6 +1253,35 @@ if (is_method("INVITE") and src_ip == 1.2.3.4) {
     contact_param_decode_ruri("ksu");
 }
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="siputils.f.contact_param_rm">
+		<title>
+		<function moreinfo="none">contact_param_rm(pname)</function>
+		</title>
+		<para>
+		This function removes the parameter from the URIs inside the Contact
+		headers.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>pname</emphasis> - name of the URI parameter.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
+		</para>
+		<example>
+		<title><function>contact_param_rm</function> usage</title>
+		<programlisting format="linespecific">
+...
+if (is_method("REGISTER") and src_ip == 1.2.3.4) {
+    contact_param_rm("myparam");
+}
+...
 </programlisting>
 		</example>
 	</section>