Browse code

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

Kamailio Dev authored on 30/07/2021 07:31:22
Showing 1 changed files
... ...
@@ -37,9 +37,10 @@ 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)
41
-              2.20. hf_iterator_append(iname, htext)
42
-              2.21. hf_iterator_insert(iname, htext)
40
+              2.19. textopsx.f.hf_iterator_prev(iname)
41
+              2.20. hf_iterator_rm(iname)
42
+              2.21. hf_iterator_append(iname, htext)
43
+              2.22. hf_iterator_insert(iname, htext)
43 44
 
44 45
         3. Selects
45 46
 
... ...
@@ -67,10 +68,11 @@ Daniel-Constantin Mierla
67 68
    1.16. hf_iterator_start usage
68 69
    1.17. hf_iterator_end usage
69 70
    1.18. hf_iterator_next usage
70
-   1.19. hf_iterator_rm usage
71
-   1.20. hf_iterator_append usage
72
-   1.21. hf_iterator_insert usage
73
-   1.22. @hf_value select usage
71
+   1.19. hf_iterator_prev usage
72
+   1.20. hf_iterator_rm usage
73
+   1.21. hf_iterator_append usage
74
+   1.22. hf_iterator_insert usage
75
+   1.23. @hf_value select usage
74 76
 
75 77
 Chapter 1. Admin Guide
76 78
 
... ...
@@ -97,9 +99,10 @@ Chapter 1. Admin Guide
97 99
         2.16. hf_iterator_start(iname)
98 100
         2.17. hf_iterator_end(iname)
99 101
         2.18. textopsx.f.hf_iterator_next(iname)
100
-        2.19. hf_iterator_rm(iname)
101
-        2.20. hf_iterator_append(iname, htext)
102
-        2.21. hf_iterator_insert(iname, htext)
102
+        2.19. textopsx.f.hf_iterator_prev(iname)
103
+        2.20. hf_iterator_rm(iname)
104
+        2.21. hf_iterator_append(iname, htext)
105
+        2.22. hf_iterator_insert(iname, htext)
103 106
 
104 107
    3. Selects
105 108
 
... ...
@@ -137,9 +140,10 @@ Chapter 1. Admin Guide
137 140
    2.16. hf_iterator_start(iname)
138 141
    2.17. hf_iterator_end(iname)
139 142
    2.18. textopsx.f.hf_iterator_next(iname)
140
-   2.19. hf_iterator_rm(iname)
141
-   2.20. hf_iterator_append(iname, htext)
142
-   2.21. hf_iterator_insert(iname, htext)
143
+   2.19. textopsx.f.hf_iterator_prev(iname)
144
+   2.20. hf_iterator_rm(iname)
145
+   2.21. hf_iterator_append(iname, htext)
146
+   2.22. hf_iterator_insert(iname, htext)
143 147
 
144 148
 2.1.  msg_apply_changes()
145 149
 
... ...
@@ -482,7 +486,28 @@ hf_iterator_end("i1");
482 486
     hf_iterator_end("i1");
483 487
 ...
484 488
 
485
-2.19.  hf_iterator_rm(iname)
489
+2.19.  textopsx.f.hf_iterator_prev(iname)
490
+
491
+   Move the iterator to the previous header. It must be called also after
492
+   sht_iterator_start() and sht_iterator_next().
493
+
494
+   The parameter can be dynamic string with variables.
495
+
496
+   This function can be used from ANY_ROUTE.
497
+
498
+   Example 1.19. hf_iterator_prev usage
499
+...
500
+    hf_iterator_start("i1");
501
+    hf_iterator_next("i1");
502
+...
503
+    hf_iterator_next("i1");
504
+...
505
+    hf_iterator_prev("i1");
506
+...
507
+    hf_iterator_end("i1");
508
+...
509
+
510
+2.20.  hf_iterator_rm(iname)
486 511
 
487 512
    Remove the header at the current iterator position.
488 513
 
... ...
@@ -490,7 +515,7 @@ hf_iterator_end("i1");
490 515
 
491 516
    This function can be used from ANY_ROUTE.
492 517
 
493
-   Example 1.19. hf_iterator_rm usage
518
+   Example 1.20. hf_iterator_rm usage
494 519
 ...
495 520
     hf_iterator_start("i1");
496 521
     while(hf_iterator_next("i1")) {
... ...
@@ -501,7 +526,7 @@ hf_iterator_end("i1");
501 526
     hf_iterator_end("i1");
502 527
 ...
503 528
 
504
-2.20.  hf_iterator_append(iname, htext)
529
+2.21.  hf_iterator_append(iname, htext)
505 530
 
506 531
    Add headers after the one at the current iterator possition.
507 532
 
... ...
@@ -509,7 +534,7 @@ hf_iterator_end("i1");
509 534
 
510 535
    This function can be used from ANY_ROUTE.
511 536
 
512
-   Example 1.20. hf_iterator_append usage
537
+   Example 1.21. hf_iterator_append usage
513 538
 ...
514 539
     hf_iterator_start("i1");
515 540
     while(hf_iterator_next("i1")) {
... ...
@@ -521,7 +546,7 @@ hf_iterator_end("i1");
521 546
     hf_iterator_end("i1");
522 547
 ...
523 548
 
524
-2.21.  hf_iterator_insert(iname, htext)
549
+2.22.  hf_iterator_insert(iname, htext)
525 550
 
526 551
    Add headers before the one at the current iterator possition.
527 552
 
... ...
@@ -529,7 +554,7 @@ hf_iterator_end("i1");
529 554
 
530 555
    This function can be used from ANY_ROUTE.
531 556
 
532
-   Example 1.21. hf_iterator_insert usage
557
+   Example 1.22. hf_iterator_insert usage
533 558
 ...
534 559
     hf_iterator_start("i1");
535 560
     while(hf_iterator_next("i1")) {
... ...
@@ -576,7 +601,7 @@ hf_iterator_end("i1");
576 601
      * IDX - Value index, negative value counts from bottom
577 602
      * PARAM_NAME - name of parameter
578 603
 
579
-   Example 1.22. @hf_value select usage
604
+   Example 1.23. @hf_value select usage
580 605
 ...
581 606
 $a = @hf_value.my_header[1].my_param;
582 607
 xplog("L_ERR", "$sel(@hf_value.via[-1]), $sel(@hf_value.from.tag)\n");