Browse Source

pv: regenerate README

Victor Seva 10 years ago
parent
commit
e6505819e5
1 changed files with 24 additions and 4 deletions
  1. 24 4
      modules/pv/README

+ 24 - 4
modules/pv/README

@@ -47,6 +47,7 @@ Daniel-Constantin Mierla
               4.9. sbranch_reset()
               4.10. pv_xavp_print()
               4.11. pv_var_to_xavp(varname, xname)
+              4.12. pv_xavp_to_var(xname)
 
         5. MI Commands
 
@@ -74,8 +75,9 @@ Daniel-Constantin Mierla
    1.12. sbranch_append() usage
    1.13. pv_xavp_print() usage
    1.14. pv_var_to_xavp() usage
-   1.15. shv_set usage
-   1.16. shv_get usage
+   1.15. pv_xavp_to_var() usage
+   1.16. shv_set usage
+   1.17. shv_get usage
 
 Chapter 1. Admin Guide
 
@@ -106,6 +108,7 @@ Chapter 1. Admin Guide
         4.9. sbranch_reset()
         4.10. pv_xavp_print()
         4.11. pv_var_to_xavp(varname, xname)
+        4.12. pv_xavp_to_var(xname)
 
    5. MI Commands
 
@@ -211,6 +214,7 @@ modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
    4.9. sbranch_reset()
    4.10. pv_xavp_print()
    4.11. pv_var_to_xavp(varname, xname)
+   4.12. pv_xavp_to_var(xname)
 
 4.1. pv_isset(pvar)
 
@@ -395,6 +399,22 @@ $xavp("ok[0]=>temp") now is 3
 $xavp("ok[0]=>foo") now is "foo indeed"
 ...
 
+4.12.  pv_xavp_to_var(xname)
+
+   Copy xavp values to vars. Reverse of pv_var_to_xavp().
+
+   Function can be used from ANY_ROUTE.
+
+   Example 1.15. pv_xavp_to_var() usage
+...
+$xavp("bar=>temp") = 3;
+$xavp("bar[0]=>foo") = "foo indeed";
+pv_xavp_to_var("bar");
+...
+$var("temp") now is 3
+$var("foo") now is "foo indeed"
+...
+
 5. MI Commands
 
    5.1. shv_set
@@ -418,7 +438,7 @@ $xavp("ok[0]=>foo") now is "foo indeed"
                 _value_
                 _empty_line_
 
-   Example 1.15. shv_set usage
+   Example 1.16. shv_set usage
 ...
 $ kamctl fifo shv_set debug int 0
 ...
@@ -436,7 +456,7 @@ $ kamctl fifo shv_set debug int 0
                 _name_
                 _empty_line_
 
-   Example 1.16. shv_get usage
+   Example 1.17. shv_get usage
 ...
 $ kamctl fifo shv_get debug
 $ kamctl fifo shv_get