1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>BraseroVolume</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
<link rel="home" href="index.html" title="Brasero Libraries Reference Manual">
8
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-media">
9
<link rel="prev" href="BraseroMedium.html" title="BraseroMedium">
10
<link rel="next" href="BraseroMediumSelection.html" title="BraseroMediumSelection">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="API Reference for Libbrasero-media">
14
<link rel="chapter" href="ch02.html" title="API Reference for Libbrasero-burn">
15
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
16
<link rel="index" href="api-index-full.html" title="API Index">
18
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
19
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
21
<td><a accesskey="p" href="BraseroMedium.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
22
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
24
<th width="100%" align="center">Brasero Libraries Reference Manual</th>
25
<td><a accesskey="n" href="BraseroMediumSelection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
<tr><td colspan="5" class="shortcuts">
28
<a href="#BraseroVolume.synopsis" class="shortcut">Top</a>
30
<a href="#BraseroVolume.description" class="shortcut">Description</a>
32
<a href="#BraseroVolume.object-hierarchy" class="shortcut">Object Hierarchy</a>
35
<div class="refentry" lang="en">
36
<a name="BraseroVolume"></a><div class="titlepage"></div>
37
<div class="refnamediv"><table width="100%"><tr>
39
<h2><span class="refentrytitle"><a name="BraseroVolume.top_of_page"></a>BraseroVolume</span></h2>
42
<td valign="top" align="right"></td>
44
<div class="refsynopsisdiv">
45
<a name="BraseroVolume.synopsis"></a><h2>Synopsis</h2>
46
<pre class="synopsis">
47
<a class="link" href="BraseroVolume.html#BraseroVolume-struct" title="BraseroVolume">BraseroVolume</a>;
49
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
50
>gchar</a> * <a class="link" href="BraseroVolume.html#brasero-volume-get-name" title="brasero_volume_get_name ()">brasero_volume_get_name</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);
52
href="http://library.gnome.org/devel/gio/unstable/GIcon.html"
53
>GIcon</a> * <a class="link" href="BraseroVolume.html#brasero-volume-get-icon" title="brasero_volume_get_icon ()">brasero_volume_get_icon</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);
55
href="http://library.gnome.org/devel/gio/unstable/GVolume.html"
56
>GVolume</a> * <a class="link" href="BraseroVolume.html#brasero-volume-get-gvolume" title="brasero_volume_get_gvolume ()">brasero_volume_get_gvolume</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);
58
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
59
>gboolean</a> <a class="link" href="BraseroVolume.html#brasero-volume-is-mounted" title="brasero_volume_is_mounted ()">brasero_volume_is_mounted</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);
61
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
62
>gchar</a> * <a class="link" href="BraseroVolume.html#brasero-volume-get-mount-point" title="brasero_volume_get_mount_point ()">brasero_volume_get_mount_point</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
64
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
67
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
68
>gboolean</a> <a class="link" href="BraseroVolume.html#brasero-volume-umount" title="brasero_volume_umount ()">brasero_volume_umount</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
70
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
73
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
77
>gboolean</a> <a class="link" href="BraseroVolume.html#brasero-volume-mount" title="brasero_volume_mount ()">brasero_volume_mount</a> (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
79
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
80
>GtkWindow</a> *parent_window,
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
85
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
87
void <a class="link" href="BraseroVolume.html#brasero-volume-cancel-current-operation" title="brasero_volume_cancel_current_operation ()">brasero_volume_cancel_current_operation</a>
88
(<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);
91
<div class="refsect1" lang="en">
92
<a name="BraseroVolume.object-hierarchy"></a><h2>Object Hierarchy</h2>
93
<pre class="synopsis">
95
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
97
+----<a class="link" href="BraseroMedium.html" title="BraseroMedium">BraseroMedium</a>
101
<div class="refsect1" lang="en">
102
<a name="BraseroVolume.description"></a><h2>Description</h2>
106
<div class="refsect1" lang="en">
107
<a name="BraseroVolume.details"></a><h2>Details</h2>
108
<div class="refsect2" lang="en">
109
<a name="BraseroVolume-struct"></a><h3>BraseroVolume</h3>
110
<pre class="programlisting">typedef struct _BraseroVolume BraseroVolume;</pre>
115
<div class="refsect2" lang="en">
116
<a name="brasero-volume-get-name"></a><h3>brasero_volume_get_name ()</h3>
117
<pre class="programlisting"><a
118
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
119
>gchar</a> * brasero_volume_get_name (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);</pre>
121
Returns a string that can be displayed to represent the volume²</p>
124
<div class="variablelist"><table border="0">
125
<col align="left" valign="top">
128
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
129
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a> *
133
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
135
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
136
><span class="type">gchar</span></a> *. Free when not needed anymore.
144
<div class="refsect2" lang="en">
145
<a name="brasero-volume-get-icon"></a><h3>brasero_volume_get_icon ()</h3>
146
<pre class="programlisting"><a
147
href="http://library.gnome.org/devel/gio/unstable/GIcon.html"
148
>GIcon</a> * brasero_volume_get_icon (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);</pre>
150
Returns a GIcon pointer for the volume.</p>
153
<div class="variablelist"><table border="0">
154
<col align="left" valign="top">
157
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
158
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a> *
162
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
164
href="http://library.gnome.org/devel/gio/unstable/GIcon.html"
165
><span class="type">GIcon</span></a>*
173
<div class="refsect2" lang="en">
174
<a name="brasero-volume-get-gvolume"></a><h3>brasero_volume_get_gvolume ()</h3>
175
<pre class="programlisting"><a
176
href="http://library.gnome.org/devel/gio/unstable/GVolume.html"
177
>GVolume</a> * brasero_volume_get_gvolume (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);</pre>
179
Gets the corresponding <a
180
href="http://library.gnome.org/devel/gio/unstable/GVolume.html"
181
><span class="type">GVolume</span></a> for <em class="parameter"><code>volume</code></em>.</p>
184
<div class="variablelist"><table border="0">
185
<col align="left" valign="top">
188
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
189
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a>
193
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
195
href="http://library.gnome.org/devel/gio/unstable/GVolume.html"
196
><span class="type">GVolume</span></a> *.
204
<div class="refsect2" lang="en">
205
<a name="brasero-volume-is-mounted"></a><h3>brasero_volume_is_mounted ()</h3>
206
<pre class="programlisting"><a
207
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
208
>gboolean</a> brasero_volume_is_mounted (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);</pre>
210
Returns whether the volume is currently mounted.</p>
213
<div class="variablelist"><table border="0">
214
<col align="left" valign="top">
217
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
218
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a>
222
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
224
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
225
><span class="type">gboolean</span></a>. TRUE if it is mounted.
233
<div class="refsect2" lang="en">
234
<a name="brasero-volume-get-mount-point"></a><h3>brasero_volume_get_mount_point ()</h3>
235
<pre class="programlisting"><a
236
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
237
>gchar</a> * brasero_volume_get_mount_point (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
239
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
240
>GError</a> **error);</pre>
242
Returns the path for mount point for <em class="parameter"><code>volume</code></em>.</p>
245
<div class="variablelist"><table border="0">
246
<col align="left" valign="top">
249
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
250
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a>
254
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
256
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
257
><span class="type">GError</span></a> **
261
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
263
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
264
><span class="type">gchar</span></a> *
272
<div class="refsect2" lang="en">
273
<a name="brasero-volume-umount"></a><h3>brasero_volume_umount ()</h3>
274
<pre class="programlisting"><a
275
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
276
>gboolean</a> brasero_volume_umount (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
278
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
281
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
282
>GError</a> **error);</pre>
284
Unmount <em class="parameter"><code>volume</code></em>. If wait is set to TRUE, then block (in a GMainLoop) until
285
the operation finishes.</p>
288
<div class="variablelist"><table border="0">
289
<col align="left" valign="top">
292
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
293
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a>
297
<td><p><span class="term"><em class="parameter"><code>wait</code></em> :</span></p></td>
299
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
300
><span class="type">gboolean</span></a>
304
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
306
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
307
><span class="type">GError</span></a> **
311
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
313
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
314
><span class="type">gboolean</span></a>. TRUE if the operation succeeded.
322
<div class="refsect2" lang="en">
323
<a name="brasero-volume-mount"></a><h3>brasero_volume_mount ()</h3>
324
<pre class="programlisting"><a
325
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
326
>gboolean</a> brasero_volume_mount (<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume,
328
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
329
>GtkWindow</a> *parent_window,
331
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
334
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
335
>GError</a> **error);</pre>
337
Mount <em class="parameter"><code>volume</code></em>. If wait is set to TRUE, then block (in a GMainLoop) until
338
the operation finishes.
339
<em class="parameter"><code>parent_window</code></em> is used if an authentification is needed. Then the authentification
340
dialog will be set modal.</p>
343
<div class="variablelist"><table border="0">
344
<col align="left" valign="top">
347
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
348
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a> *
352
<td><p><span class="term"><em class="parameter"><code>parent_window</code></em> :</span></p></td>
354
href="http://library.gnome.org/devel/gtk/unstable/GtkWindow.html"
355
><span class="type">GtkWindow</span></a> *
359
<td><p><span class="term"><em class="parameter"><code>wait</code></em> :</span></p></td>
361
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
362
><span class="type">gboolean</span></a>
366
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
368
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
369
><span class="type">GError</span></a> **
373
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
375
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
376
><span class="type">gboolean</span></a>. TRUE if the operation succeeded.
384
<div class="refsect2" lang="en">
385
<a name="brasero-volume-cancel-current-operation"></a><h3>brasero_volume_cancel_current_operation ()</h3>
386
<pre class="programlisting">void brasero_volume_cancel_current_operation
387
(<a class="link" href="BraseroVolume.html" title="BraseroVolume">BraseroVolume</a> *volume);</pre>
389
Cancels all operations currently running for <em class="parameter"><code>volume</code></em></p>
392
<div class="variablelist"><table border="0">
393
<col align="left" valign="top">
395
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
396
<td> <a class="link" href="BraseroVolume.html" title="BraseroVolume"><span class="type">BraseroVolume</span></a> *
405
Generated by GTK-Doc V1.11</div>