~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

« back to all changes in this revision

Viewing changes to doc/html/gnome-vfs-2.0-gnome-vfs-drive.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-03-17 16:12:58 UTC
  • mfrom: (0.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20090317161258-px3a2czt9g2ktjz3
Tags: 1:2.24.1-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GnomeVFSDrive</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
7
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
 
8
<link rel="up" href="volumes.html" title="Volumes and Drives Handling">
 
9
<link rel="prev" href="gnome-vfs-2.0-gnome-vfs-volume.html" title="GnomeVFSVolume">
 
10
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html" title="GnomeVFSVolumeMonitor">
 
11
<meta name="generator" content="GTK-Doc V1.12 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="about.html" title="Introduction to GnomeVFS">
 
14
<link rel="chapter" href="data-types.html" title="Basic Data Types">
 
15
<link rel="chapter" href="gnome-vfs-basic-file-ops.html" title="File Operations">
 
16
<link rel="chapter" href="gnome-vfs-directory-ops.html" title="Directory-Specific Operations">
 
17
<link rel="chapter" href="gnome-vfs-file-and-dirs-ops.html" title="Advanced File/Directory Operations">
 
18
<link rel="chapter" href="gnome-vfs-file-async-ops.html" title="Asynchronous Operations">
 
19
<link rel="chapter" href="volumes.html" title="Volumes and Drives Handling">
 
20
<link rel="chapter" href="networking.html" title="Networking">
 
21
<link rel="chapter" href="mime-registry.html" title="MIME Registry">
 
22
<link rel="chapter" href="modules.html" title="Filesystem Modules">
 
23
</head>
 
24
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
25
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
26
<tr valign="middle">
 
27
<td><a accesskey="p" href="gnome-vfs-2.0-gnome-vfs-volume.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
28
<td><a accesskey="u" href="volumes.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
29
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
30
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
 
31
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
32
</tr>
 
33
<tr><td colspan="5" class="shortcuts">
 
34
<a href="#gnome-vfs-2.0-gnome-vfs-drive.synopsis" class="shortcut">Top</a>
 
35
                   | 
 
36
                  <a href="#gnome-vfs-2.0-gnome-vfs-drive.description" class="shortcut">Description</a>
 
37
                   | 
 
38
                  <a href="#gnome-vfs-2.0-gnome-vfs-drive.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
39
                   | 
 
40
                  <a href="#gnome-vfs-2.0-gnome-vfs-drive.signals" class="shortcut">Signals</a>
 
41
</td></tr>
 
42
</table>
 
43
<div class="refentry" lang="en">
 
44
<a name="gnome-vfs-2.0-gnome-vfs-drive"></a><div class="titlepage"></div>
 
45
<div class="refnamediv"><table width="100%"><tr>
 
46
<td valign="top">
 
47
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-drive.top_of_page"></a>GnomeVFSDrive</span></h2>
 
48
<p>GnomeVFSDrive — Container for GnomeVFSVolume (floppy drive, CD reader, ...)</p>
 
49
</td>
 
50
<td valign="top" align="right"></td>
 
51
</tr></table></div>
 
52
<div class="refsynopsisdiv">
 
53
<a name="gnome-vfs-2.0-gnome-vfs-drive.synopsis"></a><h2>Synopsis</h2>
 
54
<a name="GnomeVFSDrive"></a><pre class="synopsis">
 
55
enum                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDeviceType" title="enum GnomeVFSDeviceType">GnomeVFSDeviceType</a>;
 
56
                    <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive-struct" title="GnomeVFSDrive">GnomeVFSDrive</a>;
 
57
                    <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDriveClass" title="GnomeVFSDriveClass">GnomeVFSDriveClass</a>;
 
58
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GNOME-IS-VFS-DRIVE:CAPS" title="GNOME_IS_VFS_DRIVE()">GNOME_IS_VFS_DRIVE</a>                  (o)
 
59
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GNOME-IS-VFS-DRIVE-CLASS:CAPS" title="GNOME_IS_VFS_DRIVE_CLASS()">GNOME_IS_VFS_DRIVE_CLASS</a>            (k)
 
60
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GNOME-VFS-TYPE-DRIVE:CAPS" title="GNOME_VFS_TYPE_DRIVE">GNOME_VFS_TYPE_DRIVE</a>
 
61
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GNOME-VFS-DRIVE:CAPS" title="GNOME_VFS_DRIVE()">GNOME_VFS_DRIVE</a>                     (o)
 
62
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GNOME-VFS-DRIVE-CLASS:CAPS" title="GNOME_VFS_DRIVE_CLASS()">GNOME_VFS_DRIVE_CLASS</a>               (k)
 
63
gint                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-compare" title="gnome_vfs_drive_compare ()">gnome_vfs_drive_compare</a>             (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *a,
 
64
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *b);
 
65
void                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-eject" title="gnome_vfs_drive_eject ()">gnome_vfs_drive_eject</a>               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
66
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
67
                                                         gpointer user_data);
 
68
char *              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-activation-uri" title="gnome_vfs_drive_get_activation_uri ()">gnome_vfs_drive_get_activation_uri</a>  (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
69
char *              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-device-path" title="gnome_vfs_drive_get_device_path ()">gnome_vfs_drive_get_device_path</a>     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
70
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDeviceType" title="enum GnomeVFSDeviceType">GnomeVFSDeviceType</a>  <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-device-type" title="gnome_vfs_drive_get_device_type ()">gnome_vfs_drive_get_device_type</a>     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
71
char *              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-display-name" title="gnome_vfs_drive_get_display_name ()">gnome_vfs_drive_get_display_name</a>    (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
72
char *              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-hal-udi" title="gnome_vfs_drive_get_hal_udi ()">gnome_vfs_drive_get_hal_udi</a>         (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
73
char *              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-icon" title="gnome_vfs_drive_get_icon ()">gnome_vfs_drive_get_icon</a>            (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
74
gulong              <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-id" title="gnome_vfs_drive_get_id ()">gnome_vfs_drive_get_id</a>              (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
75
<a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume">GnomeVFSVolume</a> *    <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volume" title="gnome_vfs_drive_get_mounted_volume ()">gnome_vfs_drive_get_mounted_volume</a>  (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
76
GList *             <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()">gnome_vfs_drive_get_mounted_volumes</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
77
void                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-volume-list-free" title="gnome_vfs_drive_volume_list_free ()">gnome_vfs_drive_volume_list_free</a>    (GList *volumes);
 
78
GType               <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-type" title="gnome_vfs_drive_get_type ()">gnome_vfs_drive_get_type</a>            (void);
 
79
gboolean            <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-is-connected" title="gnome_vfs_drive_is_connected ()">gnome_vfs_drive_is_connected</a>        (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
80
gboolean            <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-is-mounted" title="gnome_vfs_drive_is_mounted ()">gnome_vfs_drive_is_mounted</a>          (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
81
gboolean            <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-is-user-visible" title="gnome_vfs_drive_is_user_visible ()">gnome_vfs_drive_is_user_visible</a>     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
82
void                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-mount" title="gnome_vfs_drive_mount ()">gnome_vfs_drive_mount</a>               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
83
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
84
                                                         gpointer user_data);
 
