summaryrefslogtreecommitdiffstats
path: root/doc/vf_get_property_ex.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vf_get_property_ex.3')
-rw-r--r--doc/vf_get_property_ex.391
1 files changed, 91 insertions, 0 deletions
diff --git a/doc/vf_get_property_ex.3 b/doc/vf_get_property_ex.3
new file mode 100644
index 0000000..9937b3f
--- /dev/null
+++ b/doc/vf_get_property_ex.3
@@ -0,0 +1,91 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "vf_get_property_ex" 3 "30 April 2003" "c2man vf_iface.h"
+.SH "NAME"
+vf_get_property_ex \- vf_get_property_ex()
+.SH "SYNOPSIS"
+.ft B
+#include <../vformat/vf_iface.h>
+.sp
+extern bool_t vf_get_property_ex
+.br
+(
+.br
+ VF_PROP_T **pp_prop,
+.br
+ VF_OBJECT_T *p_object,
+.br
+ vf_get_t ops,
+.br
+ const char *p_group,
+.br
+ const char *p_name,
+.br
+ const char *p_qualifier,
+.br
+ char args
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "VF_PROP_T **pp_prop"
+Output pointer.
+.TP
+.B "VF_OBJECT_T *p_object"
+Object to search.
+.TP
+.B "vf_get_t ops"
+Search flags.
+.TP
+.B "const char *p_group"
+Group name if any.
+.TP
+.B "const char *p_name"
+Name of tag.
+.TP
+.B "const char *p_qualifier"
+First qualifier if any.
+.TP
+.B "char args"
+Argument list.
+.SH "DESCRIPTION"
+The grunt behind vf_get_property(). Manages the search as described
+vf_get_property() but takes the list of arguments as a va_list.
+This function should be used when writing higher layer functions
+which take varargs (eg. DDX functions).
+.SH "RETURNS"
+TRUE iff found/added successfully. Ptr to prop returned via pp_prop.
+.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_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)