blob: 0511a56e8f9ff120dfec6908df55bf76ace9c5de (
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
72
73
74
75
76
77
78
79
|
@node Public structures
@chapter Public structures
@defvr {Public Type} VF_PARSER_T
Type representing "parser" - an object used to parse VOBJECTS.
@end defvr
@defvr {Public Type} VF_OBJECT_T
Type representing an "object" - objects are collections of properties.
@end defvr
@defvr {Public Type} VF_PROP_T
Type representing a "property" - properties associate a name & a value.
@end defvr
@deftp {Structure} VF_ISO8601_PERIOD_T @*
@{@*
uint32_t years@*
uint32_t months@*
uint32_t weeks@*
uint32_t days@*
uint32_t hours@*
uint32_t minutes@*
uint32_t seconds@*
@}
VF_ISO8601_PERIOD_T is used to encapsulate an ISO time 'period'.
@end deftp
@deftypevr {Public Type} uint8_t vf_encoding_t
vf_encoding_t enumerates the supported encodings (formats) of a
vformat object property. Each "value" has a field of this type.
Predefined values
@multitable {VF_ENC_QUOTEDPRINTABLE}{((vf_encoding_t)aaaa}{123456}
@item VF_ENC_UNKNOWN @tab ((vf_encoding_t)(0))
@item VF_ENC_7BIT @tab ((vf_encoding_t)(1))
@item VF_ENC_8BIT @tab ((vf_encoding_t)(2))
@item VF_ENC_BASE64 @tab ((vf_encoding_t)(3))
@item VF_ENC_QUOTEDPRINTABLE @tab ((vf_encoding_t)(4))
@item VF_ENC_VOBJECT @tab ((vf_encoding_t)(5))
@end multitable
@end deftypevr
@deftypevr {Public Type} uint16_t vf_get_t
vf_get_t controls the operation of vf_get_property() (qv). Controls
how far the search algorithm is prepared to go in order to return a
property ready for modification.
Predefined values
@multitable {VF_ENC_QUOTEDPRINTABLE}{((vf_encoding_t)aaaa}{Find & append if not present123456}
@item VFGP_FIND @tab ((vf_get_t)(0x0001)) @tab Search for property
@item VFGP_APPEND @tab ((vf_get_t)(0x0002)) @tab Append property, no search
@item VFGP_GET @tab ((vf_get_t)(0x0003)) @tab Find & append if not present
@end multitable
@end deftypevr
@deftypevr {Public Type} uint32_t vf_search_flags_t
vf_search_flags_t is used to describe how string matching is performed
when searching for properties, qualifiers, values etc.
@end deftypevr
|
