Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Partition.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>org.freedesktop.UDisks2.Partition: 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="ch03.html" title="D-Bus Interfaces">
9 <link rel="prev" href="gdbus-org.freedesktop.UDisks2.Block.html" title="org.freedesktop.UDisks2.Block">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html" title="org.freedesktop.UDisks2.PartitionTable">
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="#gdbus-org.freedesktop.UDisks2.Partition.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Partition.properties" class="shortcut">Properties</a></span>
20 </td>
21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23 <td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Block.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24 <td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 </tr></table>
26 <div class="refentry">
27 <a name="gdbus-org.freedesktop.UDisks2.Partition"></a><div class="titlepage"></div>
28 <div class="refnamediv"><table width="100%"><tr>
29 <td valign="top">
30 <h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page"></a>org.freedesktop.UDisks2.Partition</span></h2>
31 <p>org.freedesktop.UDisks2.Partition — Block device representing a partition</p>
32 </td>
33 <td class="gallery_image" valign="top" align="right"></td>
34 </tr></table></div>
35 <div class="refsynopsisdiv">
36 <h2>Methods</h2>
37 <pre class="synopsis">
38 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetType" title="The SetType() method">SetType</a> (IN s type,
39 IN a{sv} options);
40 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetName" title="The SetName() method">SetName</a> (IN s name,
41 IN a{sv} options);
42 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetUUID" title="The SetUUID() method">SetUUID</a> (IN s uuid,
43 IN a{sv} options);
44 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetFlags" title="The SetFlags() method">SetFlags</a> (IN t flags,
45 IN a{sv} options);
46 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.Resize" title="The Resize() method">Resize</a> (IN t size,
47 IN a{sv} options);
48 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.Delete" title="The Delete() method">Delete</a> (IN a{sv} options);
49 </pre>
50 </div>
51 <div class="refsect1">
52 <a name="id-1.3.3.7.4"></a><h2>Properties</h2>
53 <pre class="synopsis">
54 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Number" title='The "Number" property'>Number</a> readable u
55 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>Type</a> readable s
56 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Flags" title='The "Flags" property'>Flags</a> readable t
57 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Offset" title='The "Offset" property'>Offset</a> readable t
58 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Size" title='The "Size" property'>Size</a> readable t
59 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Name" title='The "Name" property'>Name</a> readable s
60 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.UUID" title='The "UUID" property'>UUID</a> readable s
61 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Table" title='The "Table" property'>Table</a> readable o
62 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer" title='The "IsContainer" property'>IsContainer</a> readable b
63 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContained" title='The "IsContained" property'>IsContained</a> readable b
64 </pre>
65 </div>
66 <div class="refsect1">
67 <a name="gdbus-interface-org-freedesktop-UDisks2-Partition"></a><h2>Description</h2>
68 <p>
69 This interface is used for <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
70 devices that represent entries in a partition table.
71 </p>
72 </div>
73 <div class="refsect1">
74 <a name="gdbus-methods-org.freedesktop.UDisks2.Partition"></a><h2>Method Details</h2>
75 <div class="refsect2">
76 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetType"></a><h3>The SetType() method</h3>
77 <pre class="programlisting">
78 SetType (IN s type,
79 IN a{sv} options);
80 </pre>
81 <p>
82 </p>
83 <p>
84 <em class="parameter"><code>type</code></em>: New type to set.
85 <em class="parameter"><code>options</code></em>: Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
86 </p>
87 <p>
88 Sets the partition type. See the
89 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a> property for a
90 description of known partition types.
91 </p>
92 <div class="variablelist"><table border="0" class="variablelist">
93 <colgroup>
94 <col align="left" valign="top">
95 <col>
96 </colgroup>
97 <tbody>
98 <tr>
99 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
100 <td>
101 <p>
102 </p>
103 <p>
104 </p>
105 </td>
106 </tr>
107 <tr>
108 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
109 <td>
110 <p>
111 </p>
112 <p>
113 </p>
114 </td>
115 </tr>
116 </tbody>
117 </table></div>
118 </div>
119 <hr>
120 <div class="refsect2">
121 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetName"></a><h3>The SetName() method</h3>
122 <pre class="programlisting">
123 SetName (IN s name,
124 IN a{sv} options);
125 </pre>
126 <p>
127 </p>
128 <p>
129 <em class="parameter"><code>name</code></em>: New name to set.
130 <em class="parameter"><code>options</code></em>: Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
131 </p>
132 <p>
133 Sets the partition name (label).
134 </p>
135 <div class="variablelist"><table border="0" class="variablelist">
136 <colgroup>
137 <col align="left" valign="top">
138 <col>
139 </colgroup>
140 <tbody>
141 <tr>
142 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
143 <td>
144 <p>
145 </p>
146 <p>
147 </p>
148 </td>
149 </tr>
150 <tr>
151 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
152 <td>
153 <p>
154 </p>
155 <p>
156 </p>
157 </td>
158 </tr>
159 </tbody>
160 </table></div>
161 </div>
162 <hr>
163 <div class="refsect2">
164 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetUUID"></a><h3>The SetUUID() method</h3>
165 <pre class="programlisting">
166 SetUUID (IN s uuid,
167 IN a{sv} options);
168 </pre>
169 <p>
170 Sets the partition UUID (GPT only).
171 </p>
172 <div class="variablelist"><table border="0" class="variablelist">
173 <colgroup>
174 <col align="left" valign="top">
175 <col>
176 </colgroup>
177 <tbody>
178 <tr>
179 <td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>uuid</code></em></code>:</span></p></td>
180 <td><p>
181 The UUID to set.
182 </p></td>
183 </tr>
184 <tr>
185 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
186 <td><p>
187 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
188 </p></td>
189 </tr>
190 </tbody>
191 </table></div>
192 <p class="since">Since 2.10.0</p>
193 </div>
194 <hr>
195 <div class="refsect2">
196 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetFlags"></a><h3>The SetFlags() method</h3>
197 <pre class="programlisting">
198 SetFlags (IN t flags,
199 IN a{sv} options);
200 </pre>
201 <p>
202 </p>
203 <p>
204 <em class="parameter"><code>flags</code></em>: New flags to set.
205 <em class="parameter"><code>options</code></em>: Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
206 </p>
207 <p>
208 Sets the partition flags. See the
209 <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Flags" title='The "Flags" property'>"Flags"</a> property for a
210 description of known flags.
211 </p>
212 <div class="variablelist"><table border="0" class="variablelist">
213 <colgroup>
214 <col align="left" valign="top">
215 <col>
216 </colgroup>
217 <tbody>
218 <tr>
219 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>flags</code></em></code>:</span></p></td>
220 <td>
221 <p>
222 </p>
223 <p>
224 </p>
225 </td>
226 </tr>
227 <tr>
228 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
229 <td>
230 <p>
231 </p>
232 <p>
233 </p>
234 </td>
235 </tr>
236 </tbody>
237 </table></div>
238 </div>
239 <hr>
240 <div class="refsect2">
241 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.Resize"></a><h3>The Resize() method</h3>
242 <pre class="programlisting">
243 Resize (IN t size,
244 IN a{sv} options);
245 </pre>
246 <p>
247 </p>
248 <p>
249 <em class="parameter"><code>size</code></em>: New partition size in bytes, 0 for maximal size.
250 <em class="parameter"><code>options</code></em>: Options.
251 <em class="parameter"><code>since</code></em>: 2.7.2
252 </p>
253 <p>
254 Resizes the partition.
255 </p>
256 <p>
257 The partition will not change its position but might be slightly bigger
258 than requested due to sector counts and alignment (e.g. 1MiB).
259 If the requested size can't be allocated it results in an error.
260 The maximal size can automatically be set by using 0 as size.
261 </p>
262 <div class="variablelist"><table border="0" class="variablelist">
263 <colgroup>
264 <col align="left" valign="top">
265 <col>
266 </colgroup>
267 <tbody>
268 <tr>
269 <td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
270 <td>
271 <p>
272 </p>
273 <p>
274 </p>
275 </td>
276 </tr>
277 <tr>
278 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
279 <td>
280 <p>
281 </p>
282 <p>
283 </p>
284 </td>
285 </tr>
286 </tbody>
287 </table></div>
288 </div>
289 <hr>
290 <div class="refsect2">
291 <a name="gdbus-method-org-freedesktop-UDisks2-Partition.Delete"></a><h3>The Delete() method</h3>
292 <pre class="programlisting">
293 Delete (IN a{sv} options);
294 </pre>
295 <p>
296 </p>
297 <p>
298 <em class="parameter"><code>options</code></em>: Options.
299 </p>
300 <p>
301 Deletes the partition.
302 </p>
303 <p>
304 If the option <em class="parameter"><code>tear-down</code></em> is set to
305 <code class="constant">TRUE</code>, then the block device and all its children will be
306 cleaned up before formatting. This cleanup consists of
307 removing entries from /etc/fstab and /etc/crypttab, and
308 locking of encrypted block devices. Entries in /etc/fstab
309 and /etc/crypttab that have been created with the
310 'track-parents' options to AddConfigurationItem will be
311 removed even if their block device is currently unavailable.
312 </p>
313 <div class="variablelist"><table border="0" class="variablelist">
314 <colgroup>
315 <col align="left" valign="top">
316 <col>
317 </colgroup>
318 <tbody><tr>
319 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
320 <td>
321 <p>
322 </p>
323 <p>
324 </p>
325 </td>
326 </tr></tbody>
327 </table></div>
328 </div>
329 </div>
330 <div class="refsect1">
331 <a name="gdbus-properties-org.freedesktop.UDisks2.Partition"></a><h2>Property Details</h2>
332 <div class="refsect2">
333 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Number"></a><h3>The "Number" property</h3>
334 <pre class="programlisting">
335 Number readable u
336 </pre>
337 <p>
338 The number of the partition in the partition table.
339 </p>
340 </div>
341 <hr>
342 <div class="refsect2">
343 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Type"></a><h3>The "Type" property</h3>
344 <pre class="programlisting">
345 Type readable s
346 </pre>
347 <p>
348 The type of the partition.
349 For <code class="literal">dos</code> partition tables, this string is a
350 hexadecimal number e.g. <code class="literal">0x83</code> or
351 <code class="literal">0xfd</code>. For <code class="literal">gpt</code> partition
352 tables this is the UUID
353 e.g. <code class="literal">ebd0a0a2-b9e5-4433-87c0-68b6b72699c7</code>.
354 </p>
355 </div>
356 <hr>
357 <div class="refsect2">
358 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Flags"></a><h3>The "Flags" property</h3>
359 <pre class="programlisting">
360 Flags readable t
361 </pre>
362 <p>
363 Flags describing the partition.
364 Known flags for <code class="literal">dos</code> partitions include:
365 </p>
366 <div class="variablelist"><table border="0" class="variablelist">
367 <colgroup>
368 <col align="left" valign="top">
369 <col>
370 </colgroup>
371 <tbody><tr>
372 <td><p><span class="term">Bit 7</span></p></td>
373 <td><p>The partition is marked as bootable</p></td>
374 </tr></tbody>
375 </table></div>
376 <p>
377 Known flags for <code class="literal">gpt</code> partitions include:
378 </p>
379 <div class="variablelist"><table border="0" class="variablelist">
380 <colgroup>
381 <col align="left" valign="top">
382 <col>
383 </colgroup>
384 <tbody>
385 <tr>
386 <td><p><span class="term">Bit 0</span></p></td>
387 <td><p>System partition</p></td>
388 </tr>
389 <tr>
390 <td><p><span class="term">Bit 2</span></p></td>
391 <td><p>Legacy BIOS Bootable</p></td>
392 </tr>
393 <tr>
394 <td><p><span class="term">Bit 60</span></p></td>
395 <td><p>Read-only</p></td>
396 </tr>
397 <tr>
398 <td><p><span class="term">Bit 62</span></p></td>
399 <td><p>Hidden</p></td>
400 </tr>
401 <tr>
402 <td><p><span class="term">Bit 63</span></p></td>
403 <td><p>Do not automount</p></td>
404 </tr>
405 </tbody>
406 </table></div>
407 <p>
408 </p>
409 </div>
410 <hr>
411 <div class="refsect2">
412 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Offset"></a><h3>The "Offset" property</h3>
413 <pre class="programlisting">
414 Offset readable t
415 </pre>
416 <p>
417 Offset of partition, in bytes.
418 </p>
419 </div>
420 <hr>
421 <div class="refsect2">
422 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Size"></a><h3>The "Size" property</h3>
423 <pre class="programlisting">
424 Size readable t
425 </pre>
426 <p>
427 Size of partition, in bytes.
428 </p>
429 </div>
430 <hr>
431 <div class="refsect2">
432 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Name"></a><h3>The "Name" property</h3>
433 <pre class="programlisting">
434 Name readable s
435 </pre>
436 <p>
437 Label of partition or blank if not supported or unknown.
438 </p>
439 </div>
440 <hr>
441 <div class="refsect2">
442 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.UUID"></a><h3>The "UUID" property</h3>
443 <pre class="programlisting">
444 UUID readable s
445 </pre>
446 <p>
447 The UUID of the partition or blank if not supported or unknown.
448 </p>
449 </div>
450 <hr>
451 <div class="refsect2">
452 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.Table"></a><h3>The "Table" property</h3>
453 <pre class="programlisting">
454 Table readable o
455 </pre>
456 <p>
457 </p>
458 <p>
459 The object path of the <a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-interface-org-freedesktop-UDisks2-PartitionTable.top_of_page">org.freedesktop.UDisks2.PartitionTable</a>
460 object that the partition entry belongs to.
461 </p>
462 </div>
463 <hr>
464 <div class="refsect2">
465 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer"></a><h3>The "IsContainer" property</h3>
466 <pre class="programlisting">
467 IsContainer readable b
468 </pre>
469 <p>
470 </p>
471 <p>
472 Set to <code class="constant">TRUE</code> if the partition itself is a container for other
473 partitions.
474 </p>
475 <p>
476 For example, for <code class="literal">dos</code> partition tables,
477 this applies to socalled <span class="emphasis"><em>extended partition</em></span> (partitions of type
478 <code class="constant">0x05</code>, <code class="constant">0x0f</code> or <code class="constant">0x85</code>)
479 containing socalled <span class="emphasis"><em>logical partitions</em></span>.
480 </p>
481 </div>
482 <hr>
483 <div class="refsect2">
484 <a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContained"></a><h3>The "IsContained" property</h3>
485 <pre class="programlisting">
486 IsContained readable b
487 </pre>
488 <p>
489 </p>
490 <p>
491 Set to <code class="constant">TRUE</code> of the partition is contained in another partition.
492 See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer" title='The "IsContainer" property'>"IsContainer"</a> property for more information.
493 </p>
494 </div>
495 </div>
496 </div>
497 <div class="footer">
498 <hr>Generated by GTK-Doc V1.35.1</div>
499 </body>
500 </html>