← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-url.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/xml/e-url.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="libedataserver-e-url.top_of_page">EUrl</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATASERVER Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EUrl</refname>
13
14
<refpurpose>A URI data structure and associated functions.</refpurpose>
16
17
<refsynopsisdiv id="libedataserver-e-url.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
<link linkend="gchar">gchar</link> *             <link linkend="e-url-shroud">e_url_shroud</link>                        (const <link linkend="gchar">gchar</link> *url);
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-url-equal">e_url_equal</link>                         (const <link linkend="gchar">gchar</link> *url1,
22
 
                                                         const <link linkend="gchar">gchar</link> *url2);
 
20
<synopsis><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-url-shroud">e_url_shroud</link>                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url</parameter>);
 
21
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-url-equal">e_url_equal</link>                         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url1</parameter>,
 
22
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *url2</parameter>);
23
23
                    <link linkend="EUri">EUri</link>;
24
 
<link linkend="EUri">EUri</link> *              <link linkend="e-uri-new">e_uri_new</link>                           (const <link linkend="gchar">gchar</link> *uri_string);
25
 
<link linkend="void">void</link>                <link linkend="e-uri-free">e_uri_free</link>                          (<link linkend="EUri">EUri</link> *uri);
26
 
const <link linkend="gchar">gchar</link> *       <link linkend="e-uri-get-param">e_uri_get_param</link>                     (<link linkend="EUri">EUri</link> *uri,
27
 
                                                         const <link linkend="gchar">gchar</link> *name);
28
 
<link linkend="EUri">EUri</link> *              <link linkend="e-uri-copy">e_uri_copy</link>                          (<link linkend="EUri">EUri</link> *uri);
29
 
<link linkend="gchar">gchar</link> *             <link linkend="e-uri-to-string">e_uri_to_string</link>                     (<link linkend="EUri">EUri</link> *uri,
30
 
                                                         <link linkend="gboolean">gboolean</link> show_password);
 
24
<link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              <link linkend="e-uri-new">e_uri_new</link>                           (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri_string</parameter>);
 
25
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-uri-free">e_uri_free</link>                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);
 
26
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       <link linkend="e-uri-get-param">e_uri_get_param</link>                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
 
27
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);
 
28
<link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              <link linkend="e-uri-copy">e_uri_copy</link>                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);
 
29
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="e-uri-to-string">e_uri_to_string</link>                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
 
30
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show_password</parameter>);
31
31
</synopsis>
32
32
</refsynopsisdiv>
33
33
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
34
<refsect1 id="libedataserver-e-url.description" role="desc">
43
35
<title role="desc.title">Description</title>
44
36
<para>
45
37
</para>
46
38
</refsect1>
47
 
 
48
39
<refsect1 id="libedataserver-e-url.details" role="details">
49
40
<title role="details.title">Details</title>
50
41
<refsect2 id="e-url-shroud" role="function">
51
42
<title>e_url_shroud ()</title>
52
 
<indexterm zone="e-url-shroud"><primary sortas="e_url_shroud">e_url_shroud</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_url_shroud                        (const <link linkend="gchar">gchar</link> *url);</programlisting>
 
43
<indexterm zone="e-url-shroud"><primary>e_url_shroud</primary></indexterm>
 
44
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_url_shroud                        (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url</parameter>);</programlisting>
53
45
<para>
54
46
Removes the moniker (i.e. mailto:) from a url.</para>
55
 
<para>
56
 
</para><variablelist role="params">
 
47
<variablelist role="params">
57
48
<varlistentry><term><parameter>url</parameter>&#160;:</term>
58
 
<listitem><simpara> The url to shroud.
 
49
<listitem><simpara>The url to shroud.
59
50
</simpara></listitem></varlistentry>
60
51
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated shrouded url.
61
52
</simpara></listitem></varlistentry>
62
53
</variablelist></refsect2>
63
54
<refsect2 id="e-url-equal" role="function">
64
55
<title>e_url_equal ()</title>
65
 
<indexterm zone="e-url-equal"><primary sortas="e_url_equal">e_url_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_url_equal                         (const <link linkend="gchar">gchar</link> *url1,
66
 
                                                         const <link linkend="gchar">gchar</link> *url2);</programlisting>
 
