Debian Codegraph @

doc/html/UDisksLinuxDriveObject.html

raw
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>UDisksLinuxDriveObject: UDisks Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
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="UDisksLinuxDriveAta.html" title="UDisksLinuxDriveAta">
10 <link rel="next" href="UDisksLinuxNVMeController.html" title="UDisksLinuxNVMeController">
11 <meta name="generator" content="GTK-Doc V1.35.1 (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="5"><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="#UDisksLinuxDriveObject.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#UDisksLinuxDriveObject.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
20 <a href="#UDisksLinuxDriveObject.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
21 <a href="#UDisksLinuxDriveObject.properties" class="shortcut">Properties</a></span>
22 </td>
23 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24 <td><a accesskey="u" href="ref-daemon-drives.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25 <td><a accesskey="p" href="UDisksLinuxDriveAta.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26 <td><a accesskey="n" href="UDisksLinuxNVMeController.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27 </tr></table>
28 <div class="refentry">
29 <a name="UDisksLinuxDriveObject"></a><div class="titlepage"></div>
30 <div class="refnamediv"><table width="100%"><tr>
31 <td valign="top">
32 <h2><span class="refentrytitle"><a name="UDisksLinuxDriveObject.top_of_page"></a>UDisksLinuxDriveObject</span></h2>
33 <p>UDisksLinuxDriveObject — Object representing a drive on Linux</p>
34 </td>
35 <td class="gallery_image" valign="top" align="right"></td>
36 </tr></table></div>
37 <div class="refsect1">
38 <a name="UDisksLinuxDriveObject.functions"></a><h2>Functions</h2>
39 <div class="informaltable"><table class="informaltable" width="100%" border="0">
40 <colgroup>
41 <col width="150px" class="functions_proto_type">
42 <col class="functions_proto_name">
43 </colgroup>
44 <tbody>
45 <tr>
46 <td class="function_type">
47 <span class="returnvalue">gboolean</span>
48 </td>
49 <td class="function_name">
50 <span class="c_punctuation">(</span><a class="link" href="UDisksLinuxDriveObject.html#UDisksObjectHasInterfaceFunc" title="UDisksObjectHasInterfaceFunc ()">*UDisksObjectHasInterfaceFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
51 </td>
52 </tr>
53 <tr>
54 <td class="function_type">
55 <span class="returnvalue">void</span>
56 </td>
57 <td class="function_name">
58 <span class="c_punctuation">(</span><a class="link" href="UDisksLinuxDriveObject.html#UDisksObjectConnectInterfaceFunc" title="UDisksObjectConnectInterfaceFunc ()">*UDisksObjectConnectInterfaceFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
59 </td>
60 </tr>
61 <tr>
62 <td class="function_type">
63 <span class="returnvalue">gboolean</span>
64 </td>
65 <td class="function_name">
66 <span class="c_punctuation">(</span><a class="link" href="UDisksLinuxDriveObject.html#UDisksObjectUpdateInterfaceFunc" title="UDisksObjectUpdateInterfaceFunc ()">*UDisksObjectUpdateInterfaceFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
67 </td>
68 </tr>
69 <tr>
70 <td class="function_type">
71 <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="returnvalue">UDisksLinuxDriveObject</span></a> *
72 </td>
73 <td class="function_name">
74 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-new" title="udisks_linux_drive_object_new ()">udisks_linux_drive_object_new</a> <span class="c_punctuation">()</span>
75 </td>
76 </tr>
77 <tr>
78 <td class="function_type">
79 <span class="returnvalue">void</span>
80 </td>
81 <td class="function_name">
82 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-uevent" title="udisks_linux_drive_object_uevent ()">udisks_linux_drive_object_uevent</a> <span class="c_punctuation">()</span>
83 </td>
84 </tr>
85 <tr>
86 <td class="function_type">
87 <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> *
88 </td>
89 <td class="function_name">
90 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-get-daemon" title="udisks_linux_drive_object_get_daemon ()">udisks_linux_drive_object_get_daemon</a> <span class="c_punctuation">()</span>
91 </td>
92 </tr>
93 <tr>
94 <td class="function_type">
95 <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="returnvalue">UDisksLinuxBlockObject</span></a> *
96 </td>
97 <td class="function_name">
98 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-get-block" title="udisks_linux_drive_object_get_block ()">udisks_linux_drive_object_get_block</a> <span class="c_punctuation">()</span>
99 </td>
100 </tr>
101 <tr>
102 <td class="function_type">
103 <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="returnvalue">UDisksLinuxDevice</span></a> *
104 </td>
105 <td class="function_name">
106 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-get-device" title="udisks_linux_drive_object_get_device ()">udisks_linux_drive_object_get_device</a> <span class="c_punctuation">()</span>
107 </td>
108 </tr>
109 <tr>
110 <td class="function_type">
111 <span class="returnvalue">GList</span> *
112 </td>
113 <td class="function_name">
114 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-get-devices" title="udisks_linux_drive_object_get_devices ()">udisks_linux_drive_object_get_devices</a> <span class="c_punctuation">()</span>
115 </td>
116 </tr>
117 <tr>
118 <td class="function_type">
119 <span class="returnvalue">GList</span> *
120 </td>
121 <td class="function_name">
122 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-get-siblings" title="udisks_linux_drive_object_get_siblings ()">udisks_linux_drive_object_get_siblings</a> <span class="c_punctuation">()</span>
123 </td>
124 </tr>
125 <tr>
126 <td class="function_type">
127 <span class="returnvalue">gboolean</span>
128 </td>
129 <td class="function_name">
130 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-housekeeping" title="udisks_linux_drive_object_housekeeping ()">udisks_linux_drive_object_housekeeping</a> <span class="c_punctuation">()</span>
131 </td>
132 </tr>
133 <tr>
134 <td class="function_type">
135 <span class="returnvalue">gboolean</span>
136 </td>
137 <td class="function_name">
138 <a class="link" href="UDisksLinuxDriveObject.html#udisks-linux-drive-object-is-not-in-use" title="udisks_linux_drive_object_is_not_in_use ()">udisks_linux_drive_object_is_not_in_use</a> <span class="c_punctuation">()</span>
139 </td>
140 </tr>
141 </tbody>
142 </table></div>
143 </div>
144 <div class="refsect1">
145 <a name="UDisksLinuxDriveObject.properties"></a><h2>Properties</h2>
146 <div class="informaltable"><table class="informaltable" border="0">
147 <colgroup>
148 <col width="150px" class="properties_type">
149 <col width="300px" class="properties_name">
150 <col width="200px" class="properties_flags">
151 </colgroup>
152 <tbody>
153 <tr>
154 <td class="property_type">
155 <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *</td>
156 <td class="property_name"><a class="link" href="UDisksLinuxDriveObject.html#UDisksLinuxDriveObject--daemon" title="The “daemon” property">daemon</a></td>
157 <td class="property_flags">Read / Write / Construct Only</td>
158 </tr>
159 <tr>
160 <td class="property_type">
161 <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *</td>
162 <td class="property_name"><a class="link" href="UDisksLinuxDriveObject.html#UDisksLinuxDriveObject--device" title="The “device” property">device</a></td>
163 <td class="property_flags">Write / Construct Only</td>
164 </tr>
165 </tbody>
166 </table></div>
167 </div>
168 <div class="refsect1">
169 <a name="UDisksLinuxDriveObject.other"></a><h2>Types and Values</h2>
170 <div class="informaltable"><table class="informaltable" width="100%" border="0">
171 <colgroup>
172 <col width="150px" class="other_proto_type">
173 <col class="other_proto_name">
174 </colgroup>
175 <tbody><tr>
176 <td class="datatype_keyword"> </td>
177 <td class="function_name"><a class="link" href="UDisksLinuxDriveObject.html#UDisksLinuxDriveObject-struct" title="UDisksLinuxDriveObject">UDisksLinuxDriveObject</a></td>
178 </tr></tbody>
179 </table></div>
180 </div>
181 <div class="refsect1">
182 <a name="UDisksLinuxDriveObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
183 <pre class="screen"> GObject
184 <span class="lineart">╰──</span> GDBusObjectSkeleton
185 <span class="lineart">╰──</span> <a class="link" href="UDisksObject.html#UDisksObjectSkeleton">UDisksObjectSkeleton</a>
186 <span class="lineart">╰──</span> UDisksLinuxDriveObject
187 </pre>
188 </div>
189 <div class="refsect1">
190 <a name="UDisksLinuxDriveObject.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
191 <p>
192 UDisksLinuxDriveObject implements
193 GDBusObject and <a class="link" href="UDisksObject.html" title="UDisksObject">UDisksObject</a>.</p>
194 </div>
195 <div class="refsect1">
196 <a name="UDisksLinuxDriveObject.description"></a><h2>Description</h2>
197 <p>Object corresponding to a drive on Linux.</p>
198 </div>
199 <div class="refsect1">
200 <a name="UDisksLinuxDriveObject.functions_details"></a><h2>Functions</h2>
201 <div class="refsect2">
202 <a name="UDisksObjectHasInterfaceFunc"></a><h3>UDisksObjectHasInterfaceFunc ()</h3>
203 <pre class="programlisting"><span class="returnvalue">gboolean</span>
204 <span class="c_punctuation">(</span>*UDisksObjectHasInterfaceFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> *object</code></em>);</pre>
205 <p>Function prototype that is used to determine whether the <em class="parameter"><code>object</code></em>
206 is applicable
207 for carrying a particular D-Bus interface (determined by the callback function itself).</p>
208 <p>Used typically over <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> and <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>
209 objects for checking specific feature that leads to exporting extra D-Bus
210 interface on the object.</p>
211 <div class="refsect3">
212 <a name="UDisksObjectHasInterfaceFunc.parameters"></a><h4>Parameters</h4>
213 <div class="informaltable"><table class="informaltable" width="100%" border="0">
214 <colgroup>
215 <col width="150px" class="parameters_name">
216 <col class="parameters_description">
217 <col width="200px" class="parameters_annotations">
218 </colgroup>
219 <tbody><tr>
220 <td class="parameter_name"><p>object</p></td>
221 <td class="parameter_description"><p>A <a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> to consider.</p></td>
222 <td class="parameter_annotations"> </td>
223 </tr></tbody>
224 </table></div>
225 </div>
226 <div class="refsect3">
227 <a name="UDisksObjectHasInterfaceFunc.returns"></a><h4>Returns</h4>
228 <p> <code class="literal">TRUE</code> if the <em class="parameter"><code>object</code></em>
229 is a valid candidate for the particular D-Bus interface, <code class="literal">FALSE</code> otherwise.</p>
230 </div>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="UDisksObjectConnectInterfaceFunc"></a><h3>UDisksObjectConnectInterfaceFunc ()</h3>
235 <pre class="programlisting"><span class="returnvalue">void</span>
236 <span class="c_punctuation">(</span>*UDisksObjectConnectInterfaceFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> *object</code></em>);</pre>
237 <p>Function prototype that is used once a new D-Bus interface is created (meaning
238 the <a class="link" href="UDisksLinuxDriveObject.html#UDisksObjectHasInterfaceFunc" title="UDisksObjectHasInterfaceFunc ()"><span class="type">UDisksObjectHasInterfaceFunc</span></a> call was successful) to perform optional
239 additional tasks before the interface is exported on the <em class="parameter"><code>object</code></em>
240 .</p>
241 <p>Used typically over <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> and <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> objects.</p>
242 <div class="refsect3">
243 <a name="UDisksObjectConnectInterfaceFunc.parameters"></a><h4>Parameters</h4>
244 <div class="informaltable"><table class="informaltable" width="100%" border="0">
245 <colgroup>
246 <col width="150px" class="parameters_name">
247 <col class="parameters_description">
248 <col width="200px" class="parameters_annotations">
249 </colgroup>
250 <tbody><tr>
251 <td class="parameter_name"><p>object</p></td>
252 <td class="parameter_description"><p>A <a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> to perform connection operation onto.</p></td>
253 <td class="parameter_annotations"> </td>
254 </tr></tbody>
255 </table></div>
256 </div>
257 </div>
258 <hr>
259 <div class="refsect2">
260 <a name="UDisksObjectUpdateInterfaceFunc"></a><h3>UDisksObjectUpdateInterfaceFunc ()</h3>
261 <pre class="programlisting"><span class="returnvalue">gboolean</span>
262 <span class="c_punctuation">(</span>*UDisksObjectUpdateInterfaceFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a> *object</code></em>,
263 <em class="parameter"><code>const <span class="type">gchar</span> *uevent_action</code></em>,
264 <em class="parameter"><code><span class="type">GDBusInterface</span> *interface</code></em>);</pre>
265 <p>Function prototype that is used on existing <em class="parameter"><code>interface</code></em>
266 on the <em class="parameter"><code>object</code></em>
267 to process
268 incoming uevents.</p>
269 <p>Used typically over <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> and <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> objects.</p>
270 <div class="refsect3">
271 <a name="UDisksObjectUpdateInterfaceFunc.parameters"></a><h4>Parameters</h4>
272 <div class="informaltable"><table class="informaltable" width="100%" border="0">
273 <colgroup>
274 <col width="150px" class="parameters_name">
275 <col class="parameters_description">
276 <col width="200px" class="parameters_annotations">
277 </colgroup>
278 <tbody>
279 <tr>
280 <td class="parameter_name"><p>object</p></td>
281 <td class="parameter_description"><p>A <a class="link" href="UDisksObject.html" title="UDisksObject"><span class="type">UDisksObject</span></a>.</p></td>
282 <td class="parameter_annotations"> </td>
283 </tr>
284 <tr>
285 <td class="parameter_name"><p>uevent_action</p></td>
286 <td class="parameter_description"><p>An uevent action string.</p></td>
287 <td class="parameter_annotations"> </td>
288 </tr>
289 <tr>
290 <td class="parameter_name"><p>interface</p></td>
291 <td class="parameter_description"><p>Existing <span class="type">GDBusInterface</span> exported on the <em class="parameter"><code>object</code></em>
292 .</p></td>
293 <td class="parameter_annotations"> </td>
294 </tr>
295 </tbody>
296 </table></div>
297 </div>
298 <div class="refsect3">
299 <a name="UDisksObjectUpdateInterfaceFunc.returns"></a><h4>Returns</h4>
300 <p> <code class="literal">TRUE</code> if configuration (properties) on the interface have changed, <code class="literal">FALSE</code> otherwise.</p>
301 </div>
302 </div>
303 <hr>
304 <div class="refsect2">
305 <a name="udisks-linux-drive-object-new"></a><h3>udisks_linux_drive_object_new ()</h3>
306 <pre class="programlisting"><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="returnvalue">UDisksLinuxDriveObject</span></a> *
307 udisks_linux_drive_object_new (<em class="parameter"><code><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *daemon</code></em>,
308 <em class="parameter"><code><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device</code></em>);</pre>
309 <p>Create a new drive object.</p>
310 <div class="refsect3">
311 <a name="udisks-linux-drive-object-new.parameters"></a><h4>Parameters</h4>
312 <div class="informaltable"><table class="informaltable" width="100%" border="0">
313 <colgroup>
314 <col width="150px" class="parameters_name">
315 <col class="parameters_description">
316 <col width="200px" class="parameters_annotations">
317 </colgroup>
318 <tbody>
319 <tr>
320 <td class="parameter_name"><p>daemon</p></td>
321 <td class="parameter_description"><p>A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>.</p></td>
322 <td class="parameter_annotations"> </td>
323 </tr>
324 <tr>
325 <td class="parameter_name"><p>device</p></td>
326 <td class="parameter_description"><p>The <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> for the sysfs block device.</p></td>
327 <td class="parameter_annotations"> </td>
328 </tr>
329 </tbody>
330 </table></div>
331 </div>
332 <div class="refsect3">
333 <a name="udisks-linux-drive-object-new.returns"></a><h4>Returns</h4>
334 <p> A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> object or <code class="literal">NULL</code> if <em class="parameter"><code>device</code></em>
335 does not represent a drive. Free with <code class="function">g_object_unref()</code>.</p>
336 </div>
337 </div>
338 <hr>
339 <div class="refsect2">
340 <a name="udisks-linux-drive-object-uevent"></a><h3>udisks_linux_drive_object_uevent ()</h3>
341 <pre class="programlisting"><span class="returnvalue">void</span>
342 udisks_linux_drive_object_uevent (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>,
343 <em class="parameter"><code>const <span class="type">gchar</span> *action</code></em>,
344 <em class="parameter"><code><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *device</code></em>);</pre>
345 <p>Updates all information on interfaces on <em class="parameter"><code>drive</code></em>
346 .</p>
347 <div class="refsect3">
348 <a name="udisks-linux-drive-object-uevent.parameters"></a><h4>Parameters</h4>
349 <div class="informaltable"><table class="informaltable" width="100%" border="0">
350 <colgroup>
351 <col width="150px" class="parameters_name">
352 <col class="parameters_description">
353 <col width="200px" class="parameters_annotations">
354 </colgroup>
355 <tbody>
356 <tr>
357 <td class="parameter_name"><p>object</p></td>
358 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
359 <td class="parameter_annotations"> </td>
360 </tr>
361 <tr>
362 <td class="parameter_name"><p>action</p></td>
363 <td class="parameter_description"><p>Uevent action or <code class="literal">NULL</code></p></td>
364 <td class="parameter_annotations"> </td>
365 </tr>
366 <tr>
367 <td class="parameter_name"><p>device</p></td>
368 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> device object or <code class="literal">NULL</code> if the device hasn't changed.</p></td>
369 <td class="parameter_annotations"> </td>
370 </tr>
371 </tbody>
372 </table></div>
373 </div>
374 </div>
375 <hr>
376 <div class="refsect2">
377 <a name="udisks-linux-drive-object-get-daemon"></a><h3>udisks_linux_drive_object_get_daemon ()</h3>
378 <pre class="programlisting"><a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="returnvalue">UDisksDaemon</span></a> *
379 udisks_linux_drive_object_get_daemon (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>);</pre>
380 <p>Gets the daemon used by <em class="parameter"><code>object</code></em>
381 .</p>
382 <div class="refsect3">
383 <a name="udisks-linux-drive-object-get-daemon.parameters"></a><h4>Parameters</h4>
384 <div class="informaltable"><table class="informaltable" width="100%" border="0">
385 <colgroup>
386 <col width="150px" class="parameters_name">
387 <col class="parameters_description">
388 <col width="200px" class="parameters_annotations">
389 </colgroup>
390 <tbody><tr>
391 <td class="parameter_name"><p>object</p></td>
392 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
393 <td class="parameter_annotations"> </td>
394 </tr></tbody>
395 </table></div>
396 </div>
397 <div class="refsect3">
398 <a name="udisks-linux-drive-object-get-daemon.returns"></a><h4>Returns</h4>
399 <p> A <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a>. Do not free, the object is owned by <em class="parameter"><code>object</code></em>
400 .</p>
401 </div>
402 </div>
403 <hr>
404 <div class="refsect2">
405 <a name="udisks-linux-drive-object-get-block"></a><h3>udisks_linux_drive_object_get_block ()</h3>
406 <pre class="programlisting"><a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="returnvalue">UDisksLinuxBlockObject</span></a> *
407 udisks_linux_drive_object_get_block (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>,
408 <em class="parameter"><code><span class="type">gboolean</span> get_hw</code></em>);</pre>
409 <p>Gets a <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> representing a block device associated with <em class="parameter"><code>object</code></em>
410 .</p>
411 <div class="refsect3">
412 <a name="udisks-linux-drive-object-get-block.parameters"></a><h4>Parameters</h4>
413 <div class="informaltable"><table class="informaltable" width="100%" border="0">
414 <colgroup>
415 <col width="150px" class="parameters_name">
416 <col class="parameters_description">
417 <col width="200px" class="parameters_annotations">
418 </colgroup>
419 <tbody>
420 <tr>
421 <td class="parameter_name"><p>object</p></td>
422 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
423 <td class="parameter_annotations"> </td>
424 </tr>
425 <tr>
426 <td class="parameter_name"><p>get_hw</p></td>
427 <td class="parameter_description"><p>If the drive is multipath, set to <code class="literal">TRUE</code> to get a path device instead of the multipath device.</p></td>
428 <td class="parameter_annotations"> </td>
429 </tr>
430 </tbody>
431 </table></div>
432 </div>
433 <div class="refsect3">
434 <a name="udisks-linux-drive-object-get-block.returns"></a><h4>Returns</h4>
435 <p> A <a class="link" href="UDisksLinuxBlockObject.html" title="UDisksLinuxBlockObject"><span class="type">UDisksLinuxBlockObject</span></a> or <code class="literal">NULL</code>. The returned object
436 must be freed with <code class="function">g_object_unref()</code>.</p>
437 </div>
438 </div>
439 <hr>
440 <div class="refsect2">
441 <a name="udisks-linux-drive-object-get-device"></a><h3>udisks_linux_drive_object_get_device ()</h3>
442 <pre class="programlisting"><a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="returnvalue">UDisksLinuxDevice</span></a> *
443 udisks_linux_drive_object_get_device (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>,
444 <em class="parameter"><code><span class="type">gboolean</span> get_hw</code></em>);</pre>
445 <p>Gets one of the <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> object associated with <em class="parameter"><code>object</code></em>
446 .</p>
447 <p>If <em class="parameter"><code>get_hw</code></em>
448 is <code class="literal">TRUE</code> and <em class="parameter"><code>object</code></em>
449 represents a multipath device then
450 one of the paths is returned rather than the multipath device. This
451 is useful if you e.g. need to configure the physical hardware.</p>
452 <div class="refsect3">
453 <a name="udisks-linux-drive-object-get-device.parameters"></a><h4>Parameters</h4>
454 <div class="informaltable"><table class="informaltable" width="100%" border="0">
455 <colgroup>
456 <col width="150px" class="parameters_name">
457 <col class="parameters_description">
458 <col width="200px" class="parameters_annotations">
459 </colgroup>
460 <tbody>
461 <tr>
462 <td class="parameter_name"><p>object</p></td>
463 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
464 <td class="parameter_annotations"> </td>
465 </tr>
466 <tr>
467 <td class="parameter_name"><p>get_hw</p></td>
468 <td class="parameter_description"><p>If the drive is multipath, set to <code class="literal">TRUE</code> to get a path device instead of the multipath device.</p></td>
469 <td class="parameter_annotations"> </td>
470 </tr>
471 </tbody>
472 </table></div>
473 </div>
474 <div class="refsect3">
475 <a name="udisks-linux-drive-object-get-device.returns"></a><h4>Returns</h4>
476 <p> A <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> or <code class="literal">NULL</code>. The returned object must be freed
477 with <code class="function">g_object_unref()</code>.</p>
478 </div>
479 </div>
480 <hr>
481 <div class="refsect2">
482 <a name="udisks-linux-drive-object-get-devices"></a><h3>udisks_linux_drive_object_get_devices ()</h3>
483 <pre class="programlisting"><span class="returnvalue">GList</span> *
484 udisks_linux_drive_object_get_devices (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>);</pre>
485 <p>Gets the current <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> objects associated with <em class="parameter"><code>object</code></em>
486 .</p>
487 <div class="refsect3">
488 <a name="udisks-linux-drive-object-get-devices.parameters"></a><h4>Parameters</h4>
489 <div class="informaltable"><table class="informaltable" width="100%" border="0">
490 <colgroup>
491 <col width="150px" class="parameters_name">
492 <col class="parameters_description">
493 <col width="200px" class="parameters_annotations">
494 </colgroup>
495 <tbody><tr>
496 <td class="parameter_name"><p>object</p></td>
497 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
498 <td class="parameter_annotations"> </td>
499 </tr></tbody>
500 </table></div>
501 </div>
502 <div class="refsect3">
503 <a name="udisks-linux-drive-object-get-devices.returns"></a><h4>Returns</h4>
504 <p> A list of <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> objects. Free each element with
505 <code class="function">g_object_unref()</code>, then free the list with <code class="function">g_list_free()</code>.</p>
506 </div>
507 </div>
508 <hr>
509 <div class="refsect2">
510 <a name="udisks-linux-drive-object-get-siblings"></a><h3>udisks_linux_drive_object_get_siblings ()</h3>
511 <pre class="programlisting"><span class="returnvalue">GList</span> *
512 udisks_linux_drive_object_get_siblings
513 (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>);</pre>
514 <p>Gets the siblings for <em class="parameter"><code>object</code></em>
515 , if any.</p>
516 <div class="refsect3">
517 <a name="udisks-linux-drive-object-get-siblings.parameters"></a><h4>Parameters</h4>
518 <div class="informaltable"><table class="informaltable" width="100%" border="0">
519 <colgroup>
520 <col width="150px" class="parameters_name">
521 <col class="parameters_description">
522 <col width="200px" class="parameters_annotations">
523 </colgroup>
524 <tbody><tr>
525 <td class="parameter_name"><p>object</p></td>
526 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
527 <td class="parameter_annotations"> </td>
528 </tr></tbody>
529 </table></div>
530 </div>
531 <div class="refsect3">
532 <a name="udisks-linux-drive-object-get-siblings.returns"></a><h4>Returns</h4>
533 <p>A list of <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>
534 instances. The returned list should be freed with <code class="function">g_list_free()</code> after each element has been
535 freed with <code class="function">g_object_unref()</code>. </p>
536 <p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> UDisksLinuxDriveObject]</span></p>
537 </div>
538 </div>
539 <hr>
540 <div class="refsect2">
541 <a name="udisks-linux-drive-object-housekeeping"></a><h3>udisks_linux_drive_object_housekeeping ()</h3>
542 <pre class="programlisting"><span class="returnvalue">gboolean</span>
543 udisks_linux_drive_object_housekeeping
544 (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>,
545 <em class="parameter"><code><span class="type">guint</span> secs_since_last</code></em>,
546 <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
547 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
548 <p>Called periodically (every ten minutes or so) to perform
549 housekeeping tasks such as refreshing ATA/NVMe SMART data.</p>
550 <p>The function runs in a dedicated thread and is allowed to perform
551 blocking I/O.</p>
552 <p>Long-running tasks should periodically check <em class="parameter"><code>cancellable</code></em>
553 to see if
554 they have been cancelled.</p>
555 <div class="refsect3">
556 <a name="udisks-linux-drive-object-housekeeping.parameters"></a><h4>Parameters</h4>
557 <div class="informaltable"><table class="informaltable" width="100%" border="0">
558 <colgroup>
559 <col width="150px" class="parameters_name">
560 <col class="parameters_description">
561 <col width="200px" class="parameters_annotations">
562 </colgroup>
563 <tbody>
564 <tr>
565 <td class="parameter_name"><p>object</p></td>
566 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
567 <td class="parameter_annotations"> </td>
568 </tr>
569 <tr>
570 <td class="parameter_name"><p>secs_since_last</p></td>
571 <td class="parameter_description"><p>Number of seconds since the last housekeeping or 0 if the first housekeeping ever.</p></td>
572 <td class="parameter_annotations"> </td>
573 </tr>
574 <tr>
575 <td class="parameter_name"><p>cancellable</p></td>
576 <td class="parameter_description"><p>A <code class="literal">GCancellable</code> or <code class="literal">NULL</code>.</p></td>
577 <td class="parameter_annotations"> </td>
578 </tr>
579 <tr>
580 <td class="parameter_name"><p>error</p></td>
581 <td class="parameter_description"><p>Return location for error or <code class="literal">NULL</code>.</p></td>
582 <td class="parameter_annotations"> </td>
583 </tr>
584 </tbody>
585 </table></div>
586 </div>
587 <div class="refsect3">
588 <a name="udisks-linux-drive-object-housekeeping.returns"></a><h4>Returns</h4>
589 <p> <code class="literal">TRUE</code> if the operation succeeded, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em>
590 is set.</p>
591 </div>
592 </div>
593 <hr>
594 <div class="refsect2">
595 <a name="udisks-linux-drive-object-is-not-in-use"></a><h3>udisks_linux_drive_object_is_not_in_use ()</h3>
596 <pre class="programlisting"><span class="returnvalue">gboolean</span>
597 udisks_linux_drive_object_is_not_in_use
598 (<em class="parameter"><code><a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> *object</code></em>,
599 <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
600 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
601 <p>Checks if the drive represented by <em class="parameter"><code>object</code></em>
602 is in use and sets
603 <em class="parameter"><code>error</code></em>
604 if so.</p>
605 <div class="refsect3">
606 <a name="udisks-linux-drive-object-is-not-in-use.parameters"></a><h4>Parameters</h4>
607 <div class="informaltable"><table class="informaltable" width="100%" border="0">
608 <colgroup>
609 <col width="150px" class="parameters_name">
610 <col class="parameters_description">
611 <col width="200px" class="parameters_annotations">
612 </colgroup>
613 <tbody>
614 <tr>
615 <td class="parameter_name"><p>object</p></td>
616 <td class="parameter_description"><p>A <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a>.</p></td>
617 <td class="parameter_annotations"> </td>
618 </tr>
619 <tr>
620 <td class="parameter_name"><p>cancellable</p></td>
621 <td class="parameter_description"><p>A <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </p></td>
622 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
623 </tr>
624 <tr>
625 <td class="parameter_name"><p>error</p></td>
626 <td class="parameter_description"><p>A <span class="type">GError</span> or <code class="literal">NULL</code>.</p></td>
627 <td class="parameter_annotations"> </td>
628 </tr>
629 </tbody>
630 </table></div>
631 </div>
632 <div class="refsect3">
633 <a name="udisks-linux-drive-object-is-not-in-use.returns"></a><h4>Returns</h4>
634 <p> <code class="literal">TRUE</code> if <em class="parameter"><code>object</code></em>
635 is not is use, <code class="literal">FALSE</code> if <em class="parameter"><code>error</code></em>
636 is set.</p>
637 </div>
638 </div>
639 </div>
640 <div class="refsect1">
641 <a name="UDisksLinuxDriveObject.other_details"></a><h2>Types and Values</h2>
642 <div class="refsect2">
643 <a name="UDisksLinuxDriveObject-struct"></a><h3>UDisksLinuxDriveObject</h3>
644 <pre class="programlisting">typedef struct _UDisksLinuxDriveObject UDisksLinuxDriveObject;</pre>
645 <p>The <a class="link" href="UDisksLinuxDriveObject.html" title="UDisksLinuxDriveObject"><span class="type">UDisksLinuxDriveObject</span></a> structure contains only private data and
646 should only be accessed using the provided API.</p>
647 </div>
648 </div>
649 <div class="refsect1">
650 <a name="UDisksLinuxDriveObject.property-details"></a><h2>Property Details</h2>
651 <div class="refsect2">
652 <a name="UDisksLinuxDriveObject--daemon"></a><h3>The <code class="literal">“daemon”</code> property</h3>
653 <pre class="programlisting"> “daemon” <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> *</pre>
654 <p>The <a class="link" href="UDisksDaemon.html" title="UDisksDaemon"><span class="type">UDisksDaemon</span></a> the object is for.</p>
655 <p>Owner: UDisksLinuxDriveObject</p>
656 <p>Flags: Read / Write / Construct Only</p>
657 </div>
658 <hr>
659 <div class="refsect2">
660 <a name="UDisksLinuxDriveObject--device"></a><h3>The <code class="literal">“device”</code> property</h3>
661 <pre class="programlisting"> “device” <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> *</pre>
662 <p>The <a class="link" href="UDisksLinuxDevice.html" title="UDisksLinuxDevice"><span class="type">UDisksLinuxDevice</span></a> for the object. Connect to the <span class="type">“notify”</span>
663 signal to get notified whenever this is updated.</p>
664 <p>Owner: UDisksLinuxDriveObject</p>
665 <p>Flags: Write / Construct Only</p>
666 </div>
667 </div>
668 </div>
669 <div class="footer">
670 <hr>Generated by GTK-Doc V1.35.1</div>
671 </body>
672 </html>