summaryrefslogtreecommitdiffstats
path: root/doc/vf_write_file.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vf_write_file.3')
-rw-r--r--doc/vf_write_file.370
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/vf_write_file.3 b/doc/vf_write_file.3
new file mode 100644
index 0000000..ebc0b74
--- /dev/null
+++ b/doc/vf_write_file.3
@@ -0,0 +1,70 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "vf_write_file" 3 "30 April 2003" "c2man vf_iface.h"
+.SH "NAME"
+vf_write_file \- vf_write_file()
+.SH "SYNOPSIS"
+.ft B
+#include <../vformat/vf_iface.h>
+.sp
+extern bool_t vf_write_file
+.br
+(
+.br
+ const char *p_name,
+.br
+ VF_OBJECT_T *p_object,
+.br
+ bool_t write_all
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "const char *p_name"
+Outpt filename.
+.TP
+.B "VF_OBJECT_T *p_object"
+The object to write.
+.TP
+.B "bool_t write_all"
+Should write p_next as well?.
+.SH "DESCRIPTION"
+Write indicated vobject to file. For lists of objects (eg. Read from
+a phonebook) the write_all parameter allows the caller to control if
+the library writes the entire list or just the head item.
+.SH "RETURNS"
+TRUE <=> written OK, FALSE else.
+.SH "SEE ALSO"
+vf_parse_init(3),
+vf_parse_text(3),
+vf_parse_end(3),
+vf_read_file(3),
+vf_get_next_object(3),
+vf_create_object(3),
+vf_get_object_type(3),
+vf_get_property(3),
+vf_get_property_ex(3),
+vf_get_next_property(3),
+vf_get_prop_value(3),
+vf_set_prop_value(3),
+vf_get_prop_value_string(3),
+vf_get_prop_name_string(3),
+vf_set_prop_name_string(3),
+vf_get_prop_name(3),
+vf_get_prop_value_object(3),
+vf_set_prop_value_object(3),
+vf_set_prop_value_string(3),
+vf_set_prop_value_base64(3),
+vf_get_prop_value_base64(3),
+vf_set_property_from_file(3),
+vf_delete_object(3),
+vf_delete_prop(3),
+vf_find_prop_qual_index(3),
+vf_is_modified(3),
+vf_find_charset(3),
+vf_date_string_to_time(3),
+vf_period_string_to_time(3),
+vf_period_time_to_string(3),
+vf_set_prop_value_time(3),
+vf_get_prop_value_time(3)