← Back to branch summary

~ubuntu-branches/ubuntu/quantal/evolution-data-server/quantal-proposed

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2012-06-19 18:46:44 UTC
  • mfrom: (1.1.99) (1.2.27 sid)
  • Revision ID: package-import@ubuntu.com-20120619184644-mbuvksykmua1tdjd
Tags: 3.4.3-1
* Team upload.
* New upstream release.
* Change Conflicts for evolution-data-server to versioned Breaks and add
  libebook-1.2-12 (<< 3.4) since the AddressBook D-Bus API had a version
  bump between 3.2 and 3.4. Fix a typo while at it.
* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/libedataserver-e-url.html
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
9
9
<link rel="prev" href="libedataserver-e-util.html" title="e-util">
10
10
<link rel="next" href="libedataserver-e-xml-hash-utils.html" title="e-xml-hash-utils">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="libedataserver-e-url.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-url.html#e-url-shroud" title="e_url_shroud ()">e_url_shroud</a>                        (<em class="parameter"><code>const <span class="type">gchar</span> *url</code></em>);
41
 
<span class="returnvalue">gboolean</span>            <a class="link" href="libedataserver-e-url.html#e-url-equal" title="e_url_equal ()">e_url_equal</a>                         (<em class="parameter"><code>const <span class="type">gchar</span> *url1</code></em>,
42
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *url2</code></em>);
 
40
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libedataserver-e-url.html#e-url-shroud" title="e_url_shroud ()">e_url_shroud</a>                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);
 
41
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libedataserver-e-url.html#e-url-equal" title="e_url_equal ()">e_url_equal</a>                         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url1</code></em>,
 
42
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url2</code></em>);
43
43
struct              <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri">EUri</a>;
44
 
<a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *              <a class="link" href="libedataserver-e-url.html#e-uri-new" title="e_uri_new ()">e_uri_new</a>                           (<em class="parameter"><code>const <span class="type">gchar</span> *uri_string</code></em>);
 
44
<a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *              <a class="link" href="libedataserver-e-url.html#e-uri-new" title="e_uri_new ()">e_uri_new</a>                           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_string</code></em>);
45
45
<span class="returnvalue">void</span>                <a class="link" href="libedataserver-e-url.html#e-uri-free" title="e_uri_free ()">e_uri_free</a>                          (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>);
46
 
const <span class="returnvalue">gchar</span> *       <a class="link" href="libedataserver-e-url.html#e-uri-get-param" title="e_uri_get_param ()">e_uri_get_param</a>                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
47
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
 
46
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libedataserver-e-url.html#e-uri-get-param" title="e_uri_get_param ()">e_uri_get_param</a>                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
 
47
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
48
48
<a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *              <a class="link" href="libedataserver-e-url.html#e-uri-copy" title="e_uri_copy ()">e_uri_copy</a>                          (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>);
49
 
<span class="returnvalue">gchar</span> *             <a class="link" href="libedataserver-e-url.html#e-uri-to-string" title="e_uri_to_string ()">e_uri_to_string</a>                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
50
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> show_password</code></em>);
 
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libedataserver-e-url.html#e-uri-to-string" title="e_uri_to_string ()">e_uri_to_string</a>                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
 
50
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_password</code></em>);
51
51
</pre>
52
52
</div>
53
53
<div class="refsect1">
57
57
<a name="libedataserver-e-url.details"></a><h2>Details</h2>
58
58
<div class="refsect2">
59
59
<a name="e-url-shroud"></a><h3>e_url_shroud ()</h3>
60
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_url_shroud                        (<em class="parameter"><code>const <span class="type">gchar</span> *url</code></em>);</pre>
 
60
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             e_url_shroud                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre>
61
61
<p>
62
62
Removes the moniker (i.e. mailto:) from a url.
63
63
</p>
78
78
<hr>
79
79
<div class="refsect2">
80
80
<a name="e-url-equal"></a><h3>e_url_equal ()</h3>
81
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_url_equal                         (<em class="parameter"><code>const <span class="type">gchar</span> *url1</code></em>,
82
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *url2</code></em>);</pre>
 
81
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            e_url_equal                         (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url1</code></em>,
 
82
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url2</code></em>);</pre>
83
83
<p>
84
84
Checks two urls for equality, after first removing any monikers on
85
85
the urls.
98
98
<tr>
99
99
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
100
100
<td>
101
 
<code class="literal">TRUE</code> if the urls are equal, <code class="literal">FALSE</code> if they are not.</td>
 
101
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the urls are equal, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if they are not.</td>
102
102
</tr>
103
103
</tbody>
104
104
</table></div>
126
126
<col align="left" valign="top">
127
127
<tbody>
128
128
<tr>
129
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.protocol"></a>protocol</code></em>;</span></p></td>
 
