Browse code

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

Kamailio Dev authored on 12/10/2021 20:31:16
Showing 1 changed files
... ...
@@ -67,10 +67,12 @@ Ovidiu Sas
67 67
               4.11. sht_iterator_end(iname)
68 68
               4.12. sht_iterator_next(iname)
69 69
               4.13. sht_iterator_rm(iname)
70
-              4.14. sht_match_name(htable, op, mval)
71
-              4.15. sht_has_name(htable, op, mval)
72
-              4.16. sht_match_str_value(htable, op, mval)
73
-              4.17. sht_has_str_value(htable, op, mval)
70
+              4.14. sht_iterator_sets(iname, sval)
71
+              4.15. sht_iterator_seti(iname, ival)
72
+              4.16. sht_match_name(htable, op, mval)
73
+              4.17. sht_has_name(htable, op, mval)
74
+              4.18. sht_match_str_value(htable, op, mval)
75
+              4.19. sht_has_str_value(htable, op, mval)
74 76
 
75 77
         5. Exported pseudo-variables
76 78
         6. RPC Commands
... ...
@@ -125,8 +127,10 @@ Ovidiu Sas
125 127
    1.30. sht_iterator_end usage
126 128
    1.31. sht_iterator_next usage
127 129
    1.32. sht_iterator_rm usage
128
-   1.33. sht_match_name usage
129
-   1.34. sht_match_name usage
130
+   1.33. sht_iterator_sets usage
131
+   1.34. sht_iterator_seti usage
132
+   1.35. sht_match_name usage
133
+   1.36. sht_match_name usage
130 134
 
131 135
 Chapter 1. Admin Guide
132 136
 
... ...
@@ -173,10 +177,12 @@ Chapter 1. Admin Guide
173 177
         4.11. sht_iterator_end(iname)
174 178
         4.12. sht_iterator_next(iname)
175 179
         4.13. sht_iterator_rm(iname)
176
-        4.14. sht_match_name(htable, op, mval)
177
-        4.15. sht_has_name(htable, op, mval)
178
-        4.16. sht_match_str_value(htable, op, mval)
179
-        4.17. sht_has_str_value(htable, op, mval)
180
+        4.14. sht_iterator_sets(iname, sval)
181
+        4.15. sht_iterator_seti(iname, ival)
182
+        4.16. sht_match_name(htable, op, mval)
183
+        4.17. sht_has_name(htable, op, mval)
184
+        4.18. sht_match_str_value(htable, op, mval)
185
+        4.19. sht_has_str_value(htable, op, mval)
180 186
 
181 187
    5. Exported pseudo-variables
182 188
    6. RPC Commands
... ...
@@ -722,10 +728,12 @@ modparam("htable", "event_callback_mode", 1)
722 728
    4.11. sht_iterator_end(iname)
723 729
    4.12. sht_iterator_next(iname)
724 730
    4.13. sht_iterator_rm(iname)
725
-   4.14. sht_match_name(htable, op, mval)
726
-   4.15. sht_has_name(htable, op, mval)
727
-   4.16. sht_match_str_value(htable, op, mval)
728
-   4.17. sht_has_str_value(htable, op, mval)
731
+   4.14. sht_iterator_sets(iname, sval)
732
+   4.15. sht_iterator_seti(iname, ival)
733
+   4.16. sht_match_name(htable, op, mval)
734
+   4.17. sht_has_name(htable, op, mval)
735
+   4.18. sht_match_str_value(htable, op, mval)
736
+   4.19. sht_has_str_value(htable, op, mval)
729 737
 
730 738
 4.1.  sht_print()
731 739
 
... ...
@@ -940,7 +948,39 @@ sht_iterator_end("i1");
940 948
     sht_iterator_end("i1");
941 949
 ...
942 950
 
943
-4.14.  sht_match_name(htable, op, mval)
951
+4.14.  sht_iterator_sets(iname, sval)
952
+
953
+   Set the value of the current item to the string in the sval.
954
+
955
+   The parameters can be dynamic strings with variables.
956
+
957
+   This function can be used from ANY_ROUTE.
958
+
959
+   Example 1.33. sht_iterator_sets usage
960
+...
961
+    sht_iterator_start("i1", "h1");
962
+    sht_iterator_next("i1");
963
+    sht_iterator_sets("i1", "$ci");
964
+    sht_iterator_end("i1");
965
+...
966
+
967
+4.15.  sht_iterator_seti(iname, ival)
968
+
969
+   Set the value of the current item to the integer in the ival.
970
+
971
+   The parameters can be dynamic strings or integers with variables.
972
+
973
+   This function can be used from ANY_ROUTE.
974
+
975
+   Example 1.34. sht_iterator_seti usage
976
+...
977
+    sht_iterator_start("i1", "h1");
978
+    sht_iterator_next("i1");
979
+    sht_iterator_seti("i1", "20");
980
+    sht_iterator_end("i1");
981
+...
982
+
983
+4.16.  sht_match_name(htable, op, mval)
944 984
 
945 985
    Return greater than 0 (true) if the htable has an item that matches the
946 986
    name against the mval parameter.
... ...
@@ -955,18 +995,18 @@ sht_iterator_end("i1");
955 995
 
956 996
    This function can be used from ANY_ROUTE.
957 997
 
958
-   Example 1.33. sht_match_name usage
998
+   Example 1.35. sht_match_name usage
959 999
 ...
960 1000
 if(sht_match_name("ha", "eq", "alice")) {
961 1001
   ...
962 1002
 }
963 1003
 ...
964 1004
 
965
-4.15.  sht_has_name(htable, op, mval)
1005
+4.17.  sht_has_name(htable, op, mval)
966 1006
 
967 1007
    Alias for sht_match_name().
968 1008
 
969
-4.16.  sht_match_str_value(htable, op, mval)
1009
+4.18.  sht_match_str_value(htable, op, mval)
970 1010
 
971 1011
    Return greater than 0 (true) if the htable has an item that matches the
972 1012
    string value against the mval parameter.
... ...
@@ -981,14 +1021,14 @@ if(sht_match_name("ha", "eq", "alice")) {
981 1021
 
982 1022
    This function can be used from ANY_ROUTE.
983 1023
 
984
-   Example 1.34. sht_match_name usage
1024
+   Example 1.36. sht_match_name usage
985 1025
 ...
986 1026
 if(sht_match_str_value("ha", "eq", "alice")) {
987 1027
   ...
988 1028
 }
989 1029
 ...
990 1030
 
991
-4.17.  sht_has_str_value(htable, op, mval)
1031
+4.19.  sht_has_str_value(htable, op, mval)
992 1032
 
993 1033
    Alias for sht_match_str_value().
994 1034