~behda/+junk/udisks2.original

« back to all changes in this revision

Viewing changes to doc/html/UDisksLinuxDriveAta.html

  • Committer: behda
  • Date: 2014-05-24 15:15:11 UTC
  • Revision ID: pauvitk@gmail.com-20140524151511-3vtr0uubjewx3z2j
Initial commit of source code and Debian packaging.

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>UDisks Reference Manual: UDisksLinuxDriveAta</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="UDisks Reference Manual">
 
8
<link rel="up" href="ref-daemon-drives.html" title="Drives on Linux">
 
9
<link rel="prev" href="UDisksLinuxDrive.html" title="UDisksLinuxDrive">
 
10
<link rel="next" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject">
 
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
 
18
                  <a href="#UDisksLinuxDriveAta.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
 
19
                  <a href="#UDisksLinuxDriveAta.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 
 
20
                  <a href="#UDisksLinuxDriveAta.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
 
21
</td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
23
<td><a accesskey="u" href="ref-daemon-drives.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
24
<td><a accesskey="p" href="UDisksLinuxDrive.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
25
<td><a accesskey="n" href="UDisksLinuxDriveObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
26
</tr></table>
 
27
<div class="refentry">
 
28
<a name="UDisksLinuxDriveAta"></a><div class="titlepage"></div>
 
29
<div class="refnamediv"><table width="100%"><tr>
 
30
<td valign="top">
 
31
<h2><span class="refentrytitle"><a name="UDisksLinuxDriveAta.top_of_page"></a>UDisksLinuxDriveAta</span></h2>
 
32
<p>UDisksLinuxDriveAta — Linux implementation of <a class="link" href="UDisksDriveAta.html" title="UDisksDriveAta"><span class="type">UDisksDriveAta</span></a></p>
 
33
</td>
 
34
<td class="gallery_image" valign="top" align="right"></td>
 
35
</tr></table></div>
 
36
<div class="refsect1">
 
37
<a name="UDisksLinuxDriveAta.functions"></a><h2>Functions</h2>
 
38
<div class="informaltable"><table width="100%" border="0">
 
39
<colgroup>
 
40
<col width="150px" class="functions_return">
 
41
<col class="functions_name">
 
42
</colgroup>
 
43
<tbody>
 
44
<tr>
 
45
<td class="function_type">
 
46
<a class="link" href="UDisksDriveAta.html" title="UDisksDriveAta"><span class="returnvalue">UDisksDriveAta</span></a> *
 
47
</td>
 
48
<td class="function_name">
 
49
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-new" title="udisks_linux_drive_ata_new ()">udisks_linux_drive_ata_new</a> <span class="c_punctuation">()</span>
 
50
</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="function_type">
 
54
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
55
</td>
 
56
<td class="function_name">
 
57
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-update" title="udisks_linux_drive_ata_update ()">udisks_linux_drive_ata_update</a> <span class="c_punctuation">()</span>
 
58
</td>
 
59
</tr>
 
60
<tr>
 
61
<td class="function_type">
 
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
63
</td>
 
64
<td class="function_name">
 
65
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-refresh-smart-sync" title="udisks_linux_drive_ata_refresh_smart_sync ()">udisks_linux_drive_ata_refresh_smart_sync</a> <span class="c_punctuation">()</span>
 
66
</td>
 
67
</tr>
 
68
<tr>
 
69
<td class="function_type">
 
70
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
71
</td>
 
72
<td class="function_name">
 
73
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-smart-selftest-sync" title="udisks_linux_drive_ata_smart_selftest_sync ()">udisks_linux_drive_ata_smart_selftest_sync</a> <span class="c_punctuation">()</span>
 
74
</td>
 
75
</tr>
 
76
<tr>
 
77
<td class="function_type">
 
78
<span class="returnvalue">void</span>
 
79
</td>
 
80
<td class="function_name">
 
81
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-apply-configuration" title="udisks_linux_drive_ata_apply_configuration ()">udisks_linux_drive_ata_apply_configuration</a> <span class="c_punctuation">()</span>
 
