[sr-dev] git:master:7f6248d1: htable: docs for iterator sets and seti functions

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 7f6248d15e8830d80cc7a898ee53754be2dc76be
URL: https://github.com/kamailio/kamailio/commit/7f6248d15e8830d80cc7a898ee53754be2dc76be

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-10-12T22:19:37+02:00

htable: docs for iterator sets and seti functions

---

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

---

Diff:  https://github.com/kamailio/kamailio/commit/7f6248d15e8830d80cc7a898ee53754be2dc76be.diff
Patch: https://github.com/kamailio/kamailio/commit/7f6248d15e8830d80cc7a898ee53754be2dc76be.patch

---

diff --git a/src/modules/htable/doc/htable_admin.xml b/src/modules/htable/doc/htable_admin.xml
index 6793bff435..dca7cd279a 100644
--- 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>