2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
6
<refentrytitle role="top_of_page" id="EVCard.top_of_page">EVCard</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>EVCard</refname>
14
<refpurpose>Contact data in the VCard format.</refpurpose>
17
<refsynopsisdiv id="EVCard.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis> <link linkend="EVCard-struct">EVCard</link>;
21
enum <link linkend="EVCardFormat">EVCardFormat</link>;
22
<link linkend="EVCardAttribute">EVCardAttribute</link>;
23
<link linkend="EVCardAttributeParam">EVCardAttributeParam</link>;
24
<link linkend="EVCard"><returnvalue>EVCard</returnvalue></link>* <link linkend="e-vcard-new">e_vcard_new</link> (<parameter><type>void</type></parameter>);
25
<link linkend="EVCard"><returnvalue>EVCard</returnvalue></link>* <link linkend="e-vcard-new-from-string">e_vcard_new_from_string</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);
26
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-to-string">e_vcard_to_string</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
27
<parameter><link linkend="EVCardFormat"><type>EVCardFormat</type></link> format</parameter>);
28
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-dump-structure">e_vcard_dump_structure</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>);
29
<link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * <link linkend="e-vcard-attribute-new">e_vcard_attribute_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_group</parameter>,
30
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_name</parameter>);
31
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-free">e_vcard_attribute_free</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
32
<link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * <link linkend="e-vcard-attribute-copy">e_vcard_attribute_copy</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
33
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-remove-attributes">e_vcard_remove_attributes</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
34
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_group</parameter>,
35
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_name</parameter>);
36
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-remove-attribute">e_vcard_remove_attribute</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
37
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
38
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-add-attribute">e_vcard_add_attribute</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
39
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
40
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-add-attribute-with-value">e_vcard_add_attribute_with_value</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>,
41
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
42
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
43
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-add-attribute-with-values">e_vcard_add_attribute_with_values</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>,
44
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
45
<parameter>...</parameter>);
46
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-value">e_vcard_attribute_add_value</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
47
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
48
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-value-decoded">e_vcard_attribute_add_value_decoded</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
49
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>,
50
<parameter><link linkend="gint"><type>gint</type></link> len</parameter>);
51
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-values">e_vcard_attribute_add_values</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
52
<parameter>...</parameter>);
53
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-remove-values">e_vcard_attribute_remove_values</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
54
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-remove-value">e_vcard_attribute_remove_value</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
55
<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);
56
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-remove-params">e_vcard_attribute_remove_params</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
57
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-remove-param">e_vcard_attribute_remove_param</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
58
<parameter>const <link linkend="gchar"><type>gchar</type></link> *param_name</parameter>);
59
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-remove-param-value">e_vcard_attribute_remove_param_value</link>
60
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
61
<parameter>const <link linkend="gchar"><type>gchar</type></link> *param_name</parameter>,
62
<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);
63
<link linkend="EVCardAttributeParam"><returnvalue>EVCardAttributeParam</returnvalue></link>* <link linkend="e-vcard-attribute-param-new">e_vcard_attribute_param_new</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
64
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-param-free">e_vcard_attribute_param_free</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
65
<link linkend="EVCardAttributeParam"><returnvalue>EVCardAttributeParam</returnvalue></link>* <link linkend="e-vcard-attribute-param-copy">e_vcard_attribute_param_copy</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
66
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-param">e_vcard_attribute_add_param</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
67
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
68
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-param-with-value">e_vcard_attribute_add_param_with_value</link>
69
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
70
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
71
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
72
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-add-param-with-values">e_vcard_attribute_add_param_with_values</link>
73
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
74
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
75
<parameter>...</parameter>);
76
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-param-add-value">e_vcard_attribute_param_add_value</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
77
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);
78
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-param-add-values">e_vcard_attribute_param_add_values</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
79
<parameter>...</parameter>);
80
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-vcard-attribute-param-remove-values">e_vcard_attribute_param_remove_values</link>
81
(<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
82
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-attribute-param-get-name">e_vcard_attribute_param_get_name</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
83
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-attribute-param-get-values">e_vcard_attribute_param_get_values</link> (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);
84
<link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * <link linkend="e-vcard-get-attribute">e_vcard_get_attribute</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
85
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
86
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-get-attributes">e_vcard_get_attributes</link> (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>);
87
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-attribute-get-group">e_vcard_attribute_get_group</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
88
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-attribute-get-name">e_vcard_attribute_get_name</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
89
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-attribute-get-values">e_vcard_attribute_get_values</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
90
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-attribute-get-values-decoded">e_vcard_attribute_get_values_decoded</link>
91
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
92
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-attribute-get-params">e_vcard_attribute_get_params</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
93
<link linkend="GList"><returnvalue>GList</returnvalue></link>* <link linkend="e-vcard-attribute-get-param">e_vcard_attribute_get_param</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
94
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
95
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-attribute-get-value">e_vcard_attribute_get_value</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
96
<link linkend="GString"><returnvalue>GString</returnvalue></link>* <link linkend="e-vcard-attribute-get-value-decoded">e_vcard_attribute_get_value_decoded</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
97
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-vcard-attribute-has-type">e_vcard_attribute_has_type</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
98
<parameter>const <link linkend="gchar"><type>gchar</type></link> *typestr</parameter>);
99
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-vcard-attribute-is-single-valued">e_vcard_attribute_is_single_valued</link> (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);
100
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-escape-string">e_vcard_escape_string</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);
101
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-vcard-unescape-string">e_vcard_unescape_string</link> (<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);
102
#define <link linkend="EVC-ADR:CAPS">EVC_ADR</link>
103
#define <link linkend="EVC-BDAY:CAPS">EVC_BDAY</link>
104
#define <link linkend="EVC-CALURI:CAPS">EVC_CALURI</link>
105
#define <link linkend="EVC-CATEGORIES:CAPS">EVC_CATEGORIES</link>
106
#define <link linkend="EVC-EMAIL:CAPS">EVC_EMAIL</link>
107
#define <link linkend="EVC-ENCODING:CAPS">EVC_ENCODING</link>
108
#define <link linkend="EVC-FBURL:CAPS">EVC_FBURL</link>
109
#define <link linkend="EVC-FN:CAPS">EVC_FN</link>
110
#define <link linkend="EVC-GEO:CAPS">EVC_GEO</link>
111
#define <link linkend="EVC-ICSCALENDAR:CAPS">EVC_ICSCALENDAR</link>
112
#define <link linkend="EVC-KEY:CAPS">EVC_KEY</link>
113
#define <link linkend="EVC-LABEL:CAPS">EVC_LABEL</link>
114
#define <link linkend="EVC-LOGO:CAPS">EVC_LOGO</link>
115
#define <link linkend="EVC-MAILER:CAPS">EVC_MAILER</link>
116
#define <link linkend="EVC-NICKNAME:CAPS">EVC_NICKNAME</link>
117
#define <link linkend="EVC-N:CAPS">EVC_N</link>
118
#define <link linkend="EVC-NOTE:CAPS">EVC_NOTE</link>
119
#define <link linkend="EVC-ORG:CAPS">EVC_ORG</link>
120
#define <link linkend="EVC-PHOTO:CAPS">EVC_PHOTO</link>
121
#define <link linkend="EVC-PRODID:CAPS">EVC_PRODID</link>
122
#define <link linkend="EVC-QUOTEDPRINTABLE:CAPS">EVC_QUOTEDPRINTABLE</link>
123
#define <link linkend="EVC-REV:CAPS">EVC_REV</link>
124
#define <link linkend="EVC-ROLE:CAPS">EVC_ROLE</link>
125
#define <link linkend="EVC-TEL:CAPS">EVC_TEL</link>
126
#define <link linkend="EVC-TITLE:CAPS">EVC_TITLE</link>
127
#define <link linkend="EVC-TYPE:CAPS">EVC_TYPE</link>
128
#define <link linkend="EVC-UID:CAPS">EVC_UID</link>
129
#define <link linkend="EVC-URL:CAPS">EVC_URL</link>
130
#define <link linkend="EVC-VALUE:CAPS">EVC_VALUE</link>
131
#define <link linkend="EVC-VERSION:CAPS">EVC_VERSION</link>
132
#define <link linkend="EVC-X-AIM:CAPS">EVC_X_AIM</link>
133
#define <link linkend="EVC-X-ANNIVERSARY:CAPS">EVC_X_ANNIVERSARY</link>
134
#define <link linkend="EVC-X-ASSISTANT:CAPS">EVC_X_ASSISTANT</link>
135
#define <link linkend="EVC-X-BIRTHDAY:CAPS">EVC_X_BIRTHDAY</link>
136
#define <link linkend="EVC-X-BLOG-URL:CAPS">EVC_X_BLOG_URL</link>
137
#define <link linkend="EVC-X-FILE-AS:CAPS">EVC_X_FILE_AS</link>
138
#define <link linkend="EVC-X-GADUGADU:CAPS">EVC_X_GADUGADU</link>
139
#define <link linkend="EVC-X-ICQ:CAPS">EVC_X_ICQ</link>
140
#define <link linkend="EVC-X-JABBER:CAPS">EVC_X_JABBER</link>
141
#define <link linkend="EVC-X-LIST-SHOW-ADDRESSES:CAPS">EVC_X_LIST_SHOW_ADDRESSES</link>
142
#define <link linkend="EVC-X-LIST:CAPS">EVC_X_LIST</link>
143
#define <link linkend="EVC-X-MANAGER:CAPS">EVC_X_MANAGER</link>
144
#define <link linkend="EVC-X-MSN:CAPS">EVC_X_MSN</link>
145
#define <link linkend="EVC-X-SKYPE:CAPS">EVC_X_SKYPE</link>
146
#define <link linkend="EVC-X-WANTS-HTML:CAPS">EVC_X_WANTS_HTML</link>
147
#define <link linkend="EVC-X-YAHOO:CAPS">EVC_X_YAHOO</link>
148
#define <link linkend="EVC-X-BOOK-URI:CAPS">EVC_X_BOOK_URI</link>
149
#define <link linkend="EVC-X-CALLBACK:CAPS">EVC_X_CALLBACK</link>
150
#define <link linkend="EVC-X-COMPANY:CAPS">EVC_X_COMPANY</link>
151
#define <link linkend="EVC-X-DEST-CONTACT-UID:CAPS">EVC_X_DEST_CONTACT_UID</link>
152
#define <link linkend="EVC-X-DEST-EMAIL:CAPS">EVC_X_DEST_EMAIL</link>
153
#define <link linkend="EVC-X-DEST-EMAIL-NUM:CAPS">EVC_X_DEST_EMAIL_NUM</link>
154
#define <link linkend="EVC-X-DEST-HTML-MAIL:CAPS">EVC_X_DEST_HTML_MAIL</link>
155
#define <link linkend="EVC-X-DEST-NAME:CAPS">EVC_X_DEST_NAME</link>
156
#define <link linkend="EVC-X-DEST-SOURCE-UID:CAPS">EVC_X_DEST_SOURCE_UID</link>
157
#define <link linkend="EVC-X-GROUPWISE:CAPS">EVC_X_GROUPWISE</link>
158
#define <link linkend="EVC-X-RADIO:CAPS">EVC_X_RADIO</link>
159
#define <link linkend="EVC-X-SIP:CAPS">EVC_X_SIP</link>
160
#define <link linkend="EVC-X-SPOUSE:CAPS">EVC_X_SPOUSE</link>
161
#define <link linkend="EVC-X-TELEX:CAPS">EVC_X_TELEX</link>
162
#define <link linkend="EVC-X-TTYTDD:CAPS">EVC_X_TTYTDD</link>
163
#define <link linkend="EVC-X-VIDEO-URL:CAPS">EVC_X_VIDEO_URL</link>
166
<refsect1 id="EVCard.object-hierarchy" role="object_hierarchy">
167
<title role="object_hierarchy.title">Object Hierarchy</title>
169
<link linkend="GObject">GObject</link>
171
+----<link linkend="EContact">EContact</link>
175
<refsect1 id="EVCard.description" role="desc">
176
<title role="desc.title">Description</title>
178
Does the low-level parsing work for contact information. This data is more conveniently accessed through the EContact object.
181
<refsect1 id="EVCard.details" role="details">
182
<title role="details.title">Details</title>
183
<refsect2 id="EVCard-struct" role="struct">
184
<title>EVCard</title>
185
<indexterm zone="EVCard-struct"><primary>EVCard</primary></indexterm>
186
<programlisting>typedef struct _EVCard EVCard;</programlisting>
189
<refsect2 id="EVCardFormat" role="enum">
190
<title>enum EVCardFormat</title>
191
<indexterm zone="EVCardFormat"><primary>EVCardFormat</primary></indexterm>
192
<programlisting>typedef enum {
199
<refsect2 id="EVCardAttribute" role="struct">
200
<title>EVCardAttribute</title>
201
<indexterm zone="EVCardAttribute"><primary>EVCardAttribute</primary></indexterm>
202
<programlisting>typedef struct _EVCardAttribute EVCardAttribute;</programlisting>
205
<refsect2 id="EVCardAttributeParam" role="struct">
206
<title>EVCardAttributeParam</title>
207
<indexterm zone="EVCardAttributeParam"><primary>EVCardAttributeParam</primary></indexterm>
208
<programlisting>typedef struct _EVCardAttributeParam EVCardAttributeParam;</programlisting>
211
<refsect2 id="e-vcard-new" role="function">
212
<title>e_vcard_new ()</title>
213
<indexterm zone="e-vcard-new"><primary>e_vcard_new</primary></indexterm>
214
<programlisting><link linkend="EVCard"><returnvalue>EVCard</returnvalue></link>* e_vcard_new (<parameter><type>void</type></parameter>);</programlisting>
216
Creates a new, blank <link linkend="EVCard"><type>EVCard</type></link>.</para>
217
<variablelist role="params">
218
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new, blank <link linkend="EVCard"><type>EVCard</type></link>.
219
</simpara></listitem></varlistentry>
220
</variablelist></refsect2>
221
<refsect2 id="e-vcard-new-from-string" role="function">
222
<title>e_vcard_new_from_string ()</title>
223
<indexterm zone="e-vcard-new-from-string"><primary>e_vcard_new_from_string</primary></indexterm>
224
<programlisting><link linkend="EVCard"><returnvalue>EVCard</returnvalue></link>* e_vcard_new_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *str</parameter>);</programlisting>
226
Creates a new <link linkend="EVCard"><type>EVCard</type></link> from the passed-in string
227
representation.</para>
228
<variablelist role="params">
229
<varlistentry><term><parameter>str</parameter> :</term>
230
<listitem><simpara>a string representation of the vcard to create
231
</simpara></listitem></varlistentry>
232
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EVCard"><type>EVCard</type></link>.
233
</simpara></listitem></varlistentry>
234
</variablelist></refsect2>
235
<refsect2 id="e-vcard-to-string" role="function">
236
<title>e_vcard_to_string ()</title>
237
<indexterm zone="e-vcard-to-string"><primary>e_vcard_to_string</primary></indexterm>
238
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_to_string (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
239
<parameter><link linkend="EVCardFormat"><type>EVCardFormat</type></link> format</parameter>);</programlisting>
241
Exports <parameter>evc</parameter> to a string representation, specified
242
by the <parameter>format</parameter> argument.</para>
243
<variablelist role="params">
244
<varlistentry><term><parameter>evc</parameter> :</term>
245
<listitem><simpara>the <link linkend="EVCard"><type>EVCard</type></link> to export
246
</simpara></listitem></varlistentry>
247
<varlistentry><term><parameter>format</parameter> :</term>
248
<listitem><simpara>the format to export to
249
</simpara></listitem></varlistentry>
250
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated string representing the vcard.
251
</simpara></listitem></varlistentry>
252
</variablelist></refsect2>
253
<refsect2 id="e-vcard-dump-structure" role="function">
254
<title>e_vcard_dump_structure ()</title>
255
<indexterm zone="e-vcard-dump-structure"><primary>e_vcard_dump_structure</primary></indexterm>
256
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_dump_structure (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>);</programlisting>
258
Prints a dump of <parameter>evc</parameter>'s structure to stdout. Used for
260
<variablelist role="params">
261
<varlistentry><term><parameter>evc</parameter> :</term>
262
<listitem><simpara>the <link linkend="EVCard"><type>EVCard</type></link> to dump
263
</simpara></listitem></varlistentry>
264
</variablelist></refsect2>
265
<refsect2 id="e-vcard-attribute-new" role="function">
266
<title>e_vcard_attribute_new ()</title>
267
<indexterm zone="e-vcard-attribute-new"><primary>e_vcard_attribute_new</primary></indexterm>
268
<programlisting><link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * e_vcard_attribute_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_group</parameter>,
269
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_name</parameter>);</programlisting>
271
Creates a new <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> with the specified group and
272
attribute names.</para>
273
<variablelist role="params">
274
<varlistentry><term><parameter>attr_group</parameter> :</term>
275
<listitem><simpara>a group name
276
</simpara></listitem></varlistentry>
277
<varlistentry><term><parameter>attr_name</parameter> :</term>
278
<listitem><simpara>an attribute name
279
</simpara></listitem></varlistentry>
280
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>.
281
</simpara></listitem></varlistentry>
282
</variablelist></refsect2>
283
<refsect2 id="e-vcard-attribute-free" role="function">
284
<title>e_vcard_attribute_free ()</title>
285
<indexterm zone="e-vcard-attribute-free"><primary>e_vcard_attribute_free</primary></indexterm>
286
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_free (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
288
Frees an attribute, its values and its parameters.</para>
289
<variablelist role="params">
290
<varlistentry><term><parameter>attr</parameter> :</term>
291
<listitem><simpara>attribute to free
292
</simpara></listitem></varlistentry>
293
</variablelist></refsect2>
294
<refsect2 id="e-vcard-attribute-copy" role="function">
295
<title>e_vcard_attribute_copy ()</title>
296
<indexterm zone="e-vcard-attribute-copy"><primary>e_vcard_attribute_copy</primary></indexterm>
297
<programlisting><link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * e_vcard_attribute_copy (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
299
Makes a copy of <parameter>attr</parameter>.</para>
300
<variablelist role="params">
301
<varlistentry><term><parameter>attr</parameter> :</term>
302
<listitem><simpara>attribute to copy
303
</simpara></listitem></varlistentry>
304
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> identical to <parameter>attr</parameter>.
305
</simpara></listitem></varlistentry>
306
</variablelist></refsect2>
307
<refsect2 id="e-vcard-remove-attributes" role="function">
308
<title>e_vcard_remove_attributes ()</title>
309
<indexterm zone="e-vcard-remove-attributes"><primary>e_vcard_remove_attributes</primary></indexterm>
310
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_remove_attributes (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
311
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_group</parameter>,
312
<parameter>const <link linkend="gchar"><type>gchar</type></link> *attr_name</parameter>);</programlisting>
314
Removes all the attributes with group name and attribute name equal to
315
passed in values. If <parameter>attr_group</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link> or an empty string,
316
it removes all the attributes with passed in name irrespective of
317
their group names.</para>
318
<variablelist role="params">
319
<varlistentry><term><parameter>evc</parameter> :</term>
320
<listitem><simpara>vcard object
321
</simpara></listitem></varlistentry>
322
<varlistentry><term><parameter>attr_group</parameter> :</term>
323
<listitem><simpara>group name of attributes to be removed
324
</simpara></listitem></varlistentry>
325
<varlistentry><term><parameter>attr_name</parameter> :</term>
326
<listitem><simpara>name of the arributes to be removed
327
</simpara></listitem></varlistentry>
328
</variablelist></refsect2>
329
<refsect2 id="e-vcard-remove-attribute" role="function">
330
<title>e_vcard_remove_attribute ()</title>
331
<indexterm zone="e-vcard-remove-attribute"><primary>e_vcard_remove_attribute</primary></indexterm>
332
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_remove_attribute (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
333
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
335
Removes <parameter>attr</parameter> from <parameter>evc</parameter> and frees it.</para>
336
<variablelist role="params">
337
<varlistentry><term><parameter>evc</parameter> :</term>
338
<listitem><simpara>an <link linkend="EVCard"><type>EVCard</type></link>
339
</simpara></listitem></varlistentry>
340
<varlistentry><term><parameter>attr</parameter> :</term>
341
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> to remove
342
</simpara></listitem></varlistentry>
343
</variablelist></refsect2>
344
<refsect2 id="e-vcard-add-attribute" role="function">
345
<title>e_vcard_add_attribute ()</title>
346
<indexterm zone="e-vcard-add-attribute"><primary>e_vcard_add_attribute</primary></indexterm>
347
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_add_attribute (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
348
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
350
Adds <parameter>attr</parameter> to <parameter>evc</parameter>.</para>
351
<variablelist role="params">
352
<varlistentry><term><parameter>evc</parameter> :</term>
353
<listitem><simpara>an <link linkend="EVCard"><type>EVCard</type></link>
354
</simpara></listitem></varlistentry>
355
<varlistentry><term><parameter>attr</parameter> :</term>
356
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> to add
357
</simpara></listitem></varlistentry>
358
</variablelist></refsect2>
359
<refsect2 id="e-vcard-add-attribute-with-value" role="function">
360
<title>e_vcard_add_attribute_with_value ()</title>
361
<indexterm zone="e-vcard-add-attribute-with-value"><primary>e_vcard_add_attribute_with_value</primary></indexterm>
362
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_add_attribute_with_value (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>,
363
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
364
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
366
Adds <parameter>attr</parameter> to <parameter>evcard</parameter>, setting it to <parameter>value</parameter>.</para>
367
<variablelist role="params">
368
<varlistentry><term><parameter>evcard</parameter> :</term>
369
<listitem><simpara>an <link linkend="EVCard"><type>EVCard</type></link>
370
</simpara></listitem></varlistentry>
371
<varlistentry><term><parameter>attr</parameter> :</term>
372
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> to add
373
</simpara></listitem></varlistentry>
374
<varlistentry><term><parameter>value</parameter> :</term>
375
<listitem><simpara>a value to assign to the attribute
376
</simpara></listitem></varlistentry>
377
</variablelist></refsect2>
378
<refsect2 id="e-vcard-add-attribute-with-values" role="function">
379
<title>e_vcard_add_attribute_with_values ()</title>
380
<indexterm zone="e-vcard-add-attribute-with-values"><primary>e_vcard_add_attribute_with_values</primary></indexterm>
381
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_add_attribute_with_values (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>,
382
<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
383
<parameter>...</parameter>);</programlisting>
385
Adds <parameter>attr</parameter> to <parameter>evcard</parameter>, assigning the list of values to it.</para>
386
<variablelist role="params">
387
<varlistentry><term><parameter>evcard</parameter> :</term>
388
<listitem><simpara>an <parameter>EVCard</parameter>
389
</simpara></listitem></varlistentry>
390
<varlistentry><term><parameter>attr</parameter> :</term>
391
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> to add
392
</simpara></listitem></varlistentry>
393
<varlistentry><term><parameter>...</parameter> :</term>
394
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of values to assign to the attribute
395
</simpara></listitem></varlistentry>
396
</variablelist></refsect2>
397
<refsect2 id="e-vcard-attribute-add-value" role="function">
398
<title>e_vcard_attribute_add_value ()</title>
399
<indexterm zone="e-vcard-attribute-add-value"><primary>e_vcard_attribute_add_value</primary></indexterm>
400
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_value (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
401
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
403
Adds <parameter>value</parameter> to <parameter>attr</parameter>'s list of values.</para>
404
<variablelist role="params">
405
<varlistentry><term><parameter>attr</parameter> :</term>
406
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>value</parameter> :</term>
409
<listitem><simpara>a string value
410
</simpara></listitem></varlistentry>
411
</variablelist></refsect2>
412
<refsect2 id="e-vcard-attribute-add-value-decoded" role="function">
413
<title>e_vcard_attribute_add_value_decoded ()</title>
414
<indexterm zone="e-vcard-attribute-add-value-decoded"><primary>e_vcard_attribute_add_value_decoded</primary></indexterm>
415
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_value_decoded (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
416
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>,
417
<parameter><link linkend="gint"><type>gint</type></link> len</parameter>);</programlisting>
419
Decodes <parameter>value</parameter> according to the encoding used for <parameter>attr</parameter>, and
420
adds it to <parameter>attr</parameter>'s list of values.</para>
421
<variablelist role="params">
422
<varlistentry><term><parameter>attr</parameter> :</term>
423
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
424
</simpara></listitem></varlistentry>
425
<varlistentry><term><parameter>value</parameter> :</term>
426
<listitem><simpara>an encoded value
427
</simpara></listitem></varlistentry>
428
<varlistentry><term><parameter>len</parameter> :</term>
429
<listitem><simpara>the length of the encoded value, in bytes
430
</simpara></listitem></varlistentry>
431
</variablelist></refsect2>
432
<refsect2 id="e-vcard-attribute-add-values" role="function">
433
<title>e_vcard_attribute_add_values ()</title>
434
<indexterm zone="e-vcard-attribute-add-values"><primary>e_vcard_attribute_add_values</primary></indexterm>
435
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_values (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
436
<parameter>...</parameter>);</programlisting>
438
Adds a list of values to <parameter>attr</parameter>.</para>
439
<variablelist role="params">
440
<varlistentry><term><parameter>attr</parameter> :</term>
441
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
442
</simpara></listitem></varlistentry>
443
<varlistentry><term><parameter>...</parameter> :</term>
444
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of strings
445
</simpara></listitem></varlistentry>
446
</variablelist></refsect2>
447
<refsect2 id="e-vcard-attribute-remove-values" role="function">
448
<title>e_vcard_attribute_remove_values ()</title>
449
<indexterm zone="e-vcard-attribute-remove-values"><primary>e_vcard_attribute_remove_values</primary></indexterm>
450
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_remove_values (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
452
Removes all values from <parameter>attr</parameter>.</para>
453
<variablelist role="params">
454
<varlistentry><term><parameter>attr</parameter> :</term>
455
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
456
</simpara></listitem></varlistentry>
457
</variablelist></refsect2>
458
<refsect2 id="e-vcard-attribute-remove-value" role="function">
459
<title>e_vcard_attribute_remove_value ()</title>
460
<indexterm zone="e-vcard-attribute-remove-value"><primary>e_vcard_attribute_remove_value</primary></indexterm>
461
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_remove_value (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
462
<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);</programlisting>
464
Removes from the value list in <parameter>attr</parameter> the value <parameter>s</parameter>.</para>
465
<variablelist role="params">
466
<varlistentry><term><parameter>attr</parameter> :</term>
467
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
468
</simpara></listitem></varlistentry>
469
<varlistentry><term><parameter>s</parameter> :</term>
470
<listitem><simpara>an value to remove
471
</simpara></listitem></varlistentry>
472
</variablelist></refsect2>
473
<refsect2 id="e-vcard-attribute-remove-params" role="function">
474
<title>e_vcard_attribute_remove_params ()</title>
475
<indexterm zone="e-vcard-attribute-remove-params"><primary>e_vcard_attribute_remove_params</primary></indexterm>
476
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_remove_params (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
478
Removes all parameters from <parameter>attr</parameter>.</para>
479
<variablelist role="params">
480
<varlistentry><term><parameter>attr</parameter> :</term>
481
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
482
</simpara></listitem></varlistentry>
483
</variablelist></refsect2>
484
<refsect2 id="e-vcard-attribute-remove-param" role="function">
485
<title>e_vcard_attribute_remove_param ()</title>
486
<indexterm zone="e-vcard-attribute-remove-param"><primary>e_vcard_attribute_remove_param</primary></indexterm>
487
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_remove_param (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
488
<parameter>const <link linkend="gchar"><type>gchar</type></link> *param_name</parameter>);</programlisting>
490
Removes the parameter <parameter>param_name</parameter> from the attribute <parameter>attr</parameter>.
494
<variablelist role="params">
495
<varlistentry><term><parameter>attr</parameter> :</term>
496
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
497
</simpara></listitem></varlistentry>
498
<varlistentry><term><parameter>param_name</parameter> :</term>
499
<listitem><simpara>a parameter name
500
</simpara></listitem></varlistentry>
501
</variablelist></refsect2>
502
<refsect2 id="e-vcard-attribute-remove-param-value" role="function">
503
<title>e_vcard_attribute_remove_param_value ()</title>
504
<indexterm zone="e-vcard-attribute-remove-param-value"><primary>e_vcard_attribute_remove_param_value</primary></indexterm>
505
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_remove_param_value
506
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
507
<parameter>const <link linkend="gchar"><type>gchar</type></link> *param_name</parameter>,
508
<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);</programlisting>
510
Removes the value <parameter>s</parameter> from the parameter <parameter>param_name</parameter> on the attribute <parameter>attr</parameter>.</para>
511
<variablelist role="params">
512
<varlistentry><term><parameter>attr</parameter> :</term>
513
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
514
</simpara></listitem></varlistentry>
515
<varlistentry><term><parameter>param_name</parameter> :</term>
516
<listitem><simpara>a parameter name
517
</simpara></listitem></varlistentry>
518
<varlistentry><term><parameter>s</parameter> :</term>
519
<listitem><simpara>a value
520
</simpara></listitem></varlistentry>
521
</variablelist></refsect2>
522
<refsect2 id="e-vcard-attribute-param-new" role="function">
523
<title>e_vcard_attribute_param_new ()</title>
524
<indexterm zone="e-vcard-attribute-param-new"><primary>e_vcard_attribute_param_new</primary></indexterm>
525
<programlisting><link linkend="EVCardAttributeParam"><returnvalue>EVCardAttributeParam</returnvalue></link>* e_vcard_attribute_param_new (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
527
Creates a new parameter named <parameter>name</parameter>.</para>
528
<variablelist role="params">
529
<varlistentry><term><parameter>name</parameter> :</term>
530
<listitem><simpara>the name of the new parameter
531
</simpara></listitem></varlistentry>
532
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>.
533
</simpara></listitem></varlistentry>
534
</variablelist></refsect2>
535
<refsect2 id="e-vcard-attribute-param-free" role="function">
536
<title>e_vcard_attribute_param_free ()</title>
537
<indexterm zone="e-vcard-attribute-param-free"><primary>e_vcard_attribute_param_free</primary></indexterm>
538
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_param_free (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
540
Frees <parameter>param</parameter> and its values.</para>
541
<variablelist role="params">
542
<varlistentry><term><parameter>param</parameter> :</term>
543
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
544
</simpara></listitem></varlistentry>
545
</variablelist></refsect2>
546
<refsect2 id="e-vcard-attribute-param-copy" role="function">
547
<title>e_vcard_attribute_param_copy ()</title>
548
<indexterm zone="e-vcard-attribute-param-copy"><primary>e_vcard_attribute_param_copy</primary></indexterm>
549
<programlisting><link linkend="EVCardAttributeParam"><returnvalue>EVCardAttributeParam</returnvalue></link>* e_vcard_attribute_param_copy (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
551
Makes a copy of <parameter>param</parameter>.</para>
552
<variablelist role="params">
553
<varlistentry><term><parameter>param</parameter> :</term>
554
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
555
</simpara></listitem></varlistentry>
556
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> identical to <parameter>param</parameter>.
557
</simpara></listitem></varlistentry>
558
</variablelist></refsect2>
559
<refsect2 id="e-vcard-attribute-add-param" role="function">
560
<title>e_vcard_attribute_add_param ()</title>
561
<indexterm zone="e-vcard-attribute-add-param"><primary>e_vcard_attribute_add_param</primary></indexterm>
562
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_param (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
563
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
565
Adds <parameter>param</parameter> to <parameter>attr</parameter>'s list of parameters.
566
It tests for duplicities, only new parameters are added,
567
when a new parameter already exists in attr, then those
568
values are merged, also without creating duplicities.
569
When we will not add whole param, then it's freed here.</para>
570
<variablelist role="params">
571
<varlistentry><term><parameter>attr</parameter> :</term>
572
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
573
</simpara></listitem></varlistentry>
574
<varlistentry><term><parameter>param</parameter> :</term>
575
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> to add
576
</simpara></listitem></varlistentry>
577
</variablelist></refsect2>
578
<refsect2 id="e-vcard-attribute-add-param-with-value" role="function">
579
<title>e_vcard_attribute_add_param_with_value ()</title>
580
<indexterm zone="e-vcard-attribute-add-param-with-value"><primary>e_vcard_attribute_add_param_with_value</primary></indexterm>
581
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_param_with_value
582
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
583
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
584
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
586
Adds <parameter>value</parameter> to <parameter>param</parameter>, then adds <parameter>param</parameter> to <parameter>attr</parameter>.</para>
587
<variablelist role="params">
588
<varlistentry><term><parameter>attr</parameter> :</term>
589
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
590
</simpara></listitem></varlistentry>
591
<varlistentry><term><parameter>param</parameter> :</term>
592
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
593
</simpara></listitem></varlistentry>
594
<varlistentry><term><parameter>value</parameter> :</term>
595
<listitem><simpara>a string value
596
</simpara></listitem></varlistentry>
597
</variablelist></refsect2>
598
<refsect2 id="e-vcard-attribute-add-param-with-values" role="function">
599
<title>e_vcard_attribute_add_param_with_values ()</title>
600
<indexterm zone="e-vcard-attribute-add-param-with-values"><primary>e_vcard_attribute_add_param_with_values</primary></indexterm>
601
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_add_param_with_values
602
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
603
<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
604
<parameter>...</parameter>);</programlisting>
606
Adds the list of values to <parameter>param</parameter>, then adds <parameter>param</parameter>
607
to <parameter>attr</parameter>.</para>
608
<variablelist role="params">
609
<varlistentry><term><parameter>attr</parameter> :</term>
610
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
611
</simpara></listitem></varlistentry>
612
<varlistentry><term><parameter>param</parameter> :</term>
613
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
614
</simpara></listitem></varlistentry>
615
<varlistentry><term><parameter>...</parameter> :</term>
616
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of strings
617
</simpara></listitem></varlistentry>
618
</variablelist></refsect2>
619
<refsect2 id="e-vcard-attribute-param-add-value" role="function">
620
<title>e_vcard_attribute_param_add_value ()</title>
621
<indexterm zone="e-vcard-attribute-param-add-value"><primary>e_vcard_attribute_param_add_value</primary></indexterm>
622
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_param_add_value (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
623
<parameter>const <link linkend="gchar"><type>gchar</type></link> *value</parameter>);</programlisting>
625
Adds <parameter>value</parameter> to <parameter>param</parameter>'s list of values.</para>
626
<variablelist role="params">
627
<varlistentry><term><parameter>param</parameter> :</term>
628
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
629
</simpara></listitem></varlistentry>
630
<varlistentry><term><parameter>value</parameter> :</term>
631
<listitem><simpara>a string value to add
632
</simpara></listitem></varlistentry>
633
</variablelist></refsect2>
634
<refsect2 id="e-vcard-attribute-param-add-values" role="function">
635
<title>e_vcard_attribute_param_add_values ()</title>
636
<indexterm zone="e-vcard-attribute-param-add-values"><primary>e_vcard_attribute_param_add_values</primary></indexterm>
637
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_param_add_values (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>,
638
<parameter>...</parameter>);</programlisting>
640
Adds a list of values to <parameter>param</parameter>.</para>
641
<variablelist role="params">
642
<varlistentry><term><parameter>param</parameter> :</term>
643
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
644
</simpara></listitem></varlistentry>
645
<varlistentry><term><parameter>...</parameter> :</term>
646
<listitem><simpara>a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of strings
647
</simpara></listitem></varlistentry>
648
</variablelist></refsect2>
649
<refsect2 id="e-vcard-attribute-param-remove-values" role="function">
650
<title>e_vcard_attribute_param_remove_values ()</title>
651
<indexterm zone="e-vcard-attribute-param-remove-values"><primary>e_vcard_attribute_param_remove_values</primary></indexterm>
652
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_vcard_attribute_param_remove_values
653
(<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
655
Removes and frees all values from <parameter>param</parameter>.</para>
656
<variablelist role="params">
657
<varlistentry><term><parameter>param</parameter> :</term>
658
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
659
</simpara></listitem></varlistentry>
660
</variablelist></refsect2>
661
<refsect2 id="e-vcard-attribute-param-get-name" role="function">
662
<title>e_vcard_attribute_param_get_name ()</title>
663
<indexterm zone="e-vcard-attribute-param-get-name"><primary>e_vcard_attribute_param_get_name</primary></indexterm>
664
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_attribute_param_get_name (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
666
Gets the name of <parameter>param</parameter>.</para>
667
<variablelist role="params">
668
<varlistentry><term><parameter>param</parameter> :</term>
669
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
670
</simpara></listitem></varlistentry>
671
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the parameter.
672
</simpara></listitem></varlistentry>
673
</variablelist></refsect2>
674
<refsect2 id="e-vcard-attribute-param-get-values" role="function">
675
<title>e_vcard_attribute_param_get_values ()</title>
676
<indexterm zone="e-vcard-attribute-param-get-values"><primary>e_vcard_attribute_param_get_values</primary></indexterm>
677
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_attribute_param_get_values (<parameter><link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> *param</parameter>);</programlisting>
679
Gets the list of values from <parameter>param</parameter>. The list and its
680
contents are owned by <parameter>param</parameter>, and must not be freed.</para>
681
<variablelist role="params">
682
<varlistentry><term><parameter>param</parameter> :</term>
683
<listitem><simpara>an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>
684
</simpara></listitem></varlistentry>
685
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of string elements representing the parameter's values.
686
</simpara></listitem></varlistentry>
687
</variablelist></refsect2>
688
<refsect2 id="e-vcard-get-attribute" role="function">
689
<title>e_vcard_get_attribute ()</title>
690
<indexterm zone="e-vcard-get-attribute"><primary>e_vcard_get_attribute</primary></indexterm>
691
<programlisting><link linkend="EVCardAttribute"><returnvalue>EVCardAttribute</returnvalue></link> * e_vcard_get_attribute (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evc</parameter>,
692
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
694
Get the attribute <parameter>name</parameter> from <parameter>evc</parameter>. The <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> is owned by
695
<parameter>evcard</parameter> and should not be freed. If the attribute does not exist, <link linkend="NULL:CAPS"><type>NULL</type></link> is
697
<variablelist role="params">
698
<varlistentry><term><parameter>evc</parameter> :</term>
699
<listitem><simpara>an <link linkend="EVCard"><type>EVCard</type></link>
700
</simpara></listitem></varlistentry>
701
<varlistentry><term><parameter>name</parameter> :</term>
702
<listitem><simpara>the name of the attribute to get
703
</simpara></listitem></varlistentry>
704
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> if found, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
705
</simpara></listitem></varlistentry>
706
</variablelist></refsect2>
707
<refsect2 id="e-vcard-get-attributes" role="function">
708
<title>e_vcard_get_attributes ()</title>
709
<indexterm zone="e-vcard-get-attributes"><primary>e_vcard_get_attributes</primary></indexterm>
710
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_get_attributes (<parameter><link linkend="EVCard"><type>EVCard</type></link> *evcard</parameter>);</programlisting>
712
Gets the list of attributes from <parameter>evcard</parameter>. The list and its
713
contents are owned by <parameter>evcard</parameter>, and must not be freed.</para>
714
<variablelist role="params">
715
<varlistentry><term><parameter>evcard</parameter> :</term>
716
<listitem><simpara>an <link linkend="EVCard"><type>EVCard</type></link>
717
</simpara></listitem></varlistentry>
718
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of attributes of type <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>.
719
</simpara></listitem></varlistentry>
720
</variablelist></refsect2>
721
<refsect2 id="e-vcard-attribute-get-group" role="function">
722
<title>e_vcard_attribute_get_group ()</title>
723
<indexterm zone="e-vcard-attribute-get-group"><primary>e_vcard_attribute_get_group</primary></indexterm>
724
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_attribute_get_group (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
726
Gets the group name of <parameter>attr</parameter>.</para>
727
<variablelist role="params">
728
<varlistentry><term><parameter>attr</parameter> :</term>
729
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
730
</simpara></listitem></varlistentry>
731
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The attribute's group name.
732
</simpara></listitem></varlistentry>
733
</variablelist></refsect2>
734
<refsect2 id="e-vcard-attribute-get-name" role="function">
735
<title>e_vcard_attribute_get_name ()</title>
736
<indexterm zone="e-vcard-attribute-get-name"><primary>e_vcard_attribute_get_name</primary></indexterm>
737
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_attribute_get_name (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
739
Gets the name of <parameter>attr</parameter>.</para>
740
<variablelist role="params">
741
<varlistentry><term><parameter>attr</parameter> :</term>
742
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
743
</simpara></listitem></varlistentry>
744
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The attribute's name.
745
</simpara></listitem></varlistentry>
746
</variablelist></refsect2>
747
<refsect2 id="e-vcard-attribute-get-values" role="function">
748
<title>e_vcard_attribute_get_values ()</title>
749
<indexterm zone="e-vcard-attribute-get-values"><primary>e_vcard_attribute_get_values</primary></indexterm>
750
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_attribute_get_values (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
752
Gets the list of values from <parameter>attr</parameter>. The list and its
753
contents are owned by <parameter>attr</parameter>, and must not be freed.</para>
754
<variablelist role="params">
755
<varlistentry><term><parameter>attr</parameter> :</term>
756
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
757
</simpara></listitem></varlistentry>
758
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of string values.
759
</simpara></listitem></varlistentry>
760
</variablelist></refsect2>
761
<refsect2 id="e-vcard-attribute-get-values-decoded" role="function">
762
<title>e_vcard_attribute_get_values_decoded ()</title>
763
<indexterm zone="e-vcard-attribute-get-values-decoded"><primary>e_vcard_attribute_get_values_decoded</primary></indexterm>
764
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_attribute_get_values_decoded
765
(<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
767
Gets the list of values from <parameter>attr</parameter>, decoding them if
768
necessary. The list and its contents are owned by <parameter>attr</parameter>,
769
and must not be freed.</para>
770
<variablelist role="params">
771
<varlistentry><term><parameter>attr</parameter> :</term>
772
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
773
</simpara></listitem></varlistentry>
774
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of values of type <link linkend="GString"><type>GString</type></link>.
775
</simpara></listitem></varlistentry>
776
</variablelist></refsect2>
777
<refsect2 id="e-vcard-attribute-get-params" role="function">
778
<title>e_vcard_attribute_get_params ()</title>
779
<indexterm zone="e-vcard-attribute-get-params"><primary>e_vcard_attribute_get_params</primary></indexterm>
780
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_attribute_get_params (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
782
Gets the list of parameters from <parameter>attr</parameter>. The list and its
783
contents are owned by <parameter>attr</parameter>, and must not be freed.</para>
784
<variablelist role="params">
785
<varlistentry><term><parameter>attr</parameter> :</term>
786
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
787
</simpara></listitem></varlistentry>
788
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of elements of type <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link>.
789
</simpara></listitem></varlistentry>
790
</variablelist></refsect2>
791
<refsect2 id="e-vcard-attribute-get-param" role="function">
792
<title>e_vcard_attribute_get_param ()</title>
793
<indexterm zone="e-vcard-attribute-get-param"><primary>e_vcard_attribute_get_param</primary></indexterm>
794
<programlisting><link linkend="GList"><returnvalue>GList</returnvalue></link>* e_vcard_attribute_get_param (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
795
<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
797
Gets the list of values for the paramater <parameter>name</parameter> from <parameter>attr</parameter>. The list and its
798
contents are owned by <parameter>attr</parameter>, and must not be freed.</para>
799
<variablelist role="params">
800
<varlistentry><term><parameter>attr</parameter> :</term>
801
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
802
</simpara></listitem></varlistentry>
803
<varlistentry><term><parameter>name</parameter> :</term>
804
<listitem><simpara>a parameter name
805
</simpara></listitem></varlistentry>
806
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A list of string elements representing the parameter's values.
807
</simpara></listitem></varlistentry>
808
</variablelist></refsect2>
809
<refsect2 id="e-vcard-attribute-get-value" role="function">
810
<title>e_vcard_attribute_get_value ()</title>
811
<indexterm zone="e-vcard-attribute-get-value"><primary>e_vcard_attribute_get_value</primary></indexterm>
812
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_attribute_get_value (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
814
Gets the value of a single-valued <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>, <parameter>attr</parameter>.</para>
815
<variablelist role="params">
816
<varlistentry><term><parameter>attr</parameter> :</term>
817
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
818
</simpara></listitem></varlistentry>
819
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated string representing the value.
820
</simpara></listitem></varlistentry>
821
</variablelist></refsect2>
822
<refsect2 id="e-vcard-attribute-get-value-decoded" role="function">
823
<title>e_vcard_attribute_get_value_decoded ()</title>
824
<indexterm zone="e-vcard-attribute-get-value-decoded"><primary>e_vcard_attribute_get_value_decoded</primary></indexterm>
825
<programlisting><link linkend="GString"><returnvalue>GString</returnvalue></link>* e_vcard_attribute_get_value_decoded (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
827
Gets the value of a single-valued <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>, <parameter>attr</parameter>, decoding
831
Note: this function seems currently to be unused. Could be removed.</para>
832
<variablelist role="params">
833
<varlistentry><term><parameter>attr</parameter> :</term>
834
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
835
</simpara></listitem></varlistentry>
836
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated <link linkend="GString"><type>GString</type></link> representing the value.
837
</simpara></listitem></varlistentry>
838
</variablelist></refsect2>
839
<refsect2 id="e-vcard-attribute-has-type" role="function">
840
<title>e_vcard_attribute_has_type ()</title>
841
<indexterm zone="e-vcard-attribute-has-type"><primary>e_vcard_attribute_has_type</primary></indexterm>
842
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_vcard_attribute_has_type (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>,
843
<parameter>const <link linkend="gchar"><type>gchar</type></link> *typestr</parameter>);</programlisting>
845
Checks if <parameter>attr</parameter> has an <link linkend="EVCardAttributeParam"><type>EVCardAttributeParam</type></link> of the specified type.</para>
846
<variablelist role="params">
847
<varlistentry><term><parameter>attr</parameter> :</term>
848
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
849
</simpara></listitem></varlistentry>
850
<varlistentry><term><parameter>typestr</parameter> :</term>
851
<listitem><simpara>a string representing the type
852
</simpara></listitem></varlistentry>
853
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if such a parameter exists, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
854
</simpara></listitem></varlistentry>
855
</variablelist></refsect2>
856
<refsect2 id="e-vcard-attribute-is-single-valued" role="function">
857
<title>e_vcard_attribute_is_single_valued ()</title>
858
<indexterm zone="e-vcard-attribute-is-single-valued"><primary>e_vcard_attribute_is_single_valued</primary></indexterm>
859
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_vcard_attribute_is_single_valued (<parameter><link linkend="EVCardAttribute"><type>EVCardAttribute</type></link> *attr</parameter>);</programlisting>
861
Checks if <parameter>attr</parameter> has a single value.</para>
862
<variablelist role="params">
863
<varlistentry><term><parameter>attr</parameter> :</term>
864
<listitem><simpara>an <link linkend="EVCardAttribute"><type>EVCardAttribute</type></link>
865
</simpara></listitem></varlistentry>
866
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the attribute has exactly one value, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
867
</simpara></listitem></varlistentry>
868
</variablelist></refsect2>
869
<refsect2 id="e-vcard-escape-string" role="function">
870
<title>e_vcard_escape_string ()</title>
871
<indexterm zone="e-vcard-escape-string"><primary>e_vcard_escape_string</primary></indexterm>
872
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_escape_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);</programlisting>
874
Escapes a string according to RFC2426, section 5.</para>
875
<variablelist role="params">
876
<varlistentry><term><parameter>s</parameter> :</term>
877
<listitem><simpara>the string to escape
878
</simpara></listitem></varlistentry>
879
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated, escaped string.
880
</simpara></listitem></varlistentry>
881
</variablelist></refsect2>
882
<refsect2 id="e-vcard-unescape-string" role="function">
883
<title>e_vcard_unescape_string ()</title>
884
<indexterm zone="e-vcard-unescape-string"><primary>e_vcard_unescape_string</primary></indexterm>
885
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_vcard_unescape_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *s</parameter>);</programlisting>
887
Unescapes a string according to RFC2426, section 5.</para>
888
<variablelist role="params">
889
<varlistentry><term><parameter>s</parameter> :</term>
890
<listitem><simpara>the string to unescape
891
</simpara></listitem></varlistentry>
892
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly allocated, unescaped string.
893
</simpara></listitem></varlistentry>
894
</variablelist></refsect2>
895
<refsect2 id="EVC-ADR:CAPS" role="macro">
896
<title>EVC_ADR</title>
897
<indexterm zone="EVC-ADR:CAPS"><primary>EVC_ADR</primary></indexterm>
898
<programlisting>#define EVC_ADR "ADR"
902
<refsect2 id="EVC-BDAY:CAPS" role="macro">
903
<title>EVC_BDAY</title>
904
<indexterm zone="EVC-BDAY:CAPS"><primary>EVC_BDAY</primary></indexterm>
905
<programlisting>#define EVC_BDAY "BDAY"
910
<refsect2 id="EVC-CALURI:CAPS" role="macro">
911
<title>EVC_CALURI</title>
912
<indexterm zone="EVC-CALURI:CAPS"><primary>EVC_CALURI</primary></indexterm>
913
<programlisting>#define EVC_CALURI "CALURI"
918
<refsect2 id="EVC-CATEGORIES:CAPS" role="macro">
919
<title>EVC_CATEGORIES</title>
920
<indexterm zone="EVC-CATEGORIES:CAPS"><primary>EVC_CATEGORIES</primary></indexterm>
921
<programlisting>#define EVC_CATEGORIES "CATEGORIES"
926
<refsect2 id="EVC-EMAIL:CAPS" role="macro">
927
<title>EVC_EMAIL</title>
928
<indexterm zone="EVC-EMAIL:CAPS"><primary>EVC_EMAIL</primary></indexterm>
929
<programlisting>#define EVC_EMAIL "EMAIL"
934
<refsect2 id="EVC-ENCODING:CAPS" role="macro">
935
<title>EVC_ENCODING</title>
936
<indexterm zone="EVC-ENCODING:CAPS"><primary>EVC_ENCODING</primary></indexterm>
937
<programlisting>#define EVC_ENCODING "ENCODING"
941
<refsect2 id="EVC-FBURL:CAPS" role="macro">
942
<title>EVC_FBURL</title>
943
<indexterm zone="EVC-FBURL:CAPS"><primary>EVC_FBURL</primary></indexterm>
944
<programlisting>#define EVC_FBURL "FBURL"
948
<refsect2 id="EVC-FN:CAPS" role="macro">
949
<title>EVC_FN</title>
950
<indexterm zone="EVC-FN:CAPS"><primary>EVC_FN</primary></indexterm>
951
<programlisting>#define EVC_FN "FN"
955
<refsect2 id="EVC-GEO:CAPS" role="macro">
956
<title>EVC_GEO</title>
957
<indexterm zone="EVC-GEO:CAPS"><primary>EVC_GEO</primary></indexterm>
958
<programlisting>#define EVC_GEO "GEO"
962
<refsect2 id="EVC-ICSCALENDAR:CAPS" role="macro">
963
<title>EVC_ICSCALENDAR</title>
964
<indexterm zone="EVC-ICSCALENDAR:CAPS"><primary>EVC_ICSCALENDAR</primary></indexterm>
965
<programlisting>#define EVC_ICSCALENDAR "ICSCALENDAR" /* XXX should this be X-EVOLUTION-ICSCALENDAR? */
969
<refsect2 id="EVC-KEY:CAPS" role="macro">
970
<title>EVC_KEY</title>
971
<indexterm zone="EVC-KEY:CAPS"><primary>EVC_KEY</primary></indexterm>
972
<programlisting>#define EVC_KEY "KEY"
976
<refsect2 id="EVC-LABEL:CAPS" role="macro">
977
<title>EVC_LABEL</title>
978
<indexterm zone="EVC-LABEL:CAPS"><primary>EVC_LABEL</primary></indexterm>
979
<programlisting>#define EVC_LABEL "LABEL"
983
<refsect2 id="EVC-LOGO:CAPS" role="macro">
984
<title>EVC_LOGO</title>
985
<indexterm zone="EVC-LOGO:CAPS"><primary>EVC_LOGO</primary></indexterm>
986
<programlisting>#define EVC_LOGO "LOGO"
990
<refsect2 id="EVC-MAILER:CAPS" role="macro">
991
<title>EVC_MAILER</title>
992
<indexterm zone="EVC-MAILER:CAPS"><primary>EVC_MAILER</primary></indexterm>
993
<programlisting>#define EVC_MAILER "MAILER"
997
<refsect2 id="EVC-NICKNAME:CAPS" role="macro">
998
<title>EVC_NICKNAME</title>
999
<indexterm zone="EVC-NICKNAME:CAPS"><primary>EVC_NICKNAME</primary></indexterm>
1000
<programlisting>#define EVC_NICKNAME "NICKNAME"
1005
<refsect2 id="EVC-N:CAPS" role="macro">
1006
<title>EVC_N</title>
1007
<indexterm zone="EVC-N:CAPS"><primary>EVC_N</primary></indexterm>
1008
<programlisting>#define EVC_N "N"
1012
<refsect2 id="EVC-NOTE:CAPS" role="macro">
1013
<title>EVC_NOTE</title>
1014
<indexterm zone="EVC-NOTE:CAPS"><primary>EVC_NOTE</primary></indexterm>
1015
<programlisting>#define EVC_NOTE "NOTE"
1019
<refsect2 id="EVC-ORG:CAPS" role="macro">
1020
<title>EVC_ORG</title>
1021
<indexterm zone="EVC-ORG:CAPS"><primary>EVC_ORG</primary></indexterm>
1022
<programlisting>#define EVC_ORG "ORG"
1027
<refsect2 id="EVC-PHOTO:CAPS" role="macro">
1028
<title>EVC_PHOTO</title>
1029
<indexterm zone="EVC-PHOTO:CAPS"><primary>EVC_PHOTO</primary></indexterm>
1030
<programlisting>#define EVC_PHOTO "PHOTO"
1035
<refsect2 id="EVC-PRODID:CAPS" role="macro">
1036
<title>EVC_PRODID</title>
1037
<indexterm zone="EVC-PRODID:CAPS"><primary>EVC_PRODID</primary></indexterm>
1038
<programlisting>#define EVC_PRODID "PRODID"
1042
<refsect2 id="EVC-QUOTEDPRINTABLE:CAPS" role="macro">
1043
<title>EVC_QUOTEDPRINTABLE</title>
1044
<indexterm zone="EVC-QUOTEDPRINTABLE:CAPS"><primary>EVC_QUOTEDPRINTABLE</primary></indexterm>
1045
<programlisting>#define EVC_QUOTEDPRINTABLE "QUOTED-PRINTABLE"
1049
<refsect2 id="EVC-REV:CAPS" role="macro">
1050
<title>EVC_REV</title>
1051
<indexterm zone="EVC-REV:CAPS"><primary>EVC_REV</primary></indexterm>
1052
<programlisting>#define EVC_REV "REV"
1056
<refsect2 id="EVC-ROLE:CAPS" role="macro">
1057
<title>EVC_ROLE</title>
1058
<indexterm zone="EVC-ROLE:CAPS"><primary>EVC_ROLE</primary></indexterm>
1059
<programlisting>#define EVC_ROLE "ROLE"
1064
<refsect2 id="EVC-TEL:CAPS" role="macro">
1065
<title>EVC_TEL</title>
1066
<indexterm zone="EVC-TEL:CAPS"><primary>EVC_TEL</primary></indexterm>
1067
<programlisting>#define EVC_TEL "TEL"
1072
<refsect2 id="EVC-TITLE:CAPS" role="macro">
1073
<title>EVC_TITLE</title>
1074
<indexterm zone="EVC-TITLE:CAPS"><primary>EVC_TITLE</primary></indexterm>
1075
<programlisting>#define EVC_TITLE "TITLE"
1080
<refsect2 id="EVC-TYPE:CAPS" role="macro">
1081
<title>EVC_TYPE</title>
1082
<indexterm zone="EVC-TYPE:CAPS"><primary>EVC_TYPE</primary></indexterm>
1083
<programlisting>#define EVC_TYPE "TYPE"
1087
<refsect2 id="EVC-UID:CAPS" role="macro">
1088
<title>EVC_UID</title>
1089
<indexterm zone="EVC-UID:CAPS"><primary>EVC_UID</primary></indexterm>
1090
<programlisting>#define EVC_UID "UID"
1095
<refsect2 id="EVC-URL:CAPS" role="macro">
1096
<title>EVC_URL</title>
1097
<indexterm zone="EVC-URL:CAPS"><primary>EVC_URL</primary></indexterm>
1098
<programlisting>#define EVC_URL "URL"
1103
<refsect2 id="EVC-VALUE:CAPS" role="macro">
1104
<title>EVC_VALUE</title>
1105
<indexterm zone="EVC-VALUE:CAPS"><primary>EVC_VALUE</primary></indexterm>
1106
<programlisting>#define EVC_VALUE "VALUE"
1110
<refsect2 id="EVC-VERSION:CAPS" role="macro">
1111
<title>EVC_VERSION</title>
1112
<indexterm zone="EVC-VERSION:CAPS"><primary>EVC_VERSION</primary></indexterm>
1113
<programlisting>#define EVC_VERSION "VERSION"
1117
<refsect2 id="EVC-X-AIM:CAPS" role="macro">
1118
<title>EVC_X_AIM</title>
1119
<indexterm zone="EVC-X-AIM:CAPS"><primary>EVC_X_AIM</primary></indexterm>
1120
<programlisting>#define EVC_X_AIM "X-AIM"
1125
<refsect2 id="EVC-X-ANNIVERSARY:CAPS" role="macro">
1126
<title>EVC_X_ANNIVERSARY</title>
1127
<indexterm zone="EVC-X-ANNIVERSARY:CAPS"><primary>EVC_X_ANNIVERSARY</primary></indexterm>
1128
<programlisting>#define EVC_X_ANNIVERSARY "X-EVOLUTION-ANNIVERSARY"
1133
<refsect2 id="EVC-X-ASSISTANT:CAPS" role="macro">
1134
<title>EVC_X_ASSISTANT</title>
1135
<indexterm zone="EVC-X-ASSISTANT:CAPS"><primary>EVC_X_ASSISTANT</primary></indexterm>
1136
<programlisting>#define EVC_X_ASSISTANT "X-EVOLUTION-ASSISTANT"
1141
<refsect2 id="EVC-X-BIRTHDAY:CAPS" role="macro">
1142
<title>EVC_X_BIRTHDAY</title>
1143
<indexterm zone="EVC-X-BIRTHDAY:CAPS"><primary>EVC_X_BIRTHDAY</primary></indexterm>
1144
<programlisting>#define EVC_X_BIRTHDAY "X-EVOLUTION-BIRTHDAY"
1149
<refsect2 id="EVC-X-BLOG-URL:CAPS" role="macro">
1150
<title>EVC_X_BLOG_URL</title>
1151
<indexterm zone="EVC-X-BLOG-URL:CAPS"><primary>EVC_X_BLOG_URL</primary></indexterm>
1152
<programlisting>#define EVC_X_BLOG_URL "X-EVOLUTION-BLOG-URL"
1157
<refsect2 id="EVC-X-FILE-AS:CAPS" role="macro">
1158
<title>EVC_X_FILE_AS</title>
1159
<indexterm zone="EVC-X-FILE-AS:CAPS"><primary>EVC_X_FILE_AS</primary></indexterm>
1160
<programlisting>#define EVC_X_FILE_AS "X-EVOLUTION-FILE-AS"
1165
<refsect2 id="EVC-X-GADUGADU:CAPS" role="macro">
1166
<title>EVC_X_GADUGADU</title>
1167
<indexterm zone="EVC-X-GADUGADU:CAPS"><primary>EVC_X_GADUGADU</primary></indexterm>
1168
<programlisting>#define EVC_X_GADUGADU "X-GADUGADU"
1172
<refsect2 id="EVC-X-ICQ:CAPS" role="macro">
1173
<title>EVC_X_ICQ</title>
1174
<indexterm zone="EVC-X-ICQ:CAPS"><primary>EVC_X_ICQ</primary></indexterm>
1175
<programlisting>#define EVC_X_ICQ "X-ICQ"
1180
<refsect2 id="EVC-X-JABBER:CAPS" role="macro">
1181
<title>EVC_X_JABBER</title>
1182
<indexterm zone="EVC-X-JABBER:CAPS"><primary>EVC_X_JABBER</primary></indexterm>
1183
<programlisting>#define EVC_X_JABBER "X-JABBER"
1188
<refsect2 id="EVC-X-LIST-SHOW-ADDRESSES:CAPS" role="macro">
1189
<title>EVC_X_LIST_SHOW_ADDRESSES</title>
1190
<indexterm zone="EVC-X-LIST-SHOW-ADDRESSES:CAPS"><primary>EVC_X_LIST_SHOW_ADDRESSES</primary></indexterm>
1191
<programlisting>#define EVC_X_LIST_SHOW_ADDRESSES "X-EVOLUTION-LIST-SHOW_ADDRESSES"
1195
<refsect2 id="EVC-X-LIST:CAPS" role="macro">
1196
<title>EVC_X_LIST</title>
1197
<indexterm zone="EVC-X-LIST:CAPS"><primary>EVC_X_LIST</primary></indexterm>
1198
<programlisting>#define EVC_X_LIST "X-EVOLUTION-LIST"
1202
<refsect2 id="EVC-X-MANAGER:CAPS" role="macro">
1203
<title>EVC_X_MANAGER</title>
1204
<indexterm zone="EVC-X-MANAGER:CAPS"><primary>EVC_X_MANAGER</primary></indexterm>
1205
<programlisting>#define EVC_X_MANAGER "X-EVOLUTION-MANAGER"
1210
<refsect2 id="EVC-X-MSN:CAPS" role="macro">
1211
<title>EVC_X_MSN</title>
1212
<indexterm zone="EVC-X-MSN:CAPS"><primary>EVC_X_MSN</primary></indexterm>
1213
<programlisting>#define EVC_X_MSN "X-MSN"
1218
<refsect2 id="EVC-X-SKYPE:CAPS" role="macro">
1219
<title>EVC_X_SKYPE</title>
1220
<indexterm zone="EVC-X-SKYPE:CAPS"><primary>EVC_X_SKYPE</primary></indexterm>
1221
<programlisting>#define EVC_X_SKYPE "X-SKYPE"
1225
<refsect2 id="EVC-X-WANTS-HTML:CAPS" role="macro">
1226
<title>EVC_X_WANTS_HTML</title>
1227
<indexterm zone="EVC-X-WANTS-HTML:CAPS"><primary>EVC_X_WANTS_HTML</primary></indexterm>
1228
<programlisting>#define EVC_X_WANTS_HTML "X-MOZILLA-HTML"
1233
<refsect2 id="EVC-X-YAHOO:CAPS" role="macro">
1234
<title>EVC_X_YAHOO</title>
1235
<indexterm zone="EVC-X-YAHOO:CAPS"><primary>EVC_X_YAHOO</primary></indexterm>
1236
<programlisting>#define EVC_X_YAHOO "X-YAHOO"
1241
<refsect2 id="EVC-X-BOOK-URI:CAPS" role="macro">
1242
<title>EVC_X_BOOK_URI</title>
1243
<indexterm zone="EVC-X-BOOK-URI:CAPS"><primary>EVC_X_BOOK_URI</primary></indexterm>
1244
<programlisting>#define EVC_X_BOOK_URI "X-EVOLUTION-BOOK-URI"
1248
<refsect2 id="EVC-X-CALLBACK:CAPS" role="macro">
1249
<title>EVC_X_CALLBACK</title>
1250
<indexterm zone="EVC-X-CALLBACK:CAPS"><primary>EVC_X_CALLBACK</primary></indexterm>
1251
<programlisting>#define EVC_X_CALLBACK "X-EVOLUTION-CALLBACK"
1255
<refsect2 id="EVC-X-COMPANY:CAPS" role="macro">
1256
<title>EVC_X_COMPANY</title>
1257
<indexterm zone="EVC-X-COMPANY:CAPS"><primary>EVC_X_COMPANY</primary></indexterm>
1258
<programlisting>#define EVC_X_COMPANY "X-EVOLUTION-COMPANY"
1262
<refsect2 id="EVC-X-DEST-CONTACT-UID:CAPS" role="macro">
1263
<title>EVC_X_DEST_CONTACT_UID</title>
1264
<indexterm zone="EVC-X-DEST-CONTACT-UID:CAPS"><primary>EVC_X_DEST_CONTACT_UID</primary></indexterm>
1265
<programlisting>#define EVC_X_DEST_CONTACT_UID "X-EVOLUTION-DEST-CONTACT-UID"
1269
<refsect2 id="EVC-X-DEST-EMAIL:CAPS" role="macro" condition="deprecated:">
1270
<title>EVC_X_DEST_EMAIL</title>
1271
<indexterm zone="EVC-X-DEST-EMAIL:CAPS" role="deprecated"><primary>EVC_X_DEST_EMAIL</primary></indexterm>
1272
<programlisting>#define EVC_X_DEST_EMAIL "X-EVOLUTION-DEST-EMAIL"
1274
<warning><para><literal>EVC_X_DEST_EMAIL</literal> is deprecated and should not be used in newly-written code.</para></warning>
1277
<refsect2 id="EVC-X-DEST-EMAIL-NUM:CAPS" role="macro">
1278
<title>EVC_X_DEST_EMAIL_NUM</title>
1279
<indexterm zone="EVC-X-DEST-EMAIL-NUM:CAPS"><primary>EVC_X_DEST_EMAIL_NUM</primary></indexterm>
1280
<programlisting>#define EVC_X_DEST_EMAIL_NUM "X-EVOLUTION-DEST-EMAIL-NUM"
1284
<refsect2 id="EVC-X-DEST-HTML-MAIL:CAPS" role="macro">
1285
<title>EVC_X_DEST_HTML_MAIL</title>
1286
<indexterm zone="EVC-X-DEST-HTML-MAIL:CAPS"><primary>EVC_X_DEST_HTML_MAIL</primary></indexterm>
1287
<programlisting>#define EVC_X_DEST_HTML_MAIL "X-EVOLUTION-DEST-HTML-MAIL"
1291
<refsect2 id="EVC-X-DEST-NAME:CAPS" role="macro" condition="deprecated:">
1292
<title>EVC_X_DEST_NAME</title>
1293
<indexterm zone="EVC-X-DEST-NAME:CAPS" role="deprecated"><primary>EVC_X_DEST_NAME</primary></indexterm>
1294
<programlisting>#define EVC_X_DEST_NAME "X-EVOLUTION-DEST-NAME"
1296
<warning><para><literal>EVC_X_DEST_NAME</literal> is deprecated and should not be used in newly-written code.</para></warning>
1299
<refsect2 id="EVC-X-DEST-SOURCE-UID:CAPS" role="macro">
1300
<title>EVC_X_DEST_SOURCE_UID</title>
1301
<indexterm zone="EVC-X-DEST-SOURCE-UID:CAPS"><primary>EVC_X_DEST_SOURCE_UID</primary></indexterm>
1302
<programlisting>#define EVC_X_DEST_SOURCE_UID "X-EVOLUTION-DEST-SOURCE-UID"
1306
<refsect2 id="EVC-X-GROUPWISE:CAPS" role="macro">
1307
<title>EVC_X_GROUPWISE</title>
1308
<indexterm zone="EVC-X-GROUPWISE:CAPS"><primary>EVC_X_GROUPWISE</primary></indexterm>
1309
<programlisting>#define EVC_X_GROUPWISE "X-GROUPWISE"
1313
<refsect2 id="EVC-X-RADIO:CAPS" role="macro">
1314
<title>EVC_X_RADIO</title>
1315
<indexterm zone="EVC-X-RADIO:CAPS"><primary>EVC_X_RADIO</primary></indexterm>
1316
<programlisting>#define EVC_X_RADIO "X-EVOLUTION-RADIO"
1320
<refsect2 id="EVC-X-SIP:CAPS" role="macro">
1321
<title>EVC_X_SIP</title>
1322
<indexterm zone="EVC-X-SIP:CAPS"><primary>EVC_X_SIP</primary></indexterm>
1323
<programlisting>#define EVC_X_SIP "X-SIP"
1327
<refsect2 id="EVC-X-SPOUSE:CAPS" role="macro">
1328
<title>EVC_X_SPOUSE</title>
1329
<indexterm zone="EVC-X-SPOUSE:CAPS"><primary>EVC_X_SPOUSE</primary></indexterm>
1330
<programlisting>#define EVC_X_SPOUSE "X-EVOLUTION-SPOUSE"
1335
<refsect2 id="EVC-X-TELEX:CAPS" role="macro">
1336
<title>EVC_X_TELEX</title>
1337
<indexterm zone="EVC-X-TELEX:CAPS"><primary>EVC_X_TELEX</primary></indexterm>
1338
<programlisting>#define EVC_X_TELEX "X-EVOLUTION-TELEX"
1342
<refsect2 id="EVC-X-TTYTDD:CAPS" role="macro">
1343
<title>EVC_X_TTYTDD</title>
1344
<indexterm zone="EVC-X-TTYTDD:CAPS"><primary>EVC_X_TTYTDD</primary></indexterm>
1345
<programlisting>#define EVC_X_TTYTDD "X-EVOLUTION-TTYTDD"
1349
<refsect2 id="EVC-X-VIDEO-URL:CAPS" role="macro">
1350
<title>EVC_X_VIDEO_URL</title>
1351
<indexterm zone="EVC-X-VIDEO-URL:CAPS"><primary>EVC_X_VIDEO_URL</primary></indexterm>
1352
<programlisting>#define EVC_X_VIDEO_URL "X-EVOLUTION-VIDEO-URL"
1358
<refsect1 id="EVCard.see-also">
1359
<title>See Also</title>
1361
<link linkend="e-contact"><type>e-contact</type></link>
added
removed
docs/reference/addressbook/libebook/xml/e-vcard.xml
