[sr-dev] git:master:6379f128: textopsx: docs - notes about 1-based indexing for hf value functions

Daniel-Constantin Mierla miconda at gmail.com
Wed Mar 31 16:10:30 CEST 2021


Module: kamailio
Branch: master
Commit: 6379f1280ba41e87ddb34fa1705ffe4231dcac9c
URL: https://github.com/kamailio/kamailio/commit/6379f1280ba41e87ddb34fa1705ffe4231dcac9c

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2021-03-31T16:06:31+02:00

textopsx: docs - notes about 1-based indexing for hf value functions

- GH #2387

---

Modified: src/modules/textopsx/doc/functions.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/6379f1280ba41e87ddb34fa1705ffe4231dcac9c.diff
Patch: https://github.com/kamailio/kamailio/commit/6379f1280ba41e87ddb34fa1705ffe4231dcac9c.patch

---

diff --git a/src/modules/textopsx/doc/functions.xml b/src/modules/textopsx/doc/functions.xml
index 0ef8dab411..0980e4060b 100644
--- a/src/modules/textopsx/doc/functions.xml
+++ b/src/modules/textopsx/doc/functions.xml
@@ -205,7 +205,8 @@ if(fnmatch("$rU", "123*"))
 	<itemizedlist>
 	    <listitem>
 		<para><emphasis>hf</emphasis> - Header field to be appended. Format: HFNAME [ [IDX] ].
-		If index is not specified new header is inserted at the end of message.
+		If index is not specified new header is inserted at the end of message. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	    <listitem>
@@ -238,7 +239,8 @@ append_hf_value("foo[-1]", "$var(Bar)") # try add value to the last header, if n
 	<itemizedlist>
 	    <listitem>
 		<para><emphasis>hf</emphasis> - Header field to be appended. Format: HFNAME [ [IDX] ].
-		If index is not specified new header is inserted at the top of message.
+		If index is not specified new header is inserted at the top of message. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	    <listitem>
@@ -269,7 +271,8 @@ insert_hf_value("foo[1]", "gogo") # try add to the first header
 	<itemizedlist>
 	    <listitem>
 		<para><emphasis>hf_par</emphasis> - Header field/param to be removed. Format: HFNAME [ [IDX] ] [. PARAM ]
-		If asterisk is specified as index then all values are affected.
+		If asterisk is specified as index then all values are affected. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	</itemizedlist>
@@ -299,7 +302,8 @@ remove_hf_value("foo[*].bar") # for each foo delete bar parameters
 	<itemizedlist>
 	    <listitem>
 		<para><emphasis>hf_par</emphasis> - Header/param to be removed. Format: HFNAME [ [IDX] ] [. PARAM ]
-		If asterisk is specified as index then all values are affected.
+		If asterisk is specified as index then all values are affected. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	</itemizedlist>
@@ -329,7 +333,8 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
 	    <listitem>
 			<para><emphasis>hf_para</emphasis> - Header field value / param to be appended.
 				Format: HFNAME [ [IDX] ] [. PARAM]
-		If asterisk is specified as index then all values are affected.
+		If asterisk is specified as index then all values are affected. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	    <listitem>
@@ -365,7 +370,8 @@ assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
 	<itemizedlist>
 	    <listitem>
 		<para><emphasis>hf_para</emphasis> - Header field value / param to be appended. Format: HFNAME [ [IDX] ] [. PARAM]
-		If asterisk is specified as index then all values are affected.
+		If asterisk is specified as index then all values are affected. The index 1
+		correxponds to the first header.
 		</para>
 	    </listitem>
 	    <listitem>




More information about the sr-dev mailing list