Browse code

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

Kamailio Dev authored on 13/04/2021 07:16:23
Showing 1 changed files
... ...
@@ -223,7 +223,7 @@ if(fnmatch("$rU", "123*"))
223 223
    Meaning of the parameters is as follows:
224 224
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
225 225
        index is not specified new header is inserted at the end of
226
-       message.
226
+       message. The index 1 correxponds to the first header.
227 227
      * hvalue - Value to be added, config var formatting supported.
228 228
 
229 229
    Example 1.6. append_hf_value usage
... ...
@@ -244,7 +244,7 @@ ot exists add new header
244 244
    Meaning of the parameters is as follows:
245 245
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
246 246
        index is not specified new header is inserted at the top of
247
-       message.
247
+       message. The index 1 correxponds to the first header.
248 248
      * hvalue - Value to be added, config var formatting supported.
249 249
 
250 250
    Example 1.7. insert_hf_value usage
... ...
@@ -262,7 +262,7 @@ insert_hf_value("foo[1]", "gogo") # try add to the first header
262 262
    Meaning of the parameters is as follows:
263 263
      * hf_par - Header field/param to be removed. Format: HFNAME [ [IDX] ]
264 264
        [. PARAM ] If asterisk is specified as index then all values are
265
-       affected.
265
+       affected. The index 1 correxponds to the first header.
266 266
 
267 267
    Example 1.8. remove_hf_value usage
268 268
 ...
... ...
@@ -282,7 +282,7 @@ remove_hf_value("foo[*].bar") # for each foo delete bar parameters
282 282
    Meaning of the parameters is as follows:
283 283
      * hf_par - Header/param to be removed. Format: HFNAME [ [IDX] ] [.
284 284
        PARAM ] If asterisk is specified as index then all values are
285
-       affected.
285
+       affected. The index 1 correxponds to the first header.
286 286
 
287 287
    Example 1.9. remove_hf_value2 usage
288 288
 ...
... ...
@@ -301,7 +301,7 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
301 301
    Meaning of the parameters is as follows:
302 302
      * hf_para - Header field value / param to be appended. Format: HFNAME
303 303
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
304
-       values are affected.
304
+       values are affected. The index 1 correxponds to the first header.
305 305
      * hvalue - Value to be assigned, config var formatting supported. If
306 306
        value is empty then no equal sign appears in param.
307 307
 
... ...
@@ -325,7 +325,7 @@ assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
325 325
    Meaning of the parameters is as follows:
326 326
      * hf_para - Header field value / param to be appended. Format: HFNAME
327 327
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
328
-       values are affected.
328
+       values are affected. The index 1 correxponds to the first header.
329 329
      * hvalue - Value to be assigned, config var formatting supported. If
330 330
        value is empty then no equal sign appears in param.
331 331