Browse code

htable: docs for sht_rm(htname, itname)

Daniel-Constantin Mierla authored on 09/09/2018 07:01:11
Showing 1 changed files
... ...
@@ -749,6 +749,26 @@ modparam("htable", "event_callback_mode", 1)
749 749
 ...
750 750
 sht_print();
751 751
 ...
752
+</programlisting>
753
+		</example>
754
+	</section>
755
+	<section id="htable.f.sht_rm">
756
+		<title>
757
+		<function moreinfo="none">sht_rm(htname, itname)</function>
758
+		</title>
759
+		<para>
760
+			Delete the item with the name 'itname' from hash table 'htname'.
761
+			This API function equivaluent to '$sht(htname=&gt;itname) = $null'.
762
+		</para>
763
+		<para>
764
+			This function can be used from ANY_ROUTE.
765
+		</para>
766
+		<example>
767
+		<title><function>sht_rm</function> usage</title>
768
+		<programlisting format="linespecific">
769
+...
770
+sht_rm("ha", "test"");
771
+...
752 772
 </programlisting>
753 773
 		</example>
754 774
 	</section>