Browse code

htable: docs for iterator sets and seti functions

Daniel-Constantin Mierla authored on 12/10/2021 20:19:37
Showing 1 changed files
... ...
@@ -1116,6 +1116,56 @@ sht_iterator_end("i1");
1116 1116
     }
1117 1117
     sht_iterator_end("i1");
1118 1118
 ...
1119
+</programlisting>
1120
+		</example>
1121
+	</section>
1122
+	<section id="htable.f.sht_iterator_sets">
1123
+		<title>
1124
+		<function moreinfo="none">sht_iterator_sets(iname, sval)</function>
1125
+		</title>
1126
+		<para>
1127
+			Set the value of the current item to the string in the sval.
1128
+		</para>
1129
+		<para>
1130
+			The parameters can be dynamic strings with variables.
1131
+		</para>
1132
+		<para>
1133
+			This function can be used from ANY_ROUTE.
1134
+		</para>
1135
+		<example>
1136
+		<title><function>sht_iterator_sets</function> usage</title>
1137
+		<programlisting format="linespecific">
1138
+...
1139
+    sht_iterator_start("i1", "h1");
1140
+    sht_iterator_next("i1");
1141
+    sht_iterator_sets("i1", "$ci");
1142
+    sht_iterator_end("i1");
1143
+...
1144
+</programlisting>
1145
+		</example>
1146
+	</section>
1147
+	<section id="htable.f.sht_iterator_seti">
1148
+		<title>
1149
+		<function moreinfo="none">sht_iterator_seti(iname, ival)</function>
1150
+		</title>
1151
+		<para>
1152
+			Set the value of the current item to the integer in the ival.
1153
+		</para>
1154
+		<para>
1155
+			The parameters can be dynamic strings or integers with variables.
1156
+		</para>
1157
+		<para>
1158
+			This function can be used from ANY_ROUTE.
1159
+		</para>
1160
+		<example>
1161
+		<title><function>sht_iterator_seti</function> usage</title>
1162
+		<programlisting format="linespecific">
1163
+...
1164
+    sht_iterator_start("i1", "h1");
1165
+    sht_iterator_next("i1");
1166
+    sht_iterator_seti("i1", "20");
1167
+    sht_iterator_end("i1");
1168
+...
1119 1169
 </programlisting>
1120 1170
 		</example>
1121 1171
 	</section>