Module: kamailio
Branch: master
Commit: eaf18505360a3bbaf25889095fcf23b620caedff
URL:
https://github.com/kamailio/kamailio/commit/eaf18505360a3bbaf25889095fcf23b…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2024-06-21T13:01:09+02:00
modules: readme files regenerated - textopsx ... [skip ci]
---
Modified: src/modules/textopsx/README
---
Diff:
https://github.com/kamailio/kamailio/commit/eaf18505360a3bbaf25889095fcf23b…
Patch:
https://github.com/kamailio/kamailio/commit/eaf18505360a3bbaf25889095fcf23b…
---
diff --git a/src/modules/textopsx/README b/src/modules/textopsx/README
index 9d6b81c05cd..7c6bc59df14 100644
--- a/src/modules/textopsx/README
+++ b/src/modules/textopsx/README
@@ -755,25 +755,36 @@ bl_iterator_end("b1");
Get value of required header-value or param. Note that functions called
'value2' works with Authorization-like headers where comma is not
- treated as value delimiter. Formats: @hf_value.HFNAME[IDX] # idx value,
- negative value counts from bottom @hf_value.HFNAME.PARAM_NAME
- @hf_value.HFNAME[IDX].PARAM_NAME @hf_value.HFNAME.p.PARAM_NAME # or
- .param., useful if required called "uri", "p", "param"
- @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto @hf_value.HFNAME[IDX].uri #
- (< & > excluded) @hf_value.HFNAME[*] # return comma delimited list of
- all values (combines headers) @hf_value.HFNAME # the same as above [*]
- but may be parsed by cfg.y @hf_value.HFNAME[*].uri # return comma
- delimited list of uris (< & > excluded) @hf_value.HFNAME.uri # the same
- as above [*] but may be parsed by cfg.y @hf_value.HFNAME[IDX].name #
- returns name part, quotes excluded @hf_value.HFNAME.name # returns name
- part of the first value @hf_value2.HFNAME # returns value of first
- header @hf_value2.HFNAME[IDX] # returns value of idx's header
- @hf_value2.HFNAME.PARAM_NAME @hf_value2.HFNAME[IDX].PARAM_NAME
- @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
- @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
- @hf_value.HFNAME.p.name # returns param named name, not name itself
- @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features may be
- used @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
+ treated as value delimiter.
+
+ Formats:
+ * @hf_value.HFNAME[IDX] # idx value, negative value counts from
+ bottom
+ * @hf_value.HFNAME.PARAM_NAME
+ * @hf_value.HFNAME[IDX].PARAM_NAME
+ * @hf_value.HFNAME.p.PARAM_NAME # or .param., useful if required
+ called "uri", "p", "param"
+ * @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto
+ * @hf_value.HFNAME[IDX].uri # (< & > excluded)
+ * @hf_value.HFNAME[*] # return comma delimited list of all values
+ (combines headers)
+ * @hf_value.HFNAME # the same as above [*] but may be parsed by cfg.y
+ * @hf_value.HFNAME[*].uri # return comma delimited list of uris (< &
+ > excluded)
+ * @hf_value.HFNAME.uri # the same as above [*] but may be parsed by
+ cfg.y
+ * @hf_value.HFNAME[IDX].name # returns name part, quotes excluded
+ * @hf_value.HFNAME.name # returns name part of the first value
+ * @hf_value2.HFNAME # returns value of first header
+ * @hf_value2.HFNAME[IDX] # returns value of idx's header
+ * @hf_value2.HFNAME.PARAM_NAME
+ * @hf_value2.HFNAME[IDX].PARAM_NAME
+ * @hf_value.HFNAME[IDX].uri # return URI, quotes excluded
+ * @hf_value.HFNAME.p.uri # returns param named uri, not URI itself
+ * @hf_value.HFNAME.p.name # returns param named name, not name itself
+ * @hf_value.HFNAME[IDX].uri.name # any sel_any_uri nested features
+ may be used
+ * @hf_value.HFNAME[IDX].nameaddr.name # select_any_nameaddr
Meaning of the parameters is as follows:
* HFNAME - Header field name. Underscores are treated as dashes.