Skip to content

Commit

Permalink
modules: readme files regenerated - textopsx ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Jul 12, 2021
1 parent 4a4b804 commit 9ec9d9c
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions src/modules/textopsx/README
Expand Up @@ -37,6 +37,7 @@ Daniel-Constantin Mierla
2.16. hf_iterator_start(iname)
2.17. hf_iterator_end(iname)
2.18. textopsx.f.hf_iterator_next(iname)
2.19. hf_iterator_rm(iname)

3. Selects

Expand Down Expand Up @@ -64,7 +65,8 @@ Daniel-Constantin Mierla
1.16. hf_iterator_start usage
1.17. hf_iterator_end usage
1.18. hf_iterator_next usage
1.19. @hf_value select usage
1.19. hf_iterator_rm usage
1.20. @hf_value select usage

Chapter 1. Admin Guide

Expand All @@ -91,6 +93,7 @@ Chapter 1. Admin Guide
2.16. hf_iterator_start(iname)
2.17. hf_iterator_end(iname)
2.18. textopsx.f.hf_iterator_next(iname)
2.19. hf_iterator_rm(iname)

3. Selects

Expand Down Expand Up @@ -128,6 +131,7 @@ Chapter 1. Admin Guide
2.16. hf_iterator_start(iname)
2.17. hf_iterator_end(iname)
2.18. textopsx.f.hf_iterator_next(iname)
2.19. hf_iterator_rm(iname)

2.1. msg_apply_changes()

Expand Down Expand Up @@ -470,6 +474,25 @@ hf_iterator_end("i1");
hf_iterator_end("i1");
...

2.19. hf_iterator_rm(iname)

Remove the header at the current iterator position.

The parameter can be dynamic string with variables.

This function can be used from ANY_ROUTE.

Example 1.19. hf_iterator_rm usage
...
hf_iterator_start("i1");
while(hf_iterator_next("i1")) {
if($hfitname(i1)=="My-Header") {
hf_iterator_rm("i1");
}
}
hf_iterator_end("i1");
...

3. Selects

3.1. @hf_value
Expand Down Expand Up @@ -505,7 +528,7 @@ hf_iterator_end("i1");
* IDX - Value index, negative value counts from bottom
* PARAM_NAME - name of parameter

Example 1.19. @hf_value select usage
Example 1.20. @hf_value select usage
...
$a = @hf_value.my_header[1].my_param;
xplog("L_ERR", "$sel(@hf_value.via[-1]), $sel(@hf_value.from.tag)\n");
Expand Down

0 comments on commit 9ec9d9c

Please sign in to comment.