[sr-dev] git:master:4a4b8047: textopsx: docs for hf_iterator_rm()

Module: kamailio Branch: master Commit: 4a4b8047b4b46b003bc0b12b737ca956658d18cb URL: https://github.com/kamailio/kamailio/commit/4a4b8047b4b46b003bc0b12b737ca95… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2021-07-12T08:06:07+02:00 textopsx: docs for hf_iterator_rm() --- Modified: src/modules/textopsx/doc/functions.xml --- Diff: https://github.com/kamailio/kamailio/commit/4a4b8047b4b46b003bc0b12b737ca95… Patch: https://github.com/kamailio/kamailio/commit/4a4b8047b4b46b003bc0b12b737ca95… --- diff --git a/src/modules/textopsx/doc/functions.xml b/src/modules/textopsx/doc/functions.xml index f9c388016e..c1c5fd5f64 100644 --- a/src/modules/textopsx/doc/functions.xml +++ b/src/modules/textopsx/doc/functions.xml @@ -561,6 +561,34 @@ hf_iterator_end("i1"); } hf_iterator_end("i1"); ... +</programlisting> + </example> + </section> + <section id="textopsx.f.hf_iterator_rm"> + <title> + <function moreinfo="none">hf_iterator_rm(iname)</function> + </title> + <para> + Remove the header at the current iterator position. + </para> + <para> + The parameter can be dynamic string with variables. + </para> + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>hf_iterator_rm</function> usage</title> + <programlisting format="linespecific"> +... + hf_iterator_start("i1"); + while(hf_iterator_next("i1")) { + if($hfitname(i1)=="My-Header") { + hf_iterator_rm("i1"); + } + } + hf_iterator_end("i1"); +... </programlisting> </example> </section>