[sr-dev] git:master:40518b64: htable: docs for sht_rm(htname, itname)

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 40518b640f1811dd65196bd08e0460dff4e7040a
URL: https://github.com/kamailio/kamailio/commit/40518b640f1811dd65196bd08e0460dff4e7040a

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-09-09T09:01:11+02:00

htable: docs for sht_rm(htname, itname)

---

Modified: src/modules/htable/doc/htable_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/40518b640f1811dd65196bd08e0460dff4e7040a.diff
Patch: https://github.com/kamailio/kamailio/commit/40518b640f1811dd65196bd08e0460dff4e7040a.patch

---

diff --git a/src/modules/htable/doc/htable_admin.xml b/src/modules/htable/doc/htable_admin.xml
index 6a8492a94e..e67e7cc74b 100644
--- a/src/modules/htable/doc/htable_admin.xml
+++ b/src/modules/htable/doc/htable_admin.xml
@@ -749,6 +749,26 @@ modparam("htable", "event_callback_mode", 1)
 ...
 sht_print();
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="htable.f.sht_rm">
+		<title>
+		<function moreinfo="none">sht_rm(htname, itname)</function>
+		</title>
+		<para>
+			Delete the item with the name 'itname' from hash table 'htname'.
+			This API function equivaluent to '$sht(htname=>itname) = $null'.
+		</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>sht_rm</function> usage</title>
+		<programlisting format="linespecific">
+...
+sht_rm("ha", "test"");
+...
 </programlisting>
 		</example>
 	</section>