summaryrefslogtreecommitdiffstats
path: root/doc/vf_get_prop_value_string.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/vf_get_prop_value_string.3')
-rw-r--r--doc/vf_get_prop_value_string.371
1 files changed, 71 insertions, 0 deletions
diff --git a/doc/vf_get_prop_value_string.3 b/doc/vf_get_prop_value_string.3
new file mode 100644
index 0000000..4fc9a81
--- /dev/null
+++ b/doc/vf_get_prop_value_string.3
@@ -0,0 +1,71 @@
+.\" WARNING! THIS FILE WAS GENERATED AUTOMATICALLY BY c2man!
+.\" DO NOT EDIT! CHANGES MADE TO THIS FILE WILL BE LOST!
+.TH "vf_get_prop_value_string" 3 "30 April 2003" "c2man vf_iface.h"
+.SH "NAME"
+vf_get_prop_value_string \- vf_get_prop_value_string()
+.SH "SYNOPSIS"
+.ft B
+#include <../vformat/vf_iface.h>
+.sp
+extern char *vf_get_prop_value_string
+.br
+(
+.br
+ VF_PROP_T *p_prop,
+.br
+ uint32_t n_string
+.br
+);
+.ft R
+.SH "PARAMETERS"
+.TP
+.B "VF_PROP_T *p_prop"
+Property to locate string from.
+.TP
+.B "uint32_t n_string"
+Index to string requred.
+.SH "DESCRIPTION"
+Obtain string pointer value from VF_PROP_T. For example a property
+may be defined as:
+
+THING;THIS=STUFF;WITH-QUALIFIERS:fred-fred-fred;gogogo;baabaabaa
+
+A call to vf_get_prop_value_string() specifying n_string=1 will
+return a pointer to the gogogo value.
+
+Return NULL if out of range request, ie. N_string=3 for N:0;1;2.
+.SH "RETURNS"
+Pointer to string value if value present, NULL if index too large.
+.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_set_prop_value(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)