[sr-dev] git:master:0e2f744f: pv: documentation for pv_evalx() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 0e2f744f79d78c9cc33e32544222a53ded3eab47
URL: https://github.com/kamailio/kamailio/commit/0e2f744f79d78c9cc33e32544222a53ded3eab47

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2016-04-05T07:27:15+02:00

pv: documentation for pv_evalx() function

---

Modified: modules/pv/doc/pv_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/0e2f744f79d78c9cc33e32544222a53ded3eab47.diff
Patch: https://github.com/kamailio/kamailio/commit/0e2f744f79d78c9cc33e32544222a53ded3eab47.patch

---

diff --git a/modules/pv/doc/pv_admin.xml b/modules/pv/doc/pv_admin.xml
index 4cbd6b80..21a8ba7 100644
--- a/modules/pv/doc/pv_admin.xml
+++ b/modules/pv/doc/pv_admin.xml
@@ -450,6 +450,33 @@ $var("foo") now is "foo indeed"
 				</programlisting>
 			</example>
 		</section>
+		<section id="pv.f.pv_evalx">
+			<title>
+				<function moreinfo="none">pv_evalx(dst, fmt)</function>
+			</title>
+			<para>
+				The fmt string is evaluated twice for exiting variables,
+				the result is stored in dst variable. The dst must be the
+				name of a writable variable. The fmt can contain variables
+				that have a value containing other variables.
+			</para>
+
+			<para>
+			Function can be used from ANY_ROUTE.
+			</para>
+			<example>
+				<title><function>pv_xavp_to_var()</function> usage</title>
+				<programlisting format="linespecific">
+...
+$var(x) = "test";
+$var(y) = "$var(x)"
+pv_evalx("$var(z)", "$var(y) one");
+
+# - the value of $var(z) is "test one"
+...
+				</programlisting>
+			</example>
+		</section>
 	</section>
 
 	<section>