82
</td>
 
83
</tr>
 
84
<tr>
 
85
<td class="function_type">
 
86
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
87
</td>
 
88
<td class="function_name">
 
89
<a class="link" href="UDisksLinuxDriveAta.html#udisks-linux-drive-ata-secure-erase-sync" title="udisks_linux_drive_ata_secure_erase_sync ()">udisks_linux_drive_ata_secure_erase_sync</a> <span class="c_punctuation">()</span>
 
90
</td>
 
91
</tr>
 
92
</tbody>
 
93
</table></div>
 
94
</div>
 
95
<div class="refsect1">
 
96
<a name="UDisksLinuxDriveAta.other"></a><h2>Types and Values</h2>
 
97
<div class="informaltable"><table width="100%" border="0">
 
98
<colgroup>
 
99
<col width="150px" class="name">
 
100
<col class="description">
 
101
</colgroup>
 
102
<tbody><tr>
 
103
<td class="datatype_keyword"> </td>
 
104
<td class="function_name"><a class="link" href="UDisksLinuxDriveAta.html#UDisksLinuxDriveAta-struct" title="UDisksLinuxDriveAta">UDisksLinuxDriveAta</a></td>
 
105
</tr></tbody>
 
106
</table></div>
 
107
</div>
 
108
<div class="refsect1">
 
109
<a name="UDisksLinuxDriveAta.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
110
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
111
    <span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gio/unstable/GDBusInterfaceSkeleton.html">GDBusInterfaceSkeleton</a>
 
112
        <span class="lineart">╰──</span> <a class="link" href="UDisksDriveAta.html#UDisksDriveAtaSkeleton">UDisksDriveAtaSkeleton</a>
 
113
            <span class="lineart">╰──</span> UDisksLinuxDriveAta
 
114
</pre>
 
115
</div>
 
116
<div class="refsect1">
 
117
<a name="UDisksLinuxDriveAta.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
118
<p>
 
119
UDisksLinuxDriveAta implements
 
120
 <a href="http://library.gnome.org/devel/gio/unstable/GDBusInterface.html">GDBusInterface</a> and  <a class="link" href="UDisksDriveAta.html" title="UDisksDriveAta">UDisksDriveAta</a>.</p>
 
121
</div>
 
122
<div class="refsect1">
 
123
<a name="UDisksLinuxDriveAta.description"></a><h2>Description</h2>
 
124
<p>This type provides an implementation of the <a class="link" href="UDisksDriveAta.html" title="UDisksDriveAta"><span class="type">UDisksDriveAta</span></a>
 
125
interface on Linux.</p>
 
126
</div>
 
127
<div class="refsect1">
 
128
<a name="UDisksLinuxDriveAta.functions_details"></a><h2>Functions</h2>
 
129
<div class="refsect2">
 
130
<a name="udisks-linux-drive-ata-new"></a><h3>udisks_linux_drive_ata_new ()</h3>
 
131
<pre class="programlisting"><a class="link" href="UDisksDriveAta.html" title="UDisksDriveAta"><span class="returnvalue">UDisksDriveAta</span></a> *
 
132
udisks_linux_drive_ata_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
133
<p>Creates a new <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> instance.</p>
 
134
<div class="refsect3">
 
135
<a name="id-1.5.6.3.8.2.5"></a><h4>Returns</h4>
 
136
<p> A new <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a>. Free with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.</p>
 
137
<p></p>
 
138
</div>
 
139
</div>
 
140
<hr>
 
141
<div class="refsect2">
 
142
<a name="udisks-linux-drive-ata-update"></a><h3>udisks_linux_drive_ata_update ()</h3>
 
143
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
144
udisks_linux_drive_ata_update (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> *drive</code></em>,
 
145
                               <em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>);</pre>
 
146
<p>Updates the interface.</p>
 
147
<div class="refsect3">
 
