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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-e-url">
<refmeta>
<refentrytitle role="top_of_page">EUrl</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EUrl</refname>
<refpurpose>A URI data structure and associated functions.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="char">char</link>* <link linkend="e-url-shroud">e_url_shroud</link> (const <link linkend="char">char</link> *url);
<link linkend="gboolean">gboolean</link> <link linkend="e-url-equal">e_url_equal</link> (const <link linkend="char">char</link> *url1,
const <link linkend="char">char</link> *url2);
<link linkend="EUri">EUri</link>;
<link linkend="EUri">EUri</link>* <link linkend="e-uri-new">e_uri_new</link> (const <link linkend="char">char</link> *uri_string);
<link linkend="void">void</link> <link linkend="e-uri-free">e_uri_free</link> (<link linkend="EUri">EUri</link> *uri);
const <link linkend="char">char</link>* <link linkend="e-uri-get-param">e_uri_get_param</link> (<link linkend="EUri">EUri</link> *uri,
const <link linkend="char">char</link> *name);
<link linkend="EUri">EUri</link>* <link linkend="e-uri-copy">e_uri_copy</link> (<link linkend="EUri">EUri</link> *uri);
<link linkend="char">char</link>* <link linkend="e-uri-to-string">e_uri_to_string</link> (<link linkend="EUri">EUri</link> *uri,
<link linkend="gboolean">gboolean</link> show_password);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="e-url-shroud" role="function"/>e_url_shroud ()</title>
<indexterm><primary>e_url_shroud</primary></indexterm><programlisting><link linkend="char">char</link>* e_url_shroud (const <link linkend="char">char</link> *url);</programlisting>
<para>
Removes the moniker (i.e. mailto:) from a url.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter> :</term>
<listitem><simpara> The url to shroud.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly-allocated shrouded url.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-url-equal" role="function"/>e_url_equal ()</title>
<indexterm><primary>e_url_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_url_equal (const <link linkend="char">char</link> *url1,
const <link linkend="char">char</link> *url2);</programlisting>
<para>
Checks two urls for equality, after first removing any monikers on
the urls.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>url1</parameter> :</term>
<listitem><simpara> The first url to compare.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url2</parameter> :</term>
<listitem><simpara> The second url to compare.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</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.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="EUri" role="struct"/>EUri</title>
<indexterm><primary>EUri</primary></indexterm><programlisting>typedef struct {
char *protocol;
char *user;
char *authmech;
char *passwd;
char *host;
int port;
char *path;
GData *params;
char *query;
char *fragment;
} EUri;
</programlisting>
<para>
A structure representing a URI.</para>
<para>
</para><variablelist role="struct">
<varlistentry>
<term><link linkend="char">char</link> *<structfield>protocol</structfield>;</term>
<listitem><simpara> The protocol to use.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>user</structfield>;</term>
<listitem><simpara> A user name.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>authmech</structfield>;</term>
<listitem><simpara> The authentication mechanism.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>passwd</structfield>;</term>
<listitem><simpara> The connection password.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>host</structfield>;</term>
<listitem><simpara> The host name.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="int">int</link> <structfield>port</structfield>;</term>
<listitem><simpara> The port number.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>path</structfield>;</term>
<listitem><simpara> The file path on the host.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="GData">GData</link> *<structfield>params</structfield>;</term>
<listitem><simpara> Additional parameters.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>query</structfield>;</term>
<listitem><simpara>
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><link linkend="char">char</link> *<structfield>fragment</structfield>;</term>
<listitem><simpara>
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-uri-new" role="function"/>e_uri_new ()</title>
<indexterm><primary>e_uri_new</primary></indexterm><programlisting><link linkend="EUri">EUri</link>* e_uri_new (const <link linkend="char">char</link> *uri_string);</programlisting>
<para>
Creates an <link linkend="EUri"><type>EUri</type></link> representation of the uri given in <parameter>uri_string</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri_string</parameter> :</term>
<listitem><simpara> The uri to represent as an <link linkend="EUri"><type>EUri</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly-allocated <link linkend="EUri"><type>EUri</type></link> structure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-uri-free" role="function"/>e_uri_free ()</title>
<indexterm><primary>e_uri_free</primary></indexterm><programlisting><link linkend="void">void</link> e_uri_free (<link linkend="EUri">EUri</link> *uri);</programlisting>
<para>
Frees the memory of an <link linkend="EUri"><type>EUri</type></link> structure.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> A pointer to the <link linkend="EUri"><type>EUri</type></link> to free.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-uri-get-param" role="function"/>e_uri_get_param ()</title>
<indexterm><primary>e_uri_get_param</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_uri_get_param (<link linkend="EUri">EUri</link> *uri,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Retrieves the value of the parameter associated with <parameter>name</parameter> in <parameter>uri</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to get the parameter from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The name of the parameter to get.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the parameter.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-uri-copy" role="function"/>e_uri_copy ()</title>
<indexterm><primary>e_uri_copy</primary></indexterm><programlisting><link linkend="EUri">EUri</link>* e_uri_copy (<link linkend="EUri">EUri</link> *uri);</programlisting>
<para>
Makes a copy of <parameter>uri</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to copy.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly-allocated copy of <parameter>uri</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-uri-to-string" role="function"/>e_uri_to_string ()</title>
<indexterm><primary>e_uri_to_string</primary></indexterm><programlisting><link linkend="char">char</link>* e_uri_to_string (<link linkend="EUri">EUri</link> *uri,
<link linkend="gboolean">gboolean</link> show_password);</programlisting>
<para>
Creates a string representation of <parameter>uri</parameter>. The password will only be
included in the string if <parameter>show_password</parameter> is set to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> The <link linkend="EUri"><type>EUri</type></link> to convert to a string.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>show_password</parameter> :</term>
<listitem><simpara> Whether or not to show the password in the string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The string representation of <parameter>uri</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