85
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *     <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-ref" title="gnome_vfs_drive_ref ()">gnome_vfs_drive_ref</a>                 (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
86
void                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-unmount" title="gnome_vfs_drive_unmount ()">gnome_vfs_drive_unmount</a>             (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
87
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
88
                                                         gpointer user_data);
 
89
void                <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-unref" title="gnome_vfs_drive_unref ()">gnome_vfs_drive_unref</a>               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);
 
90
</pre>
 
91
</div>
 
92
<div class="refsect1" lang="en">
 
93
<a name="gnome-vfs-2.0-gnome-vfs-drive.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
94
<pre class="synopsis">
 
95
  GObject
 
96
   +----GnomeVFSDrive
 
97
</pre>
 
98
</div>
 
99
<div class="refsect1" lang="en">
 
100
<a name="gnome-vfs-2.0-gnome-vfs-drive.signals"></a><h2>Signals</h2>
 
101
<pre class="synopsis">
 
102
  "<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive-volume-mounted" title='The "volume-mounted" signal'>volume-mounted</a>"                                 : Run First
 
103
  "<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive-volume-pre-unmount" title='The "volume-pre-unmount" signal'>volume-pre-unmount</a>"                             : Run First
 
104
  "<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive-volume-unmounted" title='The "volume-unmounted" signal'>volume-unmounted</a>"                               : Run First
 
105
</pre>
 
106
</div>
 
107
<div class="refsect1" lang="en">
 
108
<a name="gnome-vfs-2.0-gnome-vfs-drive.description"></a><h2>Description</h2>
 
109
<p>
 
110
</p>
 
111
</div>
 
112
<div class="refsect1" lang="en">
 
113
<a name="gnome-vfs-2.0-gnome-vfs-drive.details"></a><h2>Details</h2>
 
114
<div class="refsect2" lang="en">
 
115
<a name="GnomeVFSDeviceType"></a><h3>enum GnomeVFSDeviceType</h3>
 
116
<pre class="programlisting">typedef enum {
 
117
        GNOME_VFS_DEVICE_TYPE_UNKNOWN,
 
118
        GNOME_VFS_DEVICE_TYPE_AUDIO_CD,
 
119
        GNOME_VFS_DEVICE_TYPE_VIDEO_DVD,
 
120
        GNOME_VFS_DEVICE_TYPE_HARDDRIVE, 
 
121
        GNOME_VFS_DEVICE_TYPE_CDROM,
 
122
        GNOME_VFS_DEVICE_TYPE_FLOPPY,
 
123
        GNOME_VFS_DEVICE_TYPE_ZIP,
 
124
        GNOME_VFS_DEVICE_TYPE_JAZ,
 
125
        GNOME_VFS_DEVICE_TYPE_NFS,
 
126
        GNOME_VFS_DEVICE_TYPE_AUTOFS,
 
127
        GNOME_VFS_DEVICE_TYPE_CAMERA,
 
128
        GNOME_VFS_DEVICE_TYPE_MEMORY_STICK,
 
129
        GNOME_VFS_DEVICE_TYPE_SMB,
 
130
        GNOME_VFS_DEVICE_TYPE_APPLE,
 
131
        GNOME_VFS_DEVICE_TYPE_MUSIC_PLAYER,
 
132
        GNOME_VFS_DEVICE_TYPE_WINDOWS, 
 
133
        GNOME_VFS_DEVICE_TYPE_LOOPBACK, 
 
134
        GNOME_VFS_DEVICE_TYPE_NETWORK 
 
135
} GnomeVFSDeviceType;
 
136
</pre>
 
137
<p>
 
138
Identifies the device type of a <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> or a <span class="type">GnomeVFSDrive.</span></p>
 
139
<p>
 
140
</p>
 
141
<div class="variablelist"><table border="0">
 
142
<col align="left" valign="top">
 
143
<tbody>
 
144
<tr>
 
145
<td><p><a name="GNOME-VFS-DEVICE-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_UNKNOWN</code></span></p></td>
 
146
<td> the type of this <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> or <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> is not known.
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><a name="GNOME-VFS-DEVICE-TYPE-AUDIO-CD:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_AUDIO_CD</code></span></p></td>
 
151
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects. Denotes that this
 
152
volume is an audio CD.
 
153
</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><a name="GNOME-VFS-DEVICE-TYPE-VIDEO-DVD:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_VIDEO_DVD</code></span></p></td>
 
157
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects. Denotes that this
 
158
volume is a video DVD.
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><a name="GNOME-VFS-DEVICE-TYPE-HARDDRIVE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_HARDDRIVE</code></span></p></td>
 
163
<td> this is a mount point refering to a harddisk partition that
 
164
neither has a Microsoft file system (FAT, VFAT, NTFS) nor an Apple file system (HFS, HFS+).
 
165
</td>
 
166
</tr>
 
167
<tr>
 
168
<td><p><a name="GNOME-VFS-DEVICE-TYPE-CDROM:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_CDROM</code></span></p></td>
 
169
<td> this may either be a mount point or a HAL drive/volume. Either way,
 
170
it refers to a CD-ROM device respectively volume.
 
171
</td>
 
172
</tr>
 
173
<tr>
 
174
<td><p><a name="GNOME-VFS-DEVICE-TYPE-FLOPPY:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_FLOPPY</code></span></p></td>
 
175
<td> the volume or drive referenced by this <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> or
 
176
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> is a floppy disc respectively a floppy drive.
 
177
</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><a name="GNOME-VFS-DEVICE-TYPE-ZIP:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_ZIP</code></span></p></td>
 
181
<td> the volume or drive referenced by this <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> or
 
182
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> is a ZIP disc respectively a ZIP drive.
 
183
</td>
 
184
</tr>
 
185
<tr>
 
