Browse code

textopsx: docs for hf_iterator_rm()

Daniel-Constantin Mierla authored on 11/07/2021 12:06:07
Showing 1 changed files
... ...
@@ -561,6 +561,34 @@ hf_iterator_end("i1");
561 561
     }
562 562
     hf_iterator_end("i1");
563 563
 ...
564
+</programlisting>
565
+		</example>
566
+	</section>
567
+	<section id="textopsx.f.hf_iterator_rm">
568
+		<title>
569
+		<function moreinfo="none">hf_iterator_rm(iname)</function>
570
+		</title>
571
+		<para>
572
+			Remove the header at the current iterator position.
573
+		</para>
574
+		<para>
575
+			The parameter can be dynamic string with variables.
576
+		</para>
577
+		<para>
578
+			This function can be used from ANY_ROUTE.
579
+		</para>
580
+		<example>
581
+		<title><function>hf_iterator_rm</function> usage</title>
582
+		<programlisting format="linespecific">
583
+...
584
+    hf_iterator_start("i1");
585
+    while(hf_iterator_next("i1")) {
586
+        if($hfitname(i1)=="My-Header") {
587
+            hf_iterator_rm("i1");
588
+        }
589
+    }
590
+    hf_iterator_end("i1");
591
+...
564 592
 </programlisting>
565 593
 		</example>
566 594
 	</section>