From fe8858c4e913993a45e9df5874dea75f9478819f Mon Sep 17 00:00:00 2001 From: Mathias Palm Date: Sun, 10 Feb 2013 20:13:03 +0100 Subject: Add manpages Provides manpages instead of generating them from c2man as c2man is deprecated. --- doc/vf_set_prop_value.3 | 82 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 doc/vf_set_prop_value.3 (limited to 'doc/vf_set_prop_value.3') diff --git a/doc/vf_set_prop_value.3 b/doc/vf_set_prop_value.3 new file mode 100644 index 0000000..d41e4c9 --- /dev/null +++ b/doc/vf_set_prop_value.3 @@ -0,0 +1,82 @@ +.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man! +.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST! +.TH "vf_set_prop_value" 3 "30 April 2003" "c2man vf_iface.h" +.SH "NAME" +vf_set_prop_value \- vf_set_prop_value() +.SH "SYNOPSIS" +.ft B +#include <../vformat/vf_iface.h> +.sp +extern bool_t vf_set_prop_value +.br +( +.br + VF_PROP_T *p_prop, +.br + void *p_value, +.br + uint32_t n_param, +.br + vf_encoding_t encoding, +.br + bool_t copy +.br +); +.ft R +.SH "PARAMETERS" +.TP +.B "VF_PROP_T *p_prop" +The property. +.TP +.B "void *p_value" +Pointer to the data. +.TP +.B "uint32_t n_param" +Data size or index. +.TP +.B "vf_encoding_t encoding" +Encoding in use. +.TP +.B "bool_t copy" +Copy the data?. +.SH "DESCRIPTION" +Set values associated with a property. + +Passing a value of encoding not the same as the current property +encoding will cause the property contents to be freed prior to +setting the indicated value. +.SH "RETURNS" +TRUE <=> re-allocation success & encoding correct, FALSE else. +.SH "SEE ALSO" +vf_parse_init(3), +vf_parse_text(3), +vf_parse_end(3), +vf_read_file(3), +vf_write_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_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) -- cgit v1.1-32-gdbae