129
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.protocol"></a>protocol</code></em>;</span></p></td>
130
130
<td>The protocol to use.</td>
131
131
</tr>
132
132
<tr>
133
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.user"></a>user</code></em>;</span></p></td>
 
133
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.user"></a>user</code></em>;</span></p></td>
134
134
<td>A user name.</td>
135
135
</tr>
136
136
<tr>
137
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.authmech"></a>authmech</code></em>;</span></p></td>
 
137
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.authmech"></a>authmech</code></em>;</span></p></td>
138
138
<td>The authentication mechanism.</td>
139
139
</tr>
140
140
<tr>
141
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.passwd"></a>passwd</code></em>;</span></p></td>
 
141
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.passwd"></a>passwd</code></em>;</span></p></td>
142
142
<td>The connection password.</td>
143
143
</tr>
144
144
<tr>
145
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.host"></a>host</code></em>;</span></p></td>
 
145
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.host"></a>host</code></em>;</span></p></td>
146
146
<td>The host name.</td>
147
147
</tr>
148
148
<tr>
149
 
<td><p><span class="term"><span class="type">gint</span> <em class="structfield"><code><a name="EUri.port"></a>port</code></em>;</span></p></td>
 
149
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="EUri.port"></a>port</code></em>;</span></p></td>
150
150
<td>The port number.</td>
151
151
</tr>
152
152
<tr>
153
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.path"></a>path</code></em>;</span></p></td>
 
153
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.path"></a>path</code></em>;</span></p></td>
154
154
<td>The file path on the host.</td>
155
155
</tr>
156
156
<tr>
157
 
<td><p><span class="term"><span class="type">GData</span> *<em class="structfield"><code><a name="EUri.params"></a>params</code></em>;</span></p></td>
 
157
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Keyed-Data-Lists.html#GData"><span class="type">GData</span></a> *<em class="structfield"><code><a name="EUri.params"></a>params</code></em>;</span></p></td>
158
158
<td>Additional parameters.</td>
159
159
</tr>
160
160
<tr>
161
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.query"></a>query</code></em>;</span></p></td>
 
161
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.query"></a>query</code></em>;</span></p></td>
162
162
<td>The URI query.</td>
163
163
</tr>
164
164
<tr>
165
 
<td><p><span class="term"><span class="type">gchar</span> *<em class="structfield"><code><a name="EUri.fragment"></a>fragment</code></em>;</span></p></td>
 
165
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EUri.fragment"></a>fragment</code></em>;</span></p></td>
166
166
<td>The URI fragment.</td>
167
167
</tr>
168
168
</tbody>
171
171
<hr>
172
172
<div class="refsect2">
173
173
<a name="e-uri-new"></a><h3>e_uri_new ()</h3>
174
 
<pre class="programlisting"><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *              e_uri_new                           (<em class="parameter"><code>const <span class="type">gchar</span> *uri_string</code></em>);</pre>
 
174
<pre class="programlisting"><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> *              e_uri_new                           (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_string</code></em>);</pre>
175
175
<p>
176
176
Creates an <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> representation of the uri given in <em class="parameter"><code>uri_string</code></em>.
177
177
</p>
207
207
<hr>
208
208
<div class="refsect2">
209
209
<a name="e-uri-get-param"></a><h3>e_uri_get_param ()</h3>
210
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_uri_get_param                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
211
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
 
210
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       e_uri_get_param                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
 
211
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
212
212
<p>
213
213
Retrieves the value of the parameter associated with <em class="parameter"><code>name</code></em> in <em class="parameter"><code>uri</code></em>.
214
214
</p>
254
254
<hr>
255
255
<div class="refsect2">
256
256
<a name="e-uri-to-string"></a><h3>e_uri_to_string ()</h3>
257
 
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_uri_to_string                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
258
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> show_password</code></em>);</pre>
 
257
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             e_uri_to_string                     (<em class="parameter"><code><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> *uri</code></em>,
 
258
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_password</code></em>);</pre>
259
259
<p>
260
260
Creates a string representation of <em class="parameter"><code>uri</code></em>. The password will only be
261
 
included in the string if <em class="parameter"><code>show_password</code></em> is set to <code class="literal">TRUE</code>.
 
261
included in the string if <em class="parameter"><code>show_password</code></em> is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
262
262
</p>
263
263
<div class="variablelist"><table border="0">
264
264
<col align="left" valign="top">
282
282
</div>
283
283
<div class="footer">
284
284
<hr>
285
 
          Generated by GTK-Doc V1.18.1</div>
 
285
          Generated by GTK-Doc V1.18</div>
286
286
</body>
287
287
</html>
 
 
b'\\ No newline at end of file'