Browse code

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

Kamailio Dev authored on 26/10/2020 10:01:20
Showing 1 changed files
... ...
@@ -741,10 +741,13 @@ if (has_body("multipart/mixed")) {
741 741
 
742 742
 4.23.  append_to_reply(txt)
743 743
 
744
-   Append txt as header to the reply.
744
+   Append txt as header to the reply that is going to be generated by
745
+   Kamailio (e.g., via sl_send_reply(...)).
745 746
 
746 747
    Meaning of the parameters is as follows:
747
-     * txt - String which may contains pseudo-variables.
748
+     * txt - String which may contains pseudo-variables. Note that the
749
+       value has to be ended with "\r\n" (end of header characters
750
+       sequence).
748 751
 
749 752
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
750 753
    FAILURE_ROUTE, ERROR_ROUTE.
... ...
@@ -757,12 +760,14 @@ append_to_reply("Foo: $rm at $Ts\r\n");
757 760
 
758 761
 4.24.  append_hf(txt[, hdr])
759 762
 
760
-   Appends 'txt' as header after first header field or after last 'hdr'
761
-   header field.
763
+   Appends 'txt' as header at the end of the all headers, or after last
764
+   header named 'hdr' if the second parameter is provided.
762 765
 
763 766
    Meaning of the parameters is as follows:
764 767
      * txt - Header field to be appended. The value can contain
765
-       pseudo-variables which will be replaced at run time.
768
+       pseudo-variables which will be replaced at run time. Note that the
769
+       value has to be ended with "\r\n" (end of header characters
770
+       sequence).
766 771
      * hdr - Header name after which the 'txt' is appended.
767 772
 
768 773
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
... ...
@@ -776,12 +781,14 @@ append_hf("From-username: $fU\r\n", "Call-ID");
776 781
 
777 782
 4.25.  insert_hf(txt[, hdr])
778 783
 
779
-   Inserts 'txt' as header before the first header field or before first
780
-   'hdr' header field if 'hdr' is given.
784
+   Inserts 'txt' as header before the first header field, or before first
785
+   header named 'hdr'if the second parameter is provided.
781 786
 
782 787
    Meaning of the parameters is as follows:
783 788
      * txt - Header field to be inserted. The value can contain
784
-       pseudo-variables which will be replaced at run time.
789
+       pseudo-variables which will be replaced at run time. Note that the
790
+       value has to be ended with "\r\n" (end of header characters
791
+       sequence).
785 792
      * hdr - Header name before which the 'txt' is inserted.
786 793
 
787 794
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,