186
<td><p><a name="GNOME-VFS-DEVICE-TYPE-JAZ:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_JAZ</code></span></p></td>
 
187
<td> the volume or drive referenced by this <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> or
 
188
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> is a JAZ disc respectively a JAZ drive.
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><a name="GNOME-VFS-DEVICE-TYPE-NFS:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_NFS</code></span></p></td>
 
193
<td> this is a mount point having an NFS file system.
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td><p><a name="GNOME-VFS-DEVICE-TYPE-AUTOFS:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_AUTOFS</code></span></p></td>
 
198
<td> this is a mount point having an AutoFS file system.
 
199
</td>
 
200
</tr>
 
201
<tr>
 
202
<td><p><a name="GNOME-VFS-DEVICE-TYPE-CAMERA:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_CAMERA</code></span></p></td>
 
203
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects. Denotes that this volume is a camera.
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><a name="GNOME-VFS-DEVICE-TYPE-MEMORY-STICK:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_MEMORY_STICK</code></span></p></td>
 
208
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects. Denotes that this volume is a memory stick.
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><a name="GNOME-VFS-DEVICE-TYPE-SMB:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_SMB</code></span></p></td>
 
213
<td> this is a mount point having a Samba file system.
 
214
</td>
 
215
</tr>
 
216
<tr>
 
217
<td><p><a name="GNOME-VFS-DEVICE-TYPE-APPLE:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_APPLE</code></span></p></td>
 
218
<td> this is a mount point refering to a harddisk partition, that has an
 
219
Apple file system (HFS, HFS+).
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td><p><a name="GNOME-VFS-DEVICE-TYPE-MUSIC-PLAYER:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_MUSIC_PLAYER</code></span></p></td>
 
224
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects. Denotes that this
 
225
volume is a music player.
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td><p><a name="GNOME-VFS-DEVICE-TYPE-WINDOWS:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_WINDOWS</code></span></p></td>
 
230
<td> this is a mount point refering to a harddisk partition, that has a
 
231
Microsoft file system (FAT, VFAT, NTFS).
 
232
</td>
 
233
</tr>
 
234
<tr>
 
235
<td><p><a name="GNOME-VFS-DEVICE-TYPE-LOOPBACK:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_LOOPBACK</code></span></p></td>
 
236
<td> this is a mount point refering to a loopback device.
 
237
</td>
 
238
</tr>
 
239
<tr>
 
240
<td><p><a name="GNOME-VFS-DEVICE-TYPE-NETWORK:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_DEVICE_TYPE_NETWORK</code></span></p></td>
 
241
<td> only used for <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects, denoting that this volume
 
242
refers to a network mount that is not managed by the kernel VFS but exclusively known to GnomeVFS.
 
243
</td>
 
244
</tr>
 
245
</tbody>
 
246
</table></div>
 
247
</div>
 
248
<hr>
 
249
<div class="refsect2" lang="en">
 
250
<a name="GnomeVFSDrive-struct"></a><h3>GnomeVFSDrive</h3>
 
251
<pre class="programlisting">typedef struct _GnomeVFSDrive GnomeVFSDrive;</pre>
 
252
<p>
 
253
</p>
 
254
</div>
 
255
<hr>
 
256
<div class="refsect2" lang="en">
 
257
<a name="GnomeVFSDriveClass"></a><h3>GnomeVFSDriveClass</h3>
 
258
<pre class="programlisting">typedef struct {
 
259
        GObjectClass parent_class;
 
260
 
 
261
        void (* volume_mounted)         (GnomeVFSDrive *drive,
 
262
                                         GnomeVFSVolume *volume);
 
263
        void (* volume_pre_unmount) (GnomeVFSDrive *drive,
 
264
                                         GnomeVFSVolume *volume);
 
265
        void (* volume_unmounted) (GnomeVFSDrive *drive,
 
266
                                         GnomeVFSVolume *volume);
 
267
} GnomeVFSDriveClass;
 
268
</pre>
 
269
<p>
 
270
</p>
 
271
</div>
 
272
<hr>
 
273
<div class="refsect2" lang="en">
 
274
<a name="GNOME-IS-VFS-DRIVE:CAPS"></a><h3>GNOME_IS_VFS_DRIVE()</h3>
 
275
<pre class="programlisting">#define GNOME_IS_VFS_DRIVE(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), GNOME_VFS_TYPE_DRIVE))
 
276
</pre>
 
277
<p>
 
278
</p>
 
279
<div class="variablelist"><table border="0">
 
280
<col align="left" valign="top">
 
281
<tbody><tr>
 
282
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
 
283
<td>
 
284
</td>
 
285
</tr></tbody>
 
286
</table></div>
 
287
</div>
 
288
<hr>
 
289
<div class="refsect2" lang="en">
 
290
<a name="GNOME-IS-VFS-DRIVE-CLASS:CAPS"></a><h3>GNOME_IS_VFS_DRIVE_CLASS()</h3>
 
291
<pre class="programlisting">#define GNOME_IS_VFS_DRIVE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GNOME_VFS_TYPE_DRIVE))
 
292
</pre>
 
293
<p>
 
294
</p>
 
295
<div class="variablelist"><table border="0">
 
296
<col align="left" valign="top">
 
297
<tbody><tr>
 
298
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
 
299
<td>
 
300
</td>
 
301
</tr></tbody>
 
302
</table></div>
 
303
</div>
 
304
<hr>
 
305
<div class="refsect2" lang="en">
 
306
<a name="GNOME-VFS-TYPE-DRIVE:CAPS"></a><h3>GNOME_VFS_TYPE_DRIVE</h3>
 
307
<pre class="programlisting">#define GNOME_VFS_TYPE_DRIVE        (gnome_vfs_drive_get_type ())
 
308
</pre>
 
309
<p>
 
310
</p>
 
311
</div>
 
312
<hr>
 
313
<div class="refsect2" lang="en">
 
314
<a name="GNOME-VFS-DRIVE:CAPS"></a><h3>GNOME_VFS_DRIVE()</h3>
 
315
<pre class="programlisting">#define GNOME_VFS_DRIVE(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), GNOME_VFS_TYPE_DRIVE, GnomeVFSDrive))
 
316
</pre>
 
317
<p>
 
318
</p>
 
319
<div class="variablelist"><table border="0">
 
320
<col align="left" valign="top">
 
321
<tbody><tr>
 
322
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
 
323
<td>
 
324
</td>
 
325
</tr></tbody>
 
326
</table></div>
 
327
</div>
 
328
<hr>
 
