summaryrefslogtreecommitdiffstats
path: root/doc/vf_get_prop_value.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vf_get_prop_value.3')
-rw-r--r--doc/vf_get_prop_value.387
1 files changed, 87 insertions, 0 deletions
diff --git a/doc/vf_get_prop_value.3 b/doc/vf_get_prop_value.3
new file mode 100644
index 0000000..4b821c8
--- /dev/null
+++ b/doc/vf_get_prop_value.3
@@ -0,0 +1,87 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "vf_get_prop_value" 3 "30 April 2003" "c2man vf_iface.h"
+.SH "NAME"
+vf_get_prop_value \- vf_get_prop_value()
+.SH "SYNOPSIS"
+.ft B
+#include <../vformat/vf_iface.h>
+.sp
+extern bool_t vf_get_prop_value
+.br
+(
+.br
+ VF_PROP_T *p_prop,
+.br
+ void **pp_value,
+.br
+ uint32_t *p_size,
+.br
+ vf_encoding_t *p_encoding
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "VF_PROP_T *p_prop"
+The property.
+.TP
+.B "void **pp_value"
+Pointer value.
+.TP
+.B "uint32_t *p_size"
+Integer value.
+.TP
+.B "vf_encoding_t *p_encoding"
+Type of return values.
+.SH "DESCRIPTION"
+Get hold of raw fields associated with the property. These are of
+various types:
+
+VF_ENC_VOBJECT
+.br
+- *Pp_value = pointer to contained VF_OBJECT_T which can be
+passed back to any of the object manipulation functions.
+
+VF_ENC_7BIT, VF_ENC_QUOTEDPRINTABLE
+.br
+- *Pp_value = ptr to array of char*, *p_size = number of elts.
+
+VF_ENC_8BIT, VF_BASE64
+.br
+- *Pp_value = ptr to bytes, *p_size = number of bytes.
+.SH "RETURNS"
+TRUE <=> encoding is valid, 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_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)