148
<a name="id-1.5.6.3.8.3.5"></a><h4>Parameters</h4>
 
149
<div class="informaltable"><table width="100%" border="0">
 
150
<colgroup>
 
151
<col width="150px" class="parameters_name">
 
152
<col class="parameters_description">
 
153
<col width="200px" class="parameters_annotations">
 
154
</colgroup>
 
155
<tbody>
 
156
<tr>
 
157
<td class="parameter_name"><p>drive</p></td>
 
158
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a>.</p></td>
 
159
<td class="parameter_annotations"> </td>
 
160
</tr>
 
161
<tr>
 
162
<td class="parameter_name"><p>object</p></td>
 
163
<td class="parameter_description"><p>The enclosing <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> instance.</p></td>
 
164
<td class="parameter_annotations"> </td>
 
165
</tr>
 
166
</tbody>
 
167
</table></div>
 
168
</div>
 
169
<div class="refsect3">
 
170
<a name="id-1.5.6.3.8.3.6"></a><h4>Returns</h4>
 
171
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if configuration has changed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 
172
<p></p>
 
173
</div>
 
174
</div>
 
175
<hr>
 
176
<div class="refsect2">
 
177
<a name="udisks-linux-drive-ata-refresh-smart-sync"></a><h3>udisks_linux_drive_ata_refresh_smart_sync ()</h3>
 
178
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
179
udisks_linux_drive_ata_refresh_smart_sync
 
