[sr-dev] git:master:9ea2d8de: corex: documented file_read() and file_write()

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 9ea2d8de54f461844dee580f6288bafb3144032e
URL: https://github.com/kamailio/kamailio/commit/9ea2d8de54f461844dee580f6288bafb3144032e

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2015-09-07T14:58:58+02:00

corex: documented file_read() and file_write()

---

Modified: modules/corex/doc/corex_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/9ea2d8de54f461844dee580f6288bafb3144032e.diff
Patch: https://github.com/kamailio/kamailio/commit/9ea2d8de54f461844dee580f6288bafb3144032e.patch

---

diff --git a/modules/corex/doc/corex_admin.xml b/modules/corex/doc/corex_admin.xml
index 219810f..2a3c140 100644
--- a/modules/corex/doc/corex_admin.xml
+++ b/modules/corex/doc/corex_admin.xml
@@ -370,6 +370,46 @@ event_route[network:msg] {
 		</example>
 	</section>
 
+	<section id="corex.f.file_read">
+		<title>
+			<function moreinfo="none">file_read(fpath, var)</function>
+		</title>
+		<para>
+			Read content of a text file into a variable.
+		</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>file_read</function> usage</title>
+		<programlisting format="linespecific">
+...
+if(file_read("/tmp/data.txt", "$var(data)")) { ... }
+...
+</programlisting>
+		</example>
+	</section>
+
+	<section id="corex.f.file_write">
+		<title>
+			<function moreinfo="none">file_write(fpath, content)</function>
+		</title>
+		<para>
+			Write content of parameter to a text file.
+		</para>
+		<para>
+			This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>file_write</function> usage</title>
+		<programlisting format="linespecific">
+...
+if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 
 	<section>