/usr/share/gtk-doc/html/libbrasero-burn/libbrasero-burn-BraseroBurn.html is in libbrasero-media3-dev 3.4.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BraseroBurn</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Libbrasero-burn Reference Manual">
<link rel="up" href="ch01.html" title="API Reference for Libbrasero-burn">
<link rel="prev" href="libbrasero-burn-BraseroBurnOptions.html" title="BraseroBurnOptions">
<link rel="next" href="libbrasero-burn-BraseroBurnDialog.html" title="BraseroBurnDialog">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbrasero-burn-BraseroBurnOptions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbrasero-burn Reference Manual</th>
<td><a accesskey="n" href="libbrasero-burn-BraseroBurnDialog.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbrasero-burn-BraseroBurn.synopsis" class="shortcut">Top</a>
|
<a href="#libbrasero-burn-BraseroBurn.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbrasero-burn-BraseroBurn"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbrasero-burn-BraseroBurn.top_of_page"></a>BraseroBurn</span></h2>
<p>BraseroBurn</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbrasero-burn-BraseroBurn.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn">BraseroBurn</a>;
<a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="returnvalue">BraseroBurn</span></a> * <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-new" title="brasero_burn_new ()">brasero_burn_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-record" title="brasero_burn_record ()">brasero_burn_record</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-check" title="brasero_burn_check ()">brasero_burn_check</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-blank" title="brasero_burn_blank ()">brasero_burn_blank</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-cancel" title="brasero_burn_cancel ()">brasero_burn_cancel</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);
<a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-status" title="brasero_burn_status ()">brasero_burn_status</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> *media</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbrasero-burn-BraseroBurn.html#brasero-burn-get-action-string" title="brasero_burn_get_action_string ()">brasero_burn_get_action_string</a> (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnAction" title="enum BraseroBurnAction"><span class="type">BraseroBurnAction</span></a> action</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbrasero-burn-BraseroBurn.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libbrasero-burn-BraseroBurn.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BraseroBurn"></a><h3>BraseroBurn</h3>
<pre class="programlisting">typedef struct {
GObject parent;
} BraseroBurn;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-new"></a><h3>brasero_burn_new ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="returnvalue">BraseroBurn</span></a> * brasero_burn_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-record"></a><h3>brasero_burn_record ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> brasero_burn_record (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Burns or creates a disc image according to the parameters
set in <em class="parameter"><code>session</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>. The result of the operation.
BRASERO_BURN_OK if it was successful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-check"></a><h3>brasero_burn_check ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> brasero_burn_check (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Checks the integrity of a medium according to the parameters
set in <em class="parameter"><code>session</code></em>. The medium must be inserted in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
set as the source of a <a class="link" href="libbrasero-burn-BraseroTrackDisc.html#BraseroTrackDisc" title="BraseroTrackDisc"><span class="type">BraseroTrackDisc</span></a> track inserted in <em class="parameter"><code>session</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>. The result of the operation.
BRASERO_BURN_OK if it was successful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-blank"></a><h3>brasero_burn_blank ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> brasero_burn_blank (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Blanks a medium according to the parameters
set in <em class="parameter"><code>session</code></em>. The medium must be inserted in the <a href="../libbrasero-media/libbrasero-media-brasero-drive.html#BraseroDrive"><span class="type">BraseroDrive</span></a>
set with <a class="link" href="libbrasero-burn-BraseroBurnSession.html#brasero-burn-session-set-burner" title="brasero_burn_session_set_burner ()"><code class="function">brasero_burn_session_set_burner()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>session</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurnSession.html#BraseroBurnSession" title="struct BraseroBurnSession"><span class="type">BraseroBurnSession</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>. The result of the operation.
BRASERO_BURN_OK if it was successful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-cancel"></a><h3>brasero_burn_cancel ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> brasero_burn_cancel (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> protect</code></em>);</pre>
<p>
Cancels any ongoing operation. If <em class="parameter"><code>protect</code></em> is TRUE then
cancellation will not take place for a "critical" task, a task whose interruption
could damage the medium or the drive.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>protect</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>. The result of the operation.
BRASERO_BURN_OK if it was successful.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-status"></a><h3>brasero_burn_status ()</h3>
<pre class="programlisting"><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="returnvalue">BraseroBurnResult</span></a> brasero_burn_status (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> *media</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *isosize</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> *written</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> *rate</code></em>);</pre>
<p>
Returns various information about the current operation
in <em class="parameter"><code>media</code></em> (the current media type being burnt),
<em class="parameter"><code>isosize</code></em> (the size of the data being burnt), <em class="parameter"><code>written</code></em> (the
number of bytes having been written so far) and <em class="parameter"><code>rate</code></em>
(the speed at which data are written).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
<td>a <a href="../libbrasero-media/libbrasero-media-brasero-media.html#BraseroMedia"><span class="type">BraseroMedia</span></a> or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>isosize</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>written</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> or NULL</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rate</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> or NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnResult" title="enum BraseroBurnResult"><span class="type">BraseroBurnResult</span></a>. BRASERO_BURN_OK if there is
an ongoing operation; BRASERO_BURN_NOT_READY otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="brasero-burn-get-action-string"></a><h3>brasero_burn_get_action_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> brasero_burn_get_action_string (<em class="parameter"><code><a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a> *burn</code></em>,
<em class="parameter"><code><a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnAction" title="enum BraseroBurnAction"><span class="type">BraseroBurnAction</span></a> action</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **string</code></em>);</pre>
<p>
This function returns the current action (in <em class="parameter"><code>string</code></em>) of
an ongoing operation performed by <em class="parameter"><code>burn</code></em>.
<em class="parameter"><code>action</code></em> is used to set a default string in case there was
no string set by the backend to describe the current
operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>burn</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-BraseroBurn.html#BraseroBurn" title="BraseroBurn"><span class="type">BraseroBurn</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>a <a class="link" href="libbrasero-burn-brasero-enums.html#BraseroBurnAction" title="enum BraseroBurnAction"><span class="type">BraseroBurnAction</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>a <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|