/usr/share/gtk-doc/html/libedataserver/libedataserver-e-url.html is in libedataserver1.2-dev 3.2.3-0ubuntu7.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-url</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
<link rel="prev" href="libedataserver-e-util.html" title="e-util">
<link rel="next" href="libedataserver-e-xml-hash-utils.html" title="e-xml-hash-utils">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libedataserver-e-util.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Utilities (libedataserver)</th>
<td><a accesskey="n" href="libedataserver-e-xml-hash-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libedataserver-e-url.synopsis" class="shortcut">Top</a>
|
<a href="#libedataserver-e-url.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libedataserver-e-url"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libedataserver-e-url.top_of_page"></a>e-url</span></h2>
<p>e-url</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libedataserver-e-url.synopsis"></a><h2>Synopsis</h2>
<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>);
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *url2</code></em>);
struct <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri">EUri</a>;
<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>);
<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>);
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>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<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>);
<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>,
<em class="parameter"><code><span class="type">gboolean</span> show_password</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libedataserver-e-url.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libedataserver-e-url.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="e-url-shroud"></a><h3>e_url_shroud ()</h3>
<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>
<p>
Removes the moniker (i.e. mailto:) from a url.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>The url to shroud.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly-allocated shrouded url.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-url-equal"></a><h3>e_url_equal ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> e_url_equal (<em class="parameter"><code>const <span class="type">gchar</span> *url1</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *url2</code></em>);</pre>
<p>
Checks two urls for equality, after first removing any monikers on
the urls.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>url1</code></em> :</span></p></td>
<td>The first url to compare.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url2</code></em> :</span></p></td>
<td>The second url to compare.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the urls are equal, <code class="literal">FALSE</code> if they are not.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EUri"></a><h3>struct EUri</h3>
<pre class="programlisting">struct EUri {
gchar *protocol;
gchar *user;
gchar *authmech;
gchar *passwd;
gchar *host;
gint port;
gchar *path;
GData *params;
gchar *query;
gchar *fragment;
};
</pre>
<p>
A structure representing a URI.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<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>
<td>The protocol to use.</td>
</tr>
<tr>
<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>
<td>A user name.</td>
</tr>
<tr>
<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>
<td>The authentication mechanism.</td>
</tr>
<tr>
<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>
<td>The connection password.</td>
</tr>
<tr>
<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>
<td>The host name.</td>
</tr>
<tr>
<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>
<td>The port number.</td>
</tr>
<tr>
<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>
<td>The file path on the host.</td>
</tr>
<tr>
<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>
<td>Additional parameters.</td>
</tr>
<tr>
<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>
<td>The URI query.</td>
</tr>
<tr>
<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>
<td>The URI fragment.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-new"></a><h3>e_uri_new ()</h3>
<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>
<p>
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>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri_string</code></em> :</span></p></td>
<td>The uri to represent as an <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly-allocated <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> structure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-free"></a><h3>e_uri_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_uri_free (<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>);</pre>
<p>
Frees the memory of an <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> structure.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>A pointer to the <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to free.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-get-param"></a><h3>e_uri_get_param ()</h3>
<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>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Retrieves the value of the parameter associated with <em class="parameter"><code>name</code></em> in <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>The <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to get the parameter from.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the parameter to get.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The value of the parameter.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-copy"></a><h3>e_uri_copy ()</h3>
<pre class="programlisting"><a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="returnvalue">EUri</span></a> * e_uri_copy (<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>);</pre>
<p>
Makes a copy of <em class="parameter"><code>uri</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>The <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to copy.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The newly-allocated copy of <em class="parameter"><code>uri</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-uri-to-string"></a><h3>e_uri_to_string ()</h3>
<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>,
<em class="parameter"><code><span class="type">gboolean</span> show_password</code></em>);</pre>
<p>
Creates a string representation of <em class="parameter"><code>uri</code></em>. The password will only be
included in the string if <em class="parameter"><code>show_password</code></em> is set to <code class="literal">TRUE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>The <a class="link" href="libedataserver-e-url.html#EUri" title="struct EUri"><span class="type">EUri</span></a> to convert to a string.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>show_password</code></em> :</span></p></td>
<td>Whether or not to show the password in the string.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string representation of <em class="parameter"><code>uri</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|