~ubuntu-branches/ubuntu/karmic/exo/karmic

« back to all changes in this revision

Viewing changes to docs/reference/html/exo-Mount-Points.html

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2009-08-21 14:28:56 UTC
  • mfrom: (1.1.22 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821142856-xp7o7hl7x9xa2213
Tags: 0.3.102-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/rules:
    + Removed mangling of helpers.rc
    + Add --enable-gtk-doc switch to configure
  - debian/control:
    + Add build-dep on gtk-doc-tools
    + Update Vcs-* fields
  - debian/patches:
    + 04_update_helpers.patch: patched libexo's firefox helper desktop file
      to use firefox-3.0 icon instead of firefox icon
    + xubuntu-default-mount-options.patch: change default mount options for
      vfat, iso9660, ntfs
    + series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Mount Points</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="exo Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="exo Reference Manual">
8
8
<link rel="up" href="exo-miscelleanous.html" title="Part VI. Miscelleanous">
9
9
<link rel="prev" href="exo-MD5-functions.html" title="MD5 Functions">
10
10
<link rel="next" href="exo-String-Utility-Functions.html" title="String Utility Functions">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="exo-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="exo-toolbars.html" title="Part II. Editable Toolbars">
30
30
<th width="100%" align="center">exo Reference Manual</th>
31
31
<td><a accesskey="n" href="exo-String-Utility-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
32
</tr>
33
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#exo-Mount-Points.synopsis" class="shortcut">Top</a>
34
 
                   | 
35
 
                  <a href="#exo-Mount-Points.description" class="shortcut">Description</a></nobr></td></tr>
 
33
<tr><td colspan="5" class="shortcuts">
 
34
<a href="#exo-Mount-Points.synopsis" class="shortcut">Top</a>
 
35
                 | 
 
36
                <a href="#exo-Mount-Points.description" class="shortcut">Description</a>
 
37
</td></tr>
36
38
</table>
37
39
<div class="refentry" lang="en">
38
40
<a name="exo-Mount-Points"></a><div class="titlepage"></div>
51
53
 
52
54
enum                <a class="link" href="exo-Mount-Points.html#ExoMountPointFlags" title="enum ExoMountPointFlags">ExoMountPointFlags</a>;
53
55
                    <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a>;
54
 
<a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a>*      <a class="link" href="exo-Mount-Points.html#exo-mount-point-dup" title="exo_mount_point_dup ()">exo_mount_point_dup</a>                 (const <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);
 
56
<a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *     <a class="link" href="exo-Mount-Points.html#exo-mount-point-dup" title="exo_mount_point_dup ()">exo_mount_point_dup</a>                 (const <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);
55
57
void                <a class="link" href="exo-Mount-Points.html#exo-mount-point-free" title="exo_mount_point_free ()">exo_mount_point_free</a>                (<a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);
56
58
enum                <a class="link" href="exo-Mount-Points.html#ExoMountPointMatchMask" title="enum ExoMountPointMatchMask">ExoMountPointMatchMask</a>;
57
 
<a
58
 
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
59
 
>GSList</a>*             <a class="link" href="exo-Mount-Points.html#exo-mount-point-list-matched" title="exo_mount_point_list_matched ()">exo_mount_point_list_matched</a>        (<a class="link" href="exo-Mount-Points.html#ExoMountPointMatchMask" title="enum ExoMountPointMatchMask">ExoMountPointMatchMask</a> mask,
60
 
                                                         const <a
61
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
62
 
>gchar</a> *device,
63
 
                                                         const <a
64
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
65
 
>gchar</a> *folder,
66
 
                                                         const <a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
68
 
>gchar</a> *fstype,
69
 
                                                         <a
70
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
71
 
>GError</a> **error);
 
59
GSList *            <a class="link" href="exo-Mount-Points.html#exo-mount-point-list-matched" title="exo_mount_point_list_matched ()">exo_mount_point_list_matched</a>        (<a class="link" href="exo-Mount-Points.html#ExoMountPointMatchMask" title="enum ExoMountPointMatchMask">ExoMountPointMatchMask</a> mask,
 
60
                                                         const gchar *device,
 
61
                                                         const gchar *folder,
 
62
                                                         const gchar *fstype,
 
63
                                                         GError **error);
72
64
#define             <a class="link" href="exo-Mount-Points.html#exo-mount-point-list-active" title="exo_mount_point_list_active()">exo_mount_point_list_active</a>         (error)
73
65
#define             <a class="link" href="exo-Mount-Points.html#exo-mount-point-list-configured" title="exo_mount_point_list_configured()">exo_mount_point_list_configured</a>     (error)
74
66
</pre>
94
86
<p>
95
87
Identifies options of <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint"><span class="type">ExoMountPoint</span></a>s.</p>
96
88
<p>
97
 
 
98
89
</p>
99
90
<div class="variablelist"><table border="0">
100
91
<col align="left" valign="top">
101
92
<tbody></tbody>
102
93
</table></div>
103
 
<p class="since">Since  0.3.1.13
104
 
</p>
 
94
<p class="since">Since 0.3.1.13</p>
105
95
</div>
106
96
<hr>
107
97
<div class="refsect2" lang="en">
129
119
</td>
130
120
</tr>
131
121
<tr>
132
 
<td><p><span class="term"><a
133
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
134
 
>gchar</a> *<em class="structfield"><code>device</code></em>;</span></p></td>
 
122
<td><p><span class="term">gchar *<em class="structfield"><code>device</code></em>;</span></p></td>
135
123
<td>the device file path.
136
124
</td>
137
125
</tr>
138
126
<tr>
139
 
<td><p><span class="term"><a
140
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
141
 
>gchar</a> *<em class="structfield"><code>folder</code></em>;</span></p></td>
 
127
<td><p><span class="term">gchar *<em class="structfield"><code>folder</code></em>;</span></p></td>
142
128
<td>the folder where the device is mounted (or may be mounted).
143
129
</td>
144
130
</tr>
145
131
<tr>
146
 
<td><p><span class="term"><a
147
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
148
 
>gchar</a> *<em class="structfield"><code>fstype</code></em>;</span></p></td>
 
132
<td><p><span class="term">gchar *<em class="structfield"><code>fstype</code></em>;</span></p></td>
149
133
<td>the type of the file system used for the device.
150
 
 
151
134
</td>
152
135
</tr>
153
136
</tbody>
156
139
<hr>
157
140
<div class="refsect2" lang="en">
158
141
<a name="exo-mount-point-dup"></a><h3>exo_mount_point_dup ()</h3>
159
 
<pre class="programlisting"><a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a>*      exo_mount_point_dup                 (const <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);</pre>
 
142
<pre class="programlisting"><a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *     exo_mount_point_dup                 (const <a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);</pre>
160
143
<p>
161
144
Duplicates the specified <em class="parameter"><code>mount_point</code></em> and returns
162
 
the duplicate. If <em class="parameter"><code>mount_point</code></em> is <a
163
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
164
 
><code class="literal">NULL</code></a>, this simply
165
 
returns <a
166
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
167
 
><code class="literal">NULL</code></a>.
 
145
the duplicate. If <em class="parameter"><code>mount_point</code></em> is <code class="literal">NULL</code>, this simply
 
146
returns <code class="literal">NULL</code>.
168
147
</p>
169
148
<p>
170
149
The caller is responsible to free the returned mount
171
150
point using <a class="link" href="exo-Mount-Points.html#exo-mount-point-free" title="exo_mount_point_free ()"><code class="function">exo_mount_point_free()</code></a> when no longer
172
151
needed.</p>
173
152
<p>
174
 
 
175
153
</p>
176
154
<div class="variablelist"><table border="0">
177
155
<col align="left" valign="top">
189
167
</tr>
190
168
</tbody>
191
169
</table></div>
192
 
<p class="since">Since  0.3.1.13
193
 
</p>
 
170
<p class="since">Since 0.3.1.13</p>
194
171
</div>
195
172
<hr>
196
173
<div class="refsect2" lang="en">
198
175
<pre class="programlisting">void                exo_mount_point_free                (<a class="link" href="exo-Mount-Points.html#ExoMountPoint" title="ExoMountPoint">ExoMountPoint</a> *mount_point);</pre>
199
176
<p>
200
177
Frees the resources allocated to the specified <em class="parameter"><code>mount_point</code></em>.
201
 
If <em class="parameter"><code>mount_point</code></em> is <a
202
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
203
 
><code class="literal">NULL</code></a>, this function does nothing.</p>
 
178
If <em class="parameter"><code>mount_point</code></em> is <code class="literal">NULL</code>, this function does nothing.</p>
204
179
<p>
205
 
 
206
180
</p>
207
181
<div class="variablelist"><table border="0">
208
182
<col align="left" valign="top">
212
186
</td>
213
187
</tr></tbody>
214
188
</table></div>
215
 
<p class="since">Since  0.3.1.13
216
 
</p>
 
189
<p class="since">Since 0.3.1.13</p>
217
190
</div>
218
191
<hr>
219
192
<div class="refsect2" lang="en">
232
205
will be returned. The fewer match options are specified, the more mount
233
206
points will usually match (surprising, eh?).</p>
234
207
<p>
235
 
 
236
208
</p>
237
209
<div class="variablelist"><table border="0">
238
210
<col align="left" valign="top">
239
211
<tbody></tbody>
240
212
</table></div>
241
 
<p class="since">Since  0.3.1.13
242
 
</p>
 
213
<p class="since">Since 0.3.1.13</p>
243
214
</div>
244
215
<hr>
245
216
<div class="refsect2" lang="en">
246
217
<a name="exo-mount-point-list-matched"></a><h3>exo_mount_point_list_matched ()</h3>
247
 
<pre class="programlisting"><a
248
 
href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"
249
 
>GSList</a>*             exo_mount_point_list_matched        (<a class="link" href="exo-Mount-Points.html#ExoMountPointMatchMask" title="enum ExoMountPointMatchMask">ExoMountPointMatchMask</a> mask,
250
 
                                                         const <a
251
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
252
 
>gchar</a> *device,
253
 
                                                         const <a
254
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
255
 
>gchar</a> *folder,
256
 
                                                         const <a
257
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
258
 
>gchar</a> *fstype,
259
 
                                                         <a
260
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
261
 
>GError</a> **error);</pre>
 
218
<pre class="programlisting">GSList *            exo_mount_point_list_matched        (<a class="link" href="exo-Mount-Points.html#ExoMountPointMatchMask" title="enum ExoMountPointMatchMask">ExoMountPointMatchMask</a> mask,
 
219
                                                         const gchar *device,
 
220
                                                         const gchar *folder,
 
221
                                                         const gchar *fstype,
 
222
                                                         GError **error);</pre>
262
223
<p>
263
224
Lists mount points matching the given <em class="parameter"><code>mask</code></em> and optionally the parameters <em class="parameter"><code>device</code></em>,
264
 
<em class="parameter"><code>folder</code></em> and <em class="parameter"><code>fstype</code></em>. If an error occurrs and <em class="parameter"><code>error</code></em> is non-<a
265
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
266
 
><code class="literal">NULL</code></a>, the <em class="parameter"><code>error</code></em> will
267
 
be set to point to a <a
268
 
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
269
 
><span class="type">GError</span></a> describing the problem, and <a
270
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
271
 
><code class="literal">NULL</code></a> will be returned.
272
 
Note, however, that <a
273
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
274
 
><code class="literal">NULL</code></a> may also be returned if no mount points match.
 
225
<em class="parameter"><code>folder</code></em> and <em class="parameter"><code>fstype</code></em>. If an error occurrs and <em class="parameter"><code>error</code></em> is non-<code class="literal">NULL</code>, the <em class="parameter"><code>error</code></em> will
 
226
be set to point to a <span class="type">GError</span> describing the problem, and <code class="literal">NULL</code> will be returned.
 
227
Note, however, that <code class="literal">NULL</code> may also be returned if no mount points match.
275
228
</p>
276
229
<p>
277
230
If <em class="parameter"><code>mask</code></em> includes <code class="literal">EXO_MOUNT_POINT_MATCH_ACTIVE</code>, the currently active mount points will
290
243
<p>
291
244
when no longer needed.</p>
292
245
<p>
293
 
 
294
246
</p>
295
247
<div class="variablelist"><table border="0">
296
248
<col align="left" valign="top">
317
269
</tr>
318
270
<tr>
319
271
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
320
 
<td> return location for errors or <a
321
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
322
 
><code class="literal">NULL</code></a>.
 
272
<td> return location for errors or <code class="literal">NULL</code>.
323
273
</td>
324
274
</tr>
325
275
<tr>
330
280
</tr>
331
281
</tbody>
332
282
</table></div>
333
 
<p class="since">Since  0.3.1.13
334
 
</p>
 
283
<p class="since">Since 0.3.1.13</p>
335
284
</div>
336
285
<hr>
337
286
<div class="refsect2" lang="en">
339
288
<pre class="programlisting">#define             exo_mount_point_list_active(error)</pre>
340
289
<p>
341
290
Convenience wrapper for <a class="link" href="exo-Mount-Points.html#exo-mount-point-list-matched" title="exo_mount_point_list_matched ()"><code class="function">exo_mount_point_list_matched()</code></a>, that returns the
342
 
currently active mount points, or <a
343
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
344
 
><code class="literal">NULL</code></a> in case of an error.
 
291
currently active mount points, or <code class="literal">NULL</code> in case of an error.
345
292
</p>
346
293
<p>
347
294
The caller is responsible to free the returned list using
353
300
<p>
354
301
when no longer needed.</p>
355
302
<p>
356
 
 
357
303
</p>
358
304
<div class="variablelist"><table border="0">
359
305
<col align="left" valign="top">
360
306
<tbody><tr>
361
307
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
362
 
<td> return location for errors or <a
363
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
364
 
><code class="literal">NULL</code></a>.
 
308
<td> return location for errors or <code class="literal">NULL</code>.
365
309
</td>
366
310
</tr></tbody>
367
311
</table></div>
368
 
<p class="since">Since  0.3.1.13
369
 
</p>
 
312
<p class="since">Since 0.3.1.13</p>
370
313
</div>
371
314
<hr>
372
315
<div class="refsect2" lang="en">
387
330
<p>
388
331
when no longer needed.</p>
389
332
<p>
390
 
 
391
333
</p>
392
334
<div class="variablelist"><table border="0">
393
335
<col align="left" valign="top">
394
336
<tbody><tr>
395
337
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
396
 
<td> return location for errors or <a
397
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
398
 
><code class="literal">NULL</code></a>.
 
338
<td> return location for errors or <code class="literal">NULL</code>.
399
339
</td>
400
340
</tr></tbody>
401
341
</table></div>
402
 
<p class="since">Since  0.3.1.13
403
 
</p>
 
342
<p class="since">Since 0.3.1.13</p>
404
343
</div>
405
344
</div>
406
345
</div>
407
346
<div class="footer">
408
347
<hr>
409
 
          Generated by GTK-Doc V1.10</div>
 
348
          Generated by GTK-Doc V1.11</div>
410
349
</body>
411
350
</html>