180
                               (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> *drive</code></em>,
 
181
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> nowakeup</code></em>,
 
182
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *simulate_path</code></em>,
 
183
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
184
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
185
<p>Synchronously refreshes ATA S.M.A.R.T. data on <em class="parameter"><code>drive</code></em>
 
186
 using one of
 
187
the physical drives associated with it. The calling thread is
 
188
blocked until the data has been obtained.</p>
 
189
<p>If <em class="parameter"><code>nowake</code></em>
 
190
 is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and the disk is in a sleep state this fails
 
191
with <a class="link" href="udisks2-UDisksError.html#UDISKS-ERROR-WOULD-WAKEUP:CAPS"><code class="literal">UDISKS_ERROR_WOULD_WAKEUP</code></a>.</p>
 
192
<p>This may only be called if <em class="parameter"><code>drive</code></em>
 
193
 has been associated with a
 
194
<a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> instance.</p>
 
195
<p>This method may be called from any thread.</p>
 
196
<div class="refsect3">
 
197
<a name="id-1.5.6.3.8.4.8"></a><h4>Parameters</h4>
 
198
<div class="informaltable"><table width="100%" border="0">
 
199
<colgroup>
 
200
<col width="150px" class="parameters_name">
 
201
<col class="parameters_description">
 
202
<col width="200px" class="parameters_annotations">
 
203
</colgroup>
 
204
<tbody>
 
205
<tr>
 
206
<td class="parameter_name"><p>drive</p></td>
 
207
<td class="parameter_description"><p>The <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> to refresh.</p></td>
 
208
<td class="parameter_annotations"> </td>
 
209
</tr>
 
210
<tr>
 
211
<td class="parameter_name"><p>nowakeup</p></td>
 
212
<td class="parameter_description"><p>If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, will not wake up the disk if asleep.</p></td>
 
213
<td class="parameter_annotations"> </td>
 
214
</tr>
 
215
<tr>
 
216
<td class="parameter_name"><p>simulate_path</p></td>
 
217
<td class="parameter_description"><p>If not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the path of a file with a libatasmart blob to use.</p></td>
 
218
<td class="parameter_annotations"> </td>
 
219
</tr>
 
220
<tr>
 
221
<td class="parameter_name"><p>cancellable</p></td>
 
222
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
223
<td class="parameter_annotations"> </td>
 
224
</tr>
 
225
<tr>
 
226
<td class="parameter_name"><p>error</p></td>
 
227
<td class="parameter_description"><p>Return location for error.</p></td>
 
228
<td class="parameter_annotations"> </td>
 
229
</tr>
 
230
</tbody>
 
231
</table></div>
 
232
</div>
 
233
<div class="refsect3">
 
234
<a name="id-1.5.6.3.8.4.9"></a><h4>Returns</h4>
 
235
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the operation succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>error</code></em>
 
236
is set.</p>
 
237
<p></p>
 
238
</div>
 
239
</div>
 
240
<hr>
 
241
<div class="refsect2">
 
242
<a name="udisks-linux-drive-ata-smart-selftest-sync"></a><h3>udisks_linux_drive_ata_smart_selftest_sync ()</h3>
 
243
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
244
udisks_linux_drive_ata_smart_selftest_sync
 
245
                               (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> *drive</code></em>,
 
246
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 
247
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
248
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
249
<p>Starts (or aborts) a SMART self-test on <em class="parameter"><code>drive</code></em>
 
250
. Valid values for
 
251
<em class="parameter"><code>type</code></em>
 
252
 includes 'short', 'extended', 'conveyance' and 'abort'.</p>
 
253
<p>The calling thread is blocked while sending the command to the
 
254
drive but will return immediately after the drive acknowledges the
 
255
command.</p>
 
256
<div class="refsect3">
 
257
<a name="id-1.5.6.3.8.5.6"></a><h4>Parameters</h4>
 
258
<div class="informaltable"><table width="100%" border="0">
 
259
<colgroup>
 
260
<col width="150px" class="parameters_name">
 
261
<col class="parameters_description">
 
262
<col width="200px" class="parameters_annotations">
 
263
</colgroup>
 
264
<tbody>
 
265
<tr>
 
266
<td class="parameter_name"><p>drive</p></td>
 
267
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a>.</p></td>
 
268
<td class="parameter_annotations"> </td>
 
269
</tr>
 
270
<tr>
 
271
<td class="parameter_name"><p>type</p></td>
 
272
<td class="parameter_description"><p>The type of selftest to run.</p></td>
 
273
<td class="parameter_annotations"> </td>
 
274
</tr>
 
275
<tr>
 
276
<td class="parameter_name"><p>cancellable</p></td>
 
277
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> that can be used to cancel the operation or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
278
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
 
279
</tr>
 
280
<tr>
 
281
<td class="parameter_name"><p>error</p></td>
 
282
<td class="parameter_description"><p>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
283
<td class="parameter_annotations"> </td>
 
284
</tr>
 
285
</tbody>
 
286
</table></div>
 
287
</div>
 
288
<div class="refsect3">
 
289
<a name="id-1.5.6.3.8.5.7"></a><h4>Returns</h4>
 
290
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the operation succeed, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>error</code></em>
 
291
is set.</p>
 
292
<p></p>
 
293
</div>
 
294
</div>
 
295
<hr>
 
296
<div class="refsect2">
 
297
<a name="udisks-linux-drive-ata-apply-configuration"></a><h3>udisks_linux_drive_ata_apply_configuration ()</h3>
 
298
<pre class="programlisting"><span class="returnvalue">void</span>
 
299
udisks_linux_drive_ata_apply_configuration
 
300
                               (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> *drive</code></em>,
 
301
                                <em class="parameter"><code><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device</code></em>,
 
302
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *configuration</code></em>);</pre>
 
303
<p>Spawns a thread to apply <em class="parameter"><code>configuration</code></em>
 
304
 to <em class="parameter"><code>drive</code></em>
 
305
, if any. Does not
 
306
wait for the thread to terminate.</p>
 
307
<div class="refsect3">
 
308
<a name="id-1.5.6.3.8.6.5"></a><h4>Parameters</h4>
 
309
<div class="informaltable"><table width="100%" border="0">
 
310
<colgroup>
 
311
<col width="150px" class="parameters_name">
 
312
<col class="parameters_description">
 
313
<col width="200px" class="parameters_annotations">
 
314
</colgroup>
 
315
<tbody>
 
316
<tr>
 
317
<td class="parameter_name"><p>drive</p></td>
 
318
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a>.</p></td>
 
319
<td class="parameter_annotations"> </td>
 
320
</tr>
 
321
<tr>
 
322
<td class="parameter_name"><p>device</p></td>
 
323
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a></p></td>
 
324
<td class="parameter_annotations"> </td>
 
325
</tr>
 
326
<tr>
 
327
<td class="parameter_name"><p>configuration</p></td>
 
328
<td class="parameter_description"><p>The configuration to apply.</p></td>
 
329
<td class="parameter_annotations"> </td>
 
330
</tr>
 
331
</tbody>
 
332
</table></div>
 
333
</div>
 
334
</div>
 
335
<hr>
 
336
<div class="refsect2">
 
337
<a name="udisks-linux-drive-ata-secure-erase-sync"></a><h3>udisks_linux_drive_ata_secure_erase_sync ()</h3>
 
338
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
339
udisks_linux_drive_ata_secure_erase_sync
 
340
                               (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> *drive</code></em>,
 
341
                                <em class="parameter"><code><span class="type">uid_t</span> caller_uid</code></em>,
 
342
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enhanced</code></em>,
 
343
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
344
<p>Performs an ATA Secure Erase opeartion. Blocks the calling thread until the operation completes.</p>
 
345
<p>This operation may take a very long time (hours) to complete.</p>
 
346
<div class="refsect3">
 
347
<a name="id-1.5.6.3.8.7.6"></a><h4>Parameters</h4>
 
348
<div class="informaltable"><table width="100%" border="0">
 
349
<colgroup>
 
350
<col width="150px" class="parameters_name">
 
351
<col class="parameters_description">
 
352
<col width="200px" class="parameters_annotations">
 
353
</colgroup>
 
354
<tbody>
 
355
<tr>
 
356
<td class="parameter_name"><p>drive</p></td>
 
357
<td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a>.</p></td>
 
358
<td class="parameter_annotations"> </td>
 
359
</tr>
 
360
<tr>
 
361
<td class="parameter_name"><p>caller_uid</p></td>
 
362
<td class="parameter_description"><p>The unix user if of the caller requesting the operation.</p></td>
 
363
<td class="parameter_annotations"> </td>
 
364
</tr>
 
365
<tr>
 
366
<td class="parameter_name"><p>enhanced</p></td>
 
367
<td class="parameter_description"><p><a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to use the enhanced version of the ATA secure erase command.</p></td>
 
368
<td class="parameter_annotations"> </td>
 
369
</tr>
 
370
<tr>
 
371
<td class="parameter_name"><p>error</p></td>
 
372
<td class="parameter_description"><p>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
 
373
<td class="parameter_annotations"> </td>
 
374
</tr>
 
375
</tbody>
 
376
</table></div>
 
377
</div>
 
378
<div class="refsect3">
 
379
<a name="id-1.5.6.3.8.7.7"></a><h4>Returns</h4>
 
380
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the operation succeeded, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if <em class="parameter"><code>error</code></em>
 
381
is set.</p>
 
382
<p></p>
 
383
</div>
 
384
</div>
 
385
</div>
 
386
<div class="refsect1">
 
387
<a name="UDisksLinuxDriveAta.other_details"></a><h2>Types and Values</h2>
 
388
<div class="refsect2">
 
389
<a name="UDisksLinuxDriveAta-struct"></a><h3>UDisksLinuxDriveAta</h3>
 
390
<pre class="programlisting">typedef struct _UDisksLinuxDriveAta UDisksLinuxDriveAta;</pre>
 
391
<p>The <a class="link" href="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta"><span class="type">UDisksLinuxDriveAta</span></a> structure contains only private data and should
 
392
only be accessed using the provided API.</p>
 
393
</div>
 
394
</div>
 
395
</div>
 
396
<div class="footer">
 
397
<hr>
 
398
          Generated by GTK-Doc V1.20</div>
 
399
</body>
 
400
</html>
 
 
b'\\ No newline at end of file'