329
<div class="refsect2" lang="en">
 
330
<a name="GNOME-VFS-DRIVE-CLASS:CAPS"></a><h3>GNOME_VFS_DRIVE_CLASS()</h3>
 
331
<pre class="programlisting">#define GNOME_VFS_DRIVE_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), GNOME_VFS_TYPE_DRIVE, GnomeVFSDriveClass))
 
332
</pre>
 
333
<p>
 
334
</p>
 
335
<div class="variablelist"><table border="0">
 
336
<col align="left" valign="top">
 
337
<tbody><tr>
 
338
<td><p><span class="term"><em class="parameter"><code>k</code></em> :</span></p></td>
 
339
<td>
 
340
</td>
 
341
</tr></tbody>
 
342
</table></div>
 
343
</div>
 
344
<hr>
 
345
<div class="refsect2" lang="en">
 
346
<a name="gnome-vfs-drive-compare"></a><h3>gnome_vfs_drive_compare ()</h3>
 
347
<pre class="programlisting">gint                gnome_vfs_drive_compare             (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *a,
 
348
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *b);</pre>
 
349
<p>
 
350
Compares two <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> objects <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em>. Two
 
351
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> objects referring to different drives
 
352
are guaranteed to not return 0 when comparing them,
 
353
if they refer to the same drive 0 is returned.
 
354
</p>
 
355
<p>
 
356
The resulting <span class="type">gint</span> should be used to determine the
 
357
order in which <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> are displayed in graphical
 
358
user interfces.
 
359
</p>
 
360
<p>
 
361
The comparison algorithm first of all peeks the device
 
362
type of <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em>, they will be sorted in the following
 
363
order:
 
364
</p>
 
365
<div class="itemizedlist"><ul type="disc">
 
366
<li><p>Magnetic and opto-magnetic drives (ZIP, floppy)</p></li>
 
367
<li><p>Optical drives (CD, DVD)</p></li>
 
368
<li><p>External drives (USB sticks, music players)</p></li>
 
369
<li><p>Mounted hard disks&lt;</p></li>
 
370
<li><p>Other drives&lt;</p></li>
 
371
</ul></div>
 
372
<p>
 
373
</p>
 
374
<p>
 
375
Afterwards, the display name of <em class="parameter"><code>a</code></em> and <em class="parameter"><code>b</code></em> is compared
 
376
using a locale-sensitive sorting algorithm, which
 
377
involves <code class="function">g_utf8_collate_key()</code>.
 
378
</p>
 
379
<p>
 
380
If two drives have the same display name, their
 
381
unique ID is compared which can be queried using
 
382
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-id" title="gnome_vfs_drive_get_id ()"><code class="function">gnome_vfs_drive_get_id()</code></a>.</p>
 
383
<p>
 
384
</p>
 
385
<div class="variablelist"><table border="0">
 
386
<col align="left" valign="top">
 
387
<tbody>
 
388
<tr>
 
389
<td><p><span class="term"><em class="parameter"><code>a</code></em> :</span></p></td>
 
390
<td> a <span class="type">GnomeVFSDrive.</span>
 
391
</td>
 
392
</tr>
 
393
<tr>
 
394
<td><p><span class="term"><em class="parameter"><code>b</code></em> :</span></p></td>
 
395
<td> a <span class="type">GnomeVFSDrive.</span>
 
396
</td>
 
397
</tr>
 
398
<tr>
 
399
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
400
<td> 0 if the drives refer to the same <em class="parameter"><code>GnomeVFSDrive</code></em>,
 
401
a negative value if <em class="parameter"><code>a</code></em> should be displayed before <em class="parameter"><code>b</code></em>,
 
402
or a positive value if <em class="parameter"><code>a</code></em> should be displayed after <em class="parameter"><code>b</code></em>.
 
403
 
 
404
</td>
 
405
</tr>
 
406
</tbody>
 
407
</table></div>
 
408
<p class="since">Since 2.6</p>
 
409
</div>
 
410
<hr>
 
411
<div class="refsect2" lang="en">
 
412
<a name="gnome-vfs-drive-eject"></a><h3>gnome_vfs_drive_eject ()</h3>
 
413
<pre class="programlisting">void                gnome_vfs_drive_eject               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
414
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
415
                                                         gpointer user_data);</pre>
 
416
<p>
 
417
If <em class="parameter"><code>drive</code></em> has associated <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects, all of them will be
 
418
unmounted by calling <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#gnome-vfs-volume-unmount" title="gnome_vfs_volume_unmount ()"><code class="function">gnome_vfs_volume_unmount()</code></a> for each volume in
 
419
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a>, except for the last one,
 
420
for which <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#gnome-vfs-volume-eject" title="gnome_vfs_volume_eject ()"><code class="function">gnome_vfs_volume_eject()</code></a> is called to ensure that the
 
421
<em class="parameter"><code>drive</code></em>'s media is ejected.
 
422
</p>
 
423
<p>
 
424
If <em class="parameter"><code>drive</code></em> however has no associated <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> objects, it
 
425
simply calls an unmount helper on the <em class="parameter"><code>drive</code></em>.</p>
 
426
<p>
 
427
</p>
 
428
<div class="variablelist"><table border="0">
 
429
<col align="left" valign="top">
 
430
<tbody>
 
431
<tr>
 
432
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
433
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> that should be ejcted.
 
434
</td>
 
435
</tr>
 
436
<tr>
 
437
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
438
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()"><span class="type">GnomeVFSVolumeOpCallback</span></a> that should be invoked after ejecting <em class="parameter"><code>drive</code></em>.
 
439
</td>
 
440
</tr>
 
441
<tr>
 
442
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
443
<td> the user data to pass to <em class="parameter"><code>callback</code></em>.
 
444
</td>
 
445
</tr>
 
446
</tbody>
 
447
</table></div>
 
448
<p class="since">Since 2.6</p>
 
449
</div>
 
450
<hr>
 
451
<div class="refsect2" lang="en">
 
452
<a name="gnome-vfs-drive-get-activation-uri"></a><h3>gnome_vfs_drive_get_activation_uri ()</h3>
 
