[sr-dev] git:master:1a96e1a1: siputils: docs for uri_param_rm() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 1a96e1a17a65233a9cff946a1a0ef8237f63cf0c
URL: https://github.com/kamailio/kamailio/commit/1a96e1a17a65233a9cff946a1a0ef8237f63cf0c

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-06-17T08:20:52+02:00

siputils: docs for uri_param_rm() function

---

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

---

Diff:  https://github.com/kamailio/kamailio/commit/1a96e1a17a65233a9cff946a1a0ef8237f63cf0c.diff
Patch: https://github.com/kamailio/kamailio/commit/1a96e1a17a65233a9cff946a1a0ef8237f63cf0c.patch

---

diff --git a/src/modules/siputils/doc/siputils_admin.xml b/src/modules/siputils/doc/siputils_admin.xml
index 6054ddf300..8dd72319c0 100644
--- a/src/modules/siputils/doc/siputils_admin.xml
+++ b/src/modules/siputils/doc/siputils_admin.xml
@@ -502,6 +502,34 @@ add_uri_param("nat=yes");
 ...
 get_uri_param("nat", "$var(nat)");
 ...
+</programlisting>
+		</example>
+	</section>
+	<section>
+		<title id="siputils.f.uri_param_rm">
+		<function moreinfo="none">uri_param_rm(param)</function>
+		</title>
+		<para>
+		Remove parameter from Request URI.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para><emphasis>param</emphasis> - parameter name.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from REQUEST_ROUTE.
+		</para>
+		<example>
+		<title><function>uri_param_rm</function> usage</title>
+		<programlisting format="linespecific">
+...
+if (uri_param_rm("param1")) {
+	...
+}
+...
 </programlisting>
 		</example>
 	</section>