Browse Source

pv: documentation for pv_evalx() function

Daniel-Constantin Mierla 9 years ago
parent
commit
0e2f744f79
1 changed files with 27 additions and 0 deletions
  1. 27 0
      modules/pv/doc/pv_admin.xml

+ 27 - 0
modules/pv/doc/pv_admin.xml

@@ -446,6 +446,33 @@ pv_xavp_to_var("bar");
 ...
 ...
 $var("temp") now is 3
 $var("temp") now is 3
 $var("foo") now is "foo indeed"
 $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>
 				</programlisting>
 			</example>
 			</example>