htable: docs for iterator sets and seti functions

kamailio · Oct 12, 2021 · 7f6248d · 7f6248d
1 parent f971ec4
commit 7f6248d
Showing 1 changed file with 50 additions and 0 deletions.
diff --git a/src/modules/htable/doc/htable_admin.xml b/src/modules/htable/doc/htable_admin.xml
@@ -1116,6 +1116,56 @@ sht_iterator_end("i1");
     }
     sht_iterator_end("i1");
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="htable.f.sht_iterator_sets">
+		<title>
+		<function moreinfo="none">sht_iterator_sets(iname, sval)</function>
+		</title>
+		<para>
+			Set the value of the current item to the string in the sval.
+		</para>
+		<para>
+			The parameters can be dynamic strings with variables.
+		</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>sht_iterator_sets</function> usage</title>
+		<programlisting format="linespecific">
+...
+    sht_iterator_start("i1", "h1");
+    sht_iterator_next("i1");
+    sht_iterator_sets("i1", "$ci");
+    sht_iterator_end("i1");
+...
+</programlisting>
+		</example>
+	</section>
+	<section id="htable.f.sht_iterator_seti">
+		<title>
+		<function moreinfo="none">sht_iterator_seti(iname, ival)</function>
+		</title>
+		<para>
+			Set the value of the current item to the integer in the ival.
+		</para>
+		<para>
+			The parameters can be dynamic strings or integers with variables.
+		</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>sht_iterator_seti</function> usage</title>
+		<programlisting format="linespecific">
+...
+    sht_iterator_start("i1", "h1");
+    sht_iterator_next("i1");
+    sht_iterator_seti("i1", "20");
+    sht_iterator_end("i1");
+...
 </programlisting>
 		</example>
 	</section>