Browse code

modules: readme files regenerated - textopsx ... [skip ci]

Kamailio Dev authored on 12/07/2021 06:16:23
Showing 1 changed files
... ...
@@ -37,6 +37,7 @@ Daniel-Constantin Mierla
37 37
               2.16. hf_iterator_start(iname)
38 38
               2.17. hf_iterator_end(iname)
39 39
               2.18. textopsx.f.hf_iterator_next(iname)
40
+              2.19. hf_iterator_rm(iname)
40 41
 
41 42
         3. Selects
42 43
 
... ...
@@ -64,7 +65,8 @@ Daniel-Constantin Mierla
64 65
    1.16. hf_iterator_start usage
65 66
    1.17. hf_iterator_end usage
66 67
    1.18. hf_iterator_next usage
67
-   1.19. @hf_value select usage
68
+   1.19. hf_iterator_rm usage
69
+   1.20. @hf_value select usage
68 70
 
69 71
 Chapter 1. Admin Guide
70 72
 
... ...
@@ -91,6 +93,7 @@ Chapter 1. Admin Guide
91 93
         2.16. hf_iterator_start(iname)
92 94
         2.17. hf_iterator_end(iname)
93 95
         2.18. textopsx.f.hf_iterator_next(iname)
96
+        2.19. hf_iterator_rm(iname)
94 97
 
95 98
    3. Selects
96 99
 
... ...
@@ -128,6 +131,7 @@ Chapter 1. Admin Guide
128 131
    2.16. hf_iterator_start(iname)
129 132
    2.17. hf_iterator_end(iname)
130 133
    2.18. textopsx.f.hf_iterator_next(iname)
134
+   2.19. hf_iterator_rm(iname)
131 135
 
132 136
 2.1.  msg_apply_changes()
133 137
 
... ...
@@ -470,6 +474,25 @@ hf_iterator_end("i1");
470 474
     hf_iterator_end("i1");
471 475
 ...
472 476
 
477
+2.19.  hf_iterator_rm(iname)
478
+
479
+   Remove the header at the current iterator position.
480
+
481
+   The parameter can be dynamic string with variables.
482
+
483
+   This function can be used from ANY_ROUTE.
484
+
485
+   Example 1.19. hf_iterator_rm usage
486
+...
487
+    hf_iterator_start("i1");
488
+    while(hf_iterator_next("i1")) {
489
+        if($hfitname(i1)=="My-Header") {
490
+            hf_iterator_rm("i1");
491
+        }
492
+    }
493
+    hf_iterator_end("i1");
494
+...
495
+
473 496
 3. Selects
474 497
 
475 498
    3.1. @hf_value
... ...
@@ -505,7 +528,7 @@ hf_iterator_end("i1");
505 528
      * IDX - Value index, negative value counts from bottom
506 529
      * PARAM_NAME - name of parameter
507 530
 
508
-   Example 1.19. @hf_value select usage
531
+   Example 1.20. @hf_value select usage
509 532
 ...
510 533
 $a = @hf_value.my_header[1].my_param;
511 534
 xplog("L_ERR", "$sel(@hf_value.via[-1]), $sel(@hf_value.from.tag)\n");