56
<indexterm zone="e-url-equal"><primary>e_url_equal</primary></indexterm>
 
57
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_url_equal                         (<parameter>const <link linkend="gchar"><type>gchar</type></link> *url1</parameter>,
 
58
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *url2</parameter>);</programlisting>
67
59
<para>
68
60
Checks two urls for equality, after first removing any monikers on
69
61
the urls.</para>
70
 
<para>
71
 
</para><variablelist role="params">
 
62
<variablelist role="params">
72
63
<varlistentry><term><parameter>url1</parameter>&#160;:</term>
73
 
<listitem><simpara> The first url to compare.
 
64
<listitem><simpara>The first url to compare.
74
65
</simpara></listitem></varlistentry>
75
66
<varlistentry><term><parameter>url2</parameter>&#160;:</term>
76
 
<listitem><simpara> The second url to compare.
 
67
<listitem><simpara>The second url to compare.
77
68
</simpara></listitem></varlistentry>
78
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the urls are equal, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if they are not.
 
69
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the urls are equal, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if they are not.
79
70
</simpara></listitem></varlistentry>
80
71
</variablelist></refsect2>
81
72
<refsect2 id="EUri" role="struct">
82
73
<title>EUri</title>
83
 
<indexterm zone="EUri"><primary sortas="EUri">EUri</primary></indexterm><programlisting>typedef struct {
 
74
<indexterm zone="EUri"><primary>EUri</primary></indexterm>
 
75
<programlisting>typedef struct {
84
76
        gchar  *protocol;
85
77
        gchar  *user;
86
78
        gchar  *authmech;
95
87
</programlisting>
96
88
<para>
97
89
A structure representing a URI.</para>
98
 
<para>
99
 
</para><variablelist role="struct">
100
 
<varlistentry>
101
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>protocol</structfield>;</term>
102
 
<listitem><simpara> The protocol to use.
103
 
</simpara></listitem>
104
 
</varlistentry>
105
 
<varlistentry>
106
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>user</structfield>;</term>
107
 
<listitem><simpara> A user name.
108
 
</simpara></listitem>
109
 
</varlistentry>
110
 
<varlistentry>
111
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>authmech</structfield>;</term>
112
 
<listitem><simpara> The authentication mechanism.
113
 
</simpara></listitem>
114
 
</varlistentry>
115
 
<varlistentry>
116
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>passwd</structfield>;</term>
117
 
<listitem><simpara> The connection password.
118
 
</simpara></listitem>
119
 
</varlistentry>
120
 
<varlistentry>
121
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>host</structfield>;</term>
122
 
<listitem><simpara> The host name.
123
 
</simpara></listitem>
124
 
</varlistentry>
125
 
<varlistentry>
126
 
<term><link linkend="gint">gint</link>&#160;<structfield>port</structfield>;</term>
127
 
<listitem><simpara> The port number.
128
 
</simpara></listitem>
129
 
</varlistentry>
130
 
<varlistentry>
131
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>path</structfield>;</term>
132
 
<listitem><simpara> The file path on the host.
133
 
</simpara></listitem>
134
 
</varlistentry>
135
 
<varlistentry>
136
 
<term><link linkend="GData">GData</link>&#160;*<structfield>params</structfield>;</term>
137
 
<listitem><simpara> Additional parameters.
138
 
</simpara></listitem>
139
 
</varlistentry>
140
 
<varlistentry>
141
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>query</structfield>;</term>
142
 
<listitem><simpara>
143
 
</simpara></listitem>
144
 
</varlistentry>
145
 
<varlistentry>
146
 
<term><link linkend="gchar">gchar</link>&#160;*<structfield>fragment</structfield>;</term>
147
 
<listitem><simpara>
148
 
</simpara></listitem>
 
90
<variablelist role="struct">
 
91
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.protocol">protocol</structfield>;</term>
 
92
<listitem><simpara>The protocol to use.
 
93
</simpara></listitem>
 
94
</varlistentry>
 
95
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.user">user</structfield>;</term>
 
96
<listitem><simpara>A user name.
 
97
</simpara></listitem>
 
98
</varlistentry>
 
99
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.authmech">authmech</structfield>;</term>
 
100
<listitem><simpara>The authentication mechanism.
 
101
</simpara></listitem>
 
102
</varlistentry>
 
103
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.passwd">passwd</structfield>;</term>
 
104
<listitem><simpara>The connection password.
 
105
</simpara></listitem>
 
106
</varlistentry>
 
107
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.host">host</structfield>;</term>
 
108
<listitem><simpara>The host name.
 
109
</simpara></listitem>
 
110
</varlistentry>
 
111
<varlistentry><term><link linkend="gint"><type>gint</type></link>&#160;<structfield id="EUri.port">port</structfield>;</term>
 
112
<listitem><simpara>The port number.
 
113
</simpara></listitem>
 
114
</varlistentry>
 
115
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.path">path</structfield>;</term>
 
116
<listitem><simpara>The file path on the host.
 
117
</simpara></listitem>
 
118
</varlistentry>
 
119
<varlistentry><term><link linkend="GData"><type>GData</type></link>&#160;*<structfield id="EUri.params">params</structfield>;</term>
 
120
<listitem><simpara>Additional parameters.
 
121
</simpara></listitem>
 
122
</varlistentry>
 
123
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.query">query</structfield>;</term>
 
124
<listitem><simpara></simpara></listitem>
 
125
</varlistentry>
 
126
<varlistentry><term><link linkend="gchar"><type>gchar</type></link>&#160;*<structfield id="EUri.fragment">fragment</structfield>;</term>
 
127
<listitem><simpara></simpara></listitem>
149
128
</varlistentry>
150
129
</variablelist></refsect2>
151
130
<refsect2 id="e-uri-new" role="function">
152
131
<title>e_uri_new ()</title>
153
 
<indexterm zone="e-uri-new"><primary sortas="e_uri_new">e_uri_new</primary></indexterm><programlisting><link linkend="EUri">EUri</link> *              e_uri_new                           (const <link linkend="gchar">gchar</link> *uri_string);</programlisting>
 
132
<indexterm zone="e-uri-new"><primary>e_uri_new</primary></indexterm>
 
133
<programlisting><link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              e_uri_new                           (<parameter>const <link linkend="gchar"><type>gchar</type></link> *uri_string</parameter>);</programlisting>
154
134
<para>
155
135
Creates an <link linkend="EUri"><type>EUri</type></link> representation of the uri given in <parameter>uri_string</parameter>.</para>
156
 
<para>
157
 
</para><variablelist role="params">
 
136
<variablelist role="params">
158
137
<varlistentry><term><parameter>uri_string</parameter>&#160;:</term>
159
 
<listitem><simpara> The uri to represent as an <link linkend="EUri"><type>EUri</type></link>.
 
138
<listitem><simpara>The uri to represent as an <link linkend="EUri"><type>EUri</type></link>.
160
139
</simpara></listitem></varlistentry>
161
140
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated <link linkend="EUri"><type>EUri</type></link> structure.
162
141
</simpara></listitem></varlistentry>
163
142
</variablelist></refsect2>
164
143
<refsect2 id="e-uri-free" role="function">
165
144
<title>e_uri_free ()</title>
166
 
<indexterm zone="e-uri-free"><primary sortas="e_uri_free">e_uri_free</primary></indexterm><programlisting><link linkend="void">void</link>                e_uri_free                          (<link linkend="EUri">EUri</link> *uri);</programlisting>
 
145
<indexterm zone="e-uri-free"><primary>e_uri_free</primary></indexterm>
 
146
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_uri_free                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);</programlisting>
167
147
<para>
168
148
Frees the memory of an <link linkend="EUri"><type>EUri</type></link> structure.</para>
169
 
<para>
170
 
</para><variablelist role="params">
 
149
<variablelist role="params">
171
150
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
172
 
<listitem><simpara> A pointer to the <link linkend="EUri"><type>EUri</type></link> to free.
 
151
<listitem><simpara>A pointer to the <link linkend="EUri"><type>EUri</type></link> to free.
173
152
</simpara></listitem></varlistentry>
174
153
</variablelist></refsect2>
175
154
<refsect2 id="e-uri-get-param" role="function">
176
155
<title>e_uri_get_param ()</title>
177
 
<indexterm zone="e-uri-get-param"><primary sortas="e_uri_get_param">e_uri_get_param</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       e_uri_get_param                     (<link linkend="EUri">EUri</link> *uri,
178
 
                                                         const <link linkend="gchar">gchar</link> *name);</programlisting>
 
156
<indexterm zone="e-uri-get-param"><primary>e_uri_get_param</primary></indexterm>
 
157
<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *       e_uri_get_param                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
 
158
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
179
159
<para>
180
160
Retrieves the value of the parameter associated with <parameter>name</parameter> in <parameter>uri</parameter>.</para>
181
 
<para>
182
 
</para><variablelist role="params">
 
161
<variablelist role="params">
183
162
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
184
 
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to get the parameter from.
 
163
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to get the parameter from.
185
164
</simpara></listitem></varlistentry>
186
165
<varlistentry><term><parameter>name</parameter>&#160;:</term>
187
 
<listitem><simpara> The name of the parameter to get.
 
166
<listitem><simpara>The name of the parameter to get.
188
167
</simpara></listitem></varlistentry>
189
168
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The value of the parameter.
190
169
</simpara></listitem></varlistentry>
191
170
</variablelist></refsect2>
192
171
<refsect2 id="e-uri-copy" role="function">
193
172
<title>e_uri_copy ()</title>
194
 
<indexterm zone="e-uri-copy"><primary sortas="e_uri_copy">e_uri_copy</primary></indexterm><programlisting><link linkend="EUri">EUri</link> *              e_uri_copy                          (<link linkend="EUri">EUri</link> *uri);</programlisting>
 
173
<indexterm zone="e-uri-copy"><primary>e_uri_copy</primary></indexterm>
 
174
<programlisting><link linkend="EUri"><returnvalue>EUri</returnvalue></link> *              e_uri_copy                          (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>);</programlisting>
195
175
<para>
196
176
Makes a copy of <parameter>uri</parameter>.</para>
197
 
<para>
198
 
</para><variablelist role="params">
 
177
<variablelist role="params">
199
178
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
200
 
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to copy.
 
179
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to copy.
201
180
</simpara></listitem></varlistentry>
202
181
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The newly-allocated copy of <parameter>uri</parameter>.
203
182
</simpara></listitem></varlistentry>
204
183
</variablelist></refsect2>
205
184
<refsect2 id="e-uri-to-string" role="function">
206
185
<title>e_uri_to_string ()</title>
207
 
<indexterm zone="e-uri-to-string"><primary sortas="e_uri_to_string">e_uri_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             e_uri_to_string                     (<link linkend="EUri">EUri</link> *uri,
208
 
                                                         <link linkend="gboolean">gboolean</link> show_password);</programlisting>
 
186
<indexterm zone="e-uri-to-string"><primary>e_uri_to_string</primary></indexterm>
 
187
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             e_uri_to_string                     (<parameter><link linkend="EUri"><type>EUri</type></link> *uri</parameter>,
 
188
                                                         <parameter><link linkend="gboolean"><type>gboolean</type></link> show_password</parameter>);</programlisting>
209
189
<para>
210
190
Creates a string representation of <parameter>uri</parameter>. The password will only be
211
 
included in the string if <parameter>show_password</parameter> is set to <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.</para>
212
 
<para>
213
 
</para><variablelist role="params">
 
191
included in the string if <parameter>show_password</parameter> is set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
 
192
<variablelist role="params">
214
193
<varlistentry><term><parameter>uri</parameter>&#160;:</term>
215
 
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to convert to a string.
 
194
<listitem><simpara>The <link linkend="EUri"><type>EUri</type></link> to convert to a string.
216
195
</simpara></listitem></varlistentry>
217
196
<varlistentry><term><parameter>show_password</parameter>&#160;:</term>
218
 
<listitem><simpara> Whether or not to show the password in the string.
 
197
<listitem><simpara>Whether or not to show the password in the string.
219
198
</simpara></listitem></varlistentry>
220
199
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The string representation of <parameter>uri</parameter>.
221
200
</simpara></listitem></varlistentry>
223
202
 
224
203
</refsect1>
225
204
 
226
 
 
227
 
 
228
 
 
229
205
</refentry>