453
<pre class="programlisting">char *              gnome_vfs_drive_get_activation_uri  (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
454
<p>
 
455
Returns the activation URI of a <span class="type">GnomeVFSDrive.</span>
 
456
</p>
 
457
<p>
 
458
The returned URI usually refers to a valid location. You can check the
 
459
validity of the location by calling <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#gnome-vfs-uri-new" title="gnome_vfs_uri_new ()"><code class="function">gnome_vfs_uri_new()</code></a> with the URI,
 
460
and checking whether the return value is not <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
461
<p>
 
462
</p>
 
463
<div class="variablelist"><table border="0">
 
464
<col align="left" valign="top">
 
465
<tbody>
 
466
<tr>
 
467
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
468
<td> a <span class="type">GnomeVFSDrive.</span>
 
469
</td>
 
470
</tr>
 
471
<tr>
 
472
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
473
<td> a newly allocated string for the activation uri of the <span class="type">drive.</span>
 
474
 
 
475
</td>
 
476
</tr>
 
477
</tbody>
 
478
</table></div>
 
479
<p class="since">Since 2.6</p>
 
480
</div>
 
481
<hr>
 
482
<div class="refsect2" lang="en">
 
483
<a name="gnome-vfs-drive-get-device-path"></a><h3>gnome_vfs_drive_get_device_path ()</h3>
 
484
<pre class="programlisting">char *              gnome_vfs_drive_get_device_path     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
485
<p>
 
486
Returns the device path of a <span class="type">GnomeVFSDrive.</span>
 
487
</p>
 
488
<p>
 
489
For HAL drives, this returns the value of the
 
490
drives's "block.device" key. For UNIX mounts,
 
491
it returns the <code class="literal">mntent</code>'s <code class="literal">mnt_fsname</code> entry.
 
492
</p>
 
493
<p>
 
494
Otherwise, it returns <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
495
<p>
 
496
</p>
 
497
<div class="variablelist"><table border="0">
 
498
<col align="left" valign="top">
 
499
<tbody>
 
500
<tr>
 
501
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
502
<td> a <span class="type">GnomeVFSDrive.</span>
 
503
</td>
 
504
</tr>
 
505
<tr>
 
506
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
507
<td> a newly allocated string for the device path of the <span class="type">drive.</span>
 
508
 
 
509
</td>
 
510
</tr>
 
511
</tbody>
 
512
</table></div>
 
513
<p class="since">Since 2.6</p>
 
514
</div>
 
515
<hr>
 
516
<div class="refsect2" lang="en">
 
517
<a name="gnome-vfs-drive-get-device-type"></a><h3>gnome_vfs_drive_get_device_type ()</h3>
 
518
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDeviceType" title="enum GnomeVFSDeviceType">GnomeVFSDeviceType</a>  gnome_vfs_drive_get_device_type     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
519
<p>
 
520
</p>
 
521
<div class="variablelist"><table border="0">
 
522
<col align="left" valign="top">
 
523
<tbody>
 
524
<tr>
 
525
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
526
<td> a <span class="type">GnomeVFSDrive.</span>
 
527
</td>
 
528
</tr>
 
529
<tr>
 
530
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
531
<td> device type, a <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDeviceType" title="enum GnomeVFSDeviceType"><span class="type">GnomeVFSDeviceType</span></a> value.
 
532
 
 
533
</td>
 
534
</tr>
 
535
</tbody>
 
536
</table></div>
 
537
<p class="since">Since 2.6</p>
 
538
</div>
 
539
<hr>
 
540
<div class="refsect2" lang="en">
 
541
<a name="gnome-vfs-drive-get-display-name"></a><h3>gnome_vfs_drive_get_display_name ()</h3>
 
542
<pre class="programlisting">char *              gnome_vfs_drive_get_display_name    (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
543
<p>
 
544
</p>
 
545
<div class="variablelist"><table border="0">
 
546
<col align="left" valign="top">
 
547
<tbody>
 
548
<tr>
 
549
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
550
<td> a <span class="type">GnomeVFSDrive.</span>
 
551
</td>
 
552
</tr>
 
553
<tr>
 
554
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
555
<td> a newly allocated string for the display name of the <em class="parameter"><code>drive</code></em>.
 
556
 
 
557
</td>
 
558
</tr>
 
559
</tbody>
 
560
</table></div>
 
561
<p class="since">Since 2.6</p>
 
562
</div>
 
563
<hr>
 
564
<div class="refsect2" lang="en">
 
565
<a name="gnome-vfs-drive-get-hal-udi"></a><h3>gnome_vfs_drive_get_hal_udi ()</h3>
 
566
<pre class="programlisting">char *              gnome_vfs_drive_get_hal_udi         (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
567
<p>
 
568
Returns the HAL UDI of a <span class="type">GnomeVFSDrive.</span>
 
569
</p>
 
570
<p>
 
571
For HAL drives, this matches the value of the "info.udi" key,
 
572
for other drives it is <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
573
<p>
 
574
</p>
 
575
<div class="variablelist"><table border="0">
 
576
<col align="left" valign="top">
 
577
<tbody>
 
578
<tr>
 
579
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
580
<td> a <span class="type">GnomeVFSDrive.</span>
 
581
</td>
 
582
</tr>
 
583
<tr>
 
584
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
585
<td> a newly allocated string for the unique device id of the <em class="parameter"><code>drive</code></em>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
586
 
 
587
</td>
 
588
</tr>
 
589
</tbody>
 
590
</table></div>
 
591
<p class="since">Since 2.6</p>
 
592
</div>
 
593
<hr>
 
594
<div class="refsect2" lang="en">
 
595
<a name="gnome-vfs-drive-get-icon"></a><h3>gnome_vfs_drive_get_icon ()</h3>
 
596
<pre class="programlisting">char *              gnome_vfs_drive_get_icon            (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
597
<p>
 
598
</p>
 
599
<div class="variablelist"><table border="0">
 
600
<col align="left" valign="top">
 
601
<tbody>
 
602
<tr>
 
603
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
604
<td> a <span class="type">GnomeVFSDrive.</span>
 
605
</td>
 
606
</tr>
 
607
<tr>
 
608
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
609
<td> a newly allocated string for the icon filename of the <em class="parameter"><code>drive</code></em>.
 
610
 
 
611
</td>
 
612
</tr>
 
613
</tbody>
 
614
</table></div>
 
615
<p class="since">Since 2.6</p>
 
616
</div>
 
617
<hr>
 
618
<div class="refsect2" lang="en">
 
619
<a name="gnome-vfs-drive-get-id"></a><h3>gnome_vfs_drive_get_id ()</h3>
 
620
<pre class="programlisting">gulong              gnome_vfs_drive_get_id              (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
621
<p>
 
622
</p>
 
623
<div class="variablelist"><table border="0">
 
624
<col align="left" valign="top">
 
625
<tbody>
 
626
<tr>
 
627
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
628
<td> a <span class="type">GnomeVFSDrive.</span>
 
629
</td>
 
630
</tr>
 
631
<tr>
 
632
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
633
<td> drive id, a <span class="type">gulong</span> value.
 
634
 
 
635
</td>
 
636
</tr>
 
637
</tbody>
 
638
</table></div>
 
639
<p class="since">Since 2.6</p>
 
640
</div>
 
641
<hr>
 
642
<div class="refsect2" lang="en">
 
643
<a name="gnome-vfs-drive-get-mounted-volume"></a><h3>gnome_vfs_drive_get_mounted_volume ()</h3>
 
644
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume">GnomeVFSVolume</a> *    gnome_vfs_drive_get_mounted_volume  (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
645
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
646
<h3 class="title">Warning</h3>
 
647
<p><code class="literal">gnome_vfs_drive_get_mounted_volume</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a> instead.</p>
 
648
</div>
 
649
<p>
 
650
Returns the first mounted volume for the <em class="parameter"><code>drive</code></em>.</p>
 
651
<p>
 
652
</p>
 
653
<div class="variablelist"><table border="0">
 
654
<col align="left" valign="top">
 
655
<tbody>
 
656
<tr>
 
657
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
658
<td> a <span class="type">GnomeVFSDrive.</span>
 
659
</td>
 
660
</tr>
 
661
<tr>
 
662
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
663
<td> a <span class="type">GnomeVFSVolume.</span>
 
664
 
 
665
</td>
 
666
</tr>
 
667
</tbody>
 
668
</table></div>
 
669
<p class="since">Since 2.6</p>
 
670
</div>
 
671
<hr>
 
672
<div class="refsect2" lang="en">
 
673
<a name="gnome-vfs-drive-get-mounted-volumes"></a><h3>gnome_vfs_drive_get_mounted_volumes ()</h3>
 
674
<pre class="programlisting">GList *             gnome_vfs_drive_get_mounted_volumes (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
675
<p>
 
676
</p>
 
677
<div class="variablelist"><table border="0">
 
678
<col align="left" valign="top">
 
679
<tbody>
 
680
<tr>
 
681
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
682
<td> a <span class="type">GnomeVFSDrive.</span>
 
683
</td>
 
684
</tr>
 
685
<tr>
 
686
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
687
<td> list of mounted volumes for the <em class="parameter"><code>drive</code></em>.
 
688
 
 
689
</td>
 
690
</tr>
 
691
</tbody>
 
692
</table></div>
 
693
<p class="since">Since 2.8</p>
 
694
</div>
 
695
<hr>
 
696
<div class="refsect2" lang="en">
 
697
<a name="gnome-vfs-drive-volume-list-free"></a><h3>gnome_vfs_drive_volume_list_free ()</h3>
 
698
<pre class="programlisting">void                gnome_vfs_drive_volume_list_free    (GList *volumes);</pre>
 
699
<p>
 
700
Frees the list <em class="parameter"><code>volumes</code></em>, if it is not <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
701
<p>
 
702
</p>
 
703
<div class="variablelist"><table border="0">
 
704
<col align="left" valign="top">
 
705
<tbody><tr>
 
706
<td><p><span class="term"><em class="parameter"><code>volumes</code></em> :</span></p></td>
 
707
<td> list of <span class="type">GnomeVFSVolumes</span> to be freed, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
708
</td>
 
709
</tr></tbody>
 
710
</table></div>
 
711
<p class="since">Since 2.8</p>
 
712
</div>
 
713
<hr>
 
714
<div class="refsect2" lang="en">
 
715
<a name="gnome-vfs-drive-get-type"></a><h3>gnome_vfs_drive_get_type ()</h3>
 
716
<pre class="programlisting">GType               gnome_vfs_drive_get_type            (void);</pre>
 
717
<p>
 
718
</p>
 
719
<div class="variablelist"><table border="0">
 
720
<col align="left" valign="top">
 
721
<tbody><tr>
 
722
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
723
<td>
 
724
</td>
 
725
</tr></tbody>
 
726
</table></div>
 
727
</div>
 
728
<hr>
 
729
<div class="refsect2" lang="en">
 
730
<a name="gnome-vfs-drive-is-connected"></a><h3>gnome_vfs_drive_is_connected ()</h3>
 
731
<pre class="programlisting">gboolean            gnome_vfs_drive_is_connected        (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
732
<p>
 
733
</p>
 
734
<div class="variablelist"><table border="0">
 
735
<col align="left" valign="top">
 
736
<tbody>
 
737
<tr>
 
738
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
739
<td> a <span class="type">GnomeVFSDrive.</span>
 
740
</td>
 
741
</tr>
 
742
<tr>
 
743
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
744
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>drive</code></em> is connected, <code class="literal">FALSE</code> otherwise.
 
745
 
 
746
</td>
 
747
</tr>
 
748
</tbody>
 
749
</table></div>
 
750
<p class="since">Since 2.6</p>
 
751
</div>
 
752
<hr>
 
753
<div class="refsect2" lang="en">
 
754
<a name="gnome-vfs-drive-is-mounted"></a><h3>gnome_vfs_drive_is_mounted ()</h3>
 
755
<pre class="programlisting">gboolean            gnome_vfs_drive_is_mounted          (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
756
<p>
 
757
</p>
 
758
<div class="variablelist"><table border="0">
 
759
<col align="left" valign="top">
 
760
<tbody>
 
761
<tr>
 
762
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
763
<td> a <span class="type">GnomeVFSDrive.</span>
 
764
</td>
 
765
</tr>
 
766
<tr>
 
767
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
768
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>drive</code></em> is mounted, <code class="literal">FALSE</code> otherwise.
 
769
 
 
770
</td>
 
771
</tr>
 
772
</tbody>
 
773
</table></div>
 
774
<p class="since">Since 2.6</p>
 
775
</div>
 
776
<hr>
 
777
<div class="refsect2" lang="en">
 
778
<a name="gnome-vfs-drive-is-user-visible"></a><h3>gnome_vfs_drive_is_user_visible ()</h3>
 
779
<pre class="programlisting">gboolean            gnome_vfs_drive_is_user_visible     (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
780
<p>
 
781
Returns whether the <em class="parameter"><code>drive</code></em> is visible to the user. This
 
782
should be used by applications to determine whether it
 
783
is included in user interfaces listing available drives.</p>
 
784
<p>
 
785
</p>
 
786
<div class="variablelist"><table border="0">
 
787
<col align="left" valign="top">
 
788
<tbody>
 
789
<tr>
 
790
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
791
<td> a <span class="type">GnomeVFSDrive.</span>
 
792
</td>
 
793
</tr>
 
794
<tr>
 
795
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
796
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>drive</code></em> is visible to the user, <code class="literal">FALSE</code> otherwise.
 
797
 
 
798
</td>
 
799
</tr>
 
800
</tbody>
 
801
</table></div>
 
802
<p class="since">Since 2.6</p>
 
803
</div>
 
804
<hr>
 
805
<div class="refsect2" lang="en">
 
806
<a name="gnome-vfs-drive-mount"></a><h3>gnome_vfs_drive_mount ()</h3>
 
807
<pre class="programlisting">void                gnome_vfs_drive_mount               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
808
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
809
                                                         gpointer user_data);</pre>
 
810
<p>
 
811
</p>
 
812
<div class="variablelist"><table border="0">
 
813
<col align="left" valign="top">
 
814
<tbody>
 
815
<tr>
 
816
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
817
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> that should be mounted.
 
818
</td>
 
819
</tr>
 
820
<tr>
 
821
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
822
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()"><span class="type">GnomeVFSVolumeOpCallback</span></a> that should be invoked after mounting <em class="parameter"><code>drive</code></em>.
 
823
</td>
 
824
</tr>
 
825
<tr>
 
826
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
827
<td> the user data to pass to <em class="parameter"><code>callback</code></em>.
 
828
</td>
 
829
</tr>
 
830
</tbody>
 
831
</table></div>
 
832
<p class="since">Since 2.6</p>
 
833
</div>
 
834
<hr>
 
835
<div class="refsect2" lang="en">
 
836
<a name="gnome-vfs-drive-ref"></a><h3>gnome_vfs_drive_ref ()</h3>
 
837
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *     gnome_vfs_drive_ref                 (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
838
<p>
 
839
Increases the refcount of the <em class="parameter"><code>drive</code></em> by 1, if it is not <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
840
<p>
 
841
</p>
 
842
<div class="variablelist"><table border="0">
 
843
<col align="left" valign="top">
 
844
<tbody>
 
845
<tr>
 
846
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
847
<td> a <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
848
</td>
 
849
</tr>
 
850
<tr>
 
851
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
852
<td> the <em class="parameter"><code>drive</code></em> with its refcount increased by one,
 
853
            or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>drive</code></em> is <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
854
 
 
855
</td>
 
856
</tr>
 
857
</tbody>
 
858
</table></div>
 
859
<p class="since">Since 2.6</p>
 
860
</div>
 
861
<hr>
 
862
<div class="refsect2" lang="en">
 
863
<a name="gnome-vfs-drive-unmount"></a><h3>gnome_vfs_drive_unmount ()</h3>
 
864
<pre class="programlisting">void                gnome_vfs_drive_unmount             (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive,
 
865
                                                         <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()">GnomeVFSVolumeOpCallback</a> callback,
 
866
                                                         gpointer user_data);</pre>
 
867
<p>
 
868
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-unmount" title="gnome_vfs_drive_unmount ()"><code class="function">gnome_vfs_drive_unmount()</code></a> invokes <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-eject" title="gnome_vfs_drive_eject ()"><code class="function">gnome_vfs_drive_eject()</code></a>, if the <em class="parameter"><code>drive</code></em> signals
 
869
that it should be ejected when it is unmounted. This may be true for CD-ROMs,
 
870
USB sticks and other devices, depending on the backend providing the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> <em class="parameter"><code>drive</code></em>.
 
871
</p>
 
872
<p>
 
873
If the <em class="parameter"><code>drive</code></em> does not signal that it should be ejected when it is unmounted,
 
874
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-unmount" title="gnome_vfs_drive_unmount ()"><code class="function">gnome_vfs_drive_unmount()</code></a> calls <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#gnome-vfs-volume-unmount" title="gnome_vfs_volume_unmount ()"><code class="function">gnome_vfs_volume_unmount()</code></a> for each of the
 
875
<em class="parameter"><code>drive</code></em>'s mounted <span class="type">GnomeVFSVolumes</span>, which can be queried using
 
876
<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a>.</p>
 
877
<p>
 
878
</p>
 
879
<div class="variablelist"><table border="0">
 
880
<col align="left" valign="top">
 
881
<tbody>
 
882
<tr>
 
883
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
884
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> that should be unmounted.
 
885
</td>
 
886
</tr>
 
887
<tr>
 
888
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
889
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolumeOpCallback" title="GnomeVFSVolumeOpCallback ()"><span class="type">GnomeVFSVolumeOpCallback</span></a> that should be invoked after unmounting <em class="parameter"><code>drive</code></em>.
 
890
</td>
 
891
</tr>
 
892
<tr>
 
893
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
894
<td> the user data to pass to <em class="parameter"><code>callback</code></em>.
 
895
</td>
 
896
</tr>
 
897
</tbody>
 
898
</table></div>
 
899
<p class="since">Since 2.6</p>
 
900
</div>
 
901
<hr>
 
902
<div class="refsect2" lang="en">
 
903
<a name="gnome-vfs-drive-unref"></a><h3>gnome_vfs_drive_unref ()</h3>
 
904
<pre class="programlisting">void                gnome_vfs_drive_unref               (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a> *drive);</pre>
 
905
<p>
 
906
Decreases the refcount of the <em class="parameter"><code>drive</code></em> by 1, if it is not <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 
907
<p>
 
908
</p>
 
909
<div class="variablelist"><table border="0">
 
910
<col align="left" valign="top">
 
911
<tbody><tr>
 
912
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
913
<td> a <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.
 
914
</td>
 
915
</tr></tbody>
 
916
</table></div>
 
917
<p class="since">Since 2.6</p>
 
918
</div>
 
919
</div>
 
920
<div class="refsect1" lang="en">
 
921
<a name="gnome-vfs-2.0-gnome-vfs-drive.signal-details"></a><h2>Signal Details</h2>
 
922
<div class="refsect2" lang="en">
 
923
<a name="GnomeVFSDrive-volume-mounted"></a><h3>The <code class="literal">"volume-mounted"</code> signal</h3>
 
924
<pre class="programlisting">void                user_function                      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a>  *drive,
 
925
                                                        <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume">GnomeVFSVolume</a> *volume,
 
926
                                                        gpointer        user_data)      : Run First</pre>
 
927
<p>
 
928
This signal is emitted after the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> <em class="parameter"><code>volume</code></em> has been mounted.
 
929
</p>
 
930
<p>
 
931
When the <em class="parameter"><code>volume</code></em> is mounted, it is added to the <em class="parameter"><code>drive</code></em>'s list of mounted
 
932
volumes, which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a>.
 
933
</p>
 
934
<p>
 
935
It is also added to the list of the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#GnomeVFSVolumeMonitor"><span class="type">GnomeVFSVolumeMonitor</span></a>'s list of mounted
 
936
volumes, which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#gnome-vfs-volume-monitor-get-mounted-volumes" title="gnome_vfs_volume_monitor_get_mounted_volumes ()"><code class="function">gnome_vfs_volume_monitor_get_mounted_volumes()</code></a>.</p>
 
937
<p>
 
938
</p>
 
939
<div class="variablelist"><table border="0">
 
940
<col align="left" valign="top">
 
941
<tbody>
 
942
<tr>
 
943
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
944
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> which received the signal.
 
945
</td>
 
946
</tr>
 
947
<tr>
 
948
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
 
949
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> that has been mounted.
 
950
</td>
 
951
</tr>
 
952
<tr>
 
953
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
954
<td>user data set when the signal handler was connected.</td>
 
955
</tr>
 
956
</tbody>
 
957
</table></div>
 
958
</div>
 
959
<hr>
 
960
<div class="refsect2" lang="en">
 
961
<a name="GnomeVFSDrive-volume-pre-unmount"></a><h3>The <code class="literal">"volume-pre-unmount"</code> signal</h3>
 
962
<pre class="programlisting">void                user_function                      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a>  *drive,
 
963
                                                        <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume">GnomeVFSVolume</a> *volume,
 
964
                                                        gpointer        user_data)      : Run First</pre>
 
965
<p>
 
966
This signal is emitted when the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> <em class="parameter"><code>volume</code></em>, which has been present in
 
967
the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> <em class="parameter"><code>drive</code></em>, is about to be unmounted.
 
968
</p>
 
969
<p>
 
970
When the <em class="parameter"><code>volume</code></em> is unmounted, it is removed from the <em class="parameter"><code>drive</code></em>'s list of mounted
 
971
volumes, which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a>.
 
972
</p>
 
973
<p>
 
974
It is also removed from the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#GnomeVFSVolumeMonitor"><span class="type">GnomeVFSVolumeMonitor</span></a>'s list of mounted volumes,
 
975
which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#gnome-vfs-volume-monitor-get-mounted-volumes" title="gnome_vfs_volume_monitor_get_mounted_volumes ()"><code class="function">gnome_vfs_volume_monitor_get_mounted_volumes()</code></a>.
 
976
</p>
 
977
<p>
 
978
When a client application receives this signal, it must free all resources
 
979
associated with the <em class="parameter"><code>volume</code></em>, for instance cancel all pending file operations
 
980
on the <em class="parameter"><code>volume</code></em>, and cancel all pending file monitors using <a class="link" href="gnome-vfs-2.0-gnome-vfs-monitor.html#gnome-vfs-monitor-cancel" title="gnome_vfs_monitor_cancel ()"><code class="function">gnome_vfs_monitor_cancel()</code></a>.</p>
 
981
<p>
 
982
</p>
 
983
<div class="variablelist"><table border="0">
 
984
<col align="left" valign="top">
 
985
<tbody>
 
986
<tr>
 
987
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
988
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> which received the signal.
 
989
</td>
 
990
</tr>
 
991
<tr>
 
992
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
 
993
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> that is about to be unmounted.
 
994
</td>
 
995
</tr>
 
996
<tr>
 
997
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
998
<td>user data set when the signal handler was connected.</td>
 
999
</tr>
 
1000
</tbody>
 
1001
</table></div>
 
1002
</div>
 
1003
<hr>
 
1004
<div class="refsect2" lang="en">
 
1005
<a name="GnomeVFSDrive-volume-unmounted"></a><h3>The <code class="literal">"volume-unmounted"</code> signal</h3>
 
1006
<pre class="programlisting">void                user_function                      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive">GnomeVFSDrive</a>  *drive,
 
1007
                                                        <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume">GnomeVFSVolume</a> *volume,
 
1008
                                                        gpointer        user_data)      : Run First</pre>
 
1009
<p>
 
1010
This signal is emitted after the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> <em class="parameter"><code>volume</code></em>, which had been present in
 
1011
the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> <em class="parameter"><code>drive</code></em>, has been unmounted.
 
1012
</p>
 
1013
<p>
 
1014
When the <em class="parameter"><code>volume</code></em> is unmounted, it is removed from the <em class="parameter"><code>drive</code></em>'s list of mounted
 
1015
volumes, which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#gnome-vfs-drive-get-mounted-volumes" title="gnome_vfs_drive_get_mounted_volumes ()"><code class="function">gnome_vfs_drive_get_mounted_volumes()</code></a>.
 
1016
</p>
 
1017
<p>
 
1018
It is also removed from the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#GnomeVFSVolumeMonitor"><span class="type">GnomeVFSVolumeMonitor</span></a>'s list of mounted volumes,
 
1019
which can be queried using <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume-monitor.html#gnome-vfs-volume-monitor-get-mounted-volumes" title="gnome_vfs_volume_monitor_get_mounted_volumes ()"><code class="function">gnome_vfs_volume_monitor_get_mounted_volumes()</code></a>.</p>
 
1020
<p>
 
1021
</p>
 
1022
<div class="variablelist"><table border="0">
 
1023
<col align="left" valign="top">
 
1024
<tbody>
 
1025
<tr>
 
1026
<td><p><span class="term"><em class="parameter"><code>drive</code></em> :</span></p></td>
 
1027
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-drive.html#GnomeVFSDrive"><span class="type">GnomeVFSDrive</span></a> which received the signal.
 
1028
</td>
 
1029
</tr>
 
1030
<tr>
 
1031
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
 
1032
<td> the <a class="link" href="gnome-vfs-2.0-gnome-vfs-volume.html#GnomeVFSVolume"><span class="type">GnomeVFSVolume</span></a> that has been unmounted.
 
1033
</td>
 
1034
</tr>
 
1035
<tr>
 
1036
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1037
<td>user data set when the signal handler was connected.</td>
 
1038
</tr>
 
1039
</tbody>
 
1040
</table></div>
 
1041
</div>
 
1042
</div>
 
1043
</div>
 
1044
<div class="footer">
 
1045
<hr>
 
1046
          Generated by GTK-Doc V1.12</div>
 
1047
</body>
 
1048
</html>