summaryrefslogtreecommitdiffstats
path: root/doc/vf_get_prop_value_string.3
blob: afc6f66abb6224457267c7b475ab8c8c17604e34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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 required.
.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)