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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Partition: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch03.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Block.html" title="org.freedesktop.UDisks2.Block">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html" title="org.freedesktop.UDisks2.PartitionTable">
<meta name="generator" content="GTK-Doc V1.35.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.Partition.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#gdbus-org.freedesktop.UDisks2.Partition.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<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>
<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>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Partition"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page"></a>org.freedesktop.UDisks2.Partition</span></h2>
<p>org.freedesktop.UDisks2.Partition — Block device representing a partition</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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,
IN a{sv} options);
<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);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.7.4"></a><h2>Properties</h2>
<pre class="synopsis">
<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
<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
<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
<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
<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
<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
<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
<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
<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
<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
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Partition"></a><h2>Description</h2>
<p>
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>
devices that represent entries in a partition table.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Partition"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetType"></a><h3>The SetType() method</h3>
<pre class="programlisting">
SetType (IN s type,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>type</code></em>: New type to set.
<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>).
</p>
<p>
Sets the partition type. See the
<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
description of known partition types.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetName"></a><h3>The SetName() method</h3>
<pre class="programlisting">
SetName (IN s name,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>name</code></em>: New name to set.
<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>).
</p>
<p>
Sets the partition name (label).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetUUID"></a><h3>The SetUUID() method</h3>
<pre class="programlisting">
SetUUID (IN s uuid,
IN a{sv} options);
</pre>
<p>
Sets the partition UUID (GPT only).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>uuid</code></em></code>:</span></p></td>
<td><p>
The UUID to set.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>
Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
</p></td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.10.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetFlags"></a><h3>The SetFlags() method</h3>
<pre class="programlisting">
SetFlags (IN t flags,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>flags</code></em>: New flags to set.
<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>).
</p>
<p>
Sets the partition flags. See the
<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
description of known flags.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>flags</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.Resize"></a><h3>The Resize() method</h3>
<pre class="programlisting">
Resize (IN t size,
IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>size</code></em>: New partition size in bytes, 0 for maximal size.
<em class="parameter"><code>options</code></em>: Options.
<em class="parameter"><code>since</code></em>: 2.7.2
</p>
<p>
Resizes the partition.
</p>
<p>
The partition will not change its position but might be slightly bigger
than requested due to sector counts and alignment (e.g. 1MiB).
If the requested size can't be allocated it results in an error.
The maximal size can automatically be set by using 0 as size.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.Delete"></a><h3>The Delete() method</h3>
<pre class="programlisting">
Delete (IN a{sv} options);
</pre>
<p>
</p>
<p>
<em class="parameter"><code>options</code></em>: Options.
</p>
<p>
Deletes the partition.
</p>
<p>
If the option <em class="parameter"><code>tear-down</code></em> is set to
<code class="constant">TRUE</code>, then the block device and all its children will be
cleaned up before formatting. This cleanup consists of
removing entries from /etc/fstab and /etc/crypttab, and
locking of encrypted block devices. Entries in /etc/fstab
and /etc/crypttab that have been created with the
'track-parents' options to AddConfigurationItem will be
removed even if their block device is currently unavailable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td>
<p>
</p>
<p>
</p>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Partition"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Number"></a><h3>The "Number" property</h3>
<pre class="programlisting">
Number readable u
</pre>
<p>
The number of the partition in the partition table.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Type"></a><h3>The "Type" property</h3>
<pre class="programlisting">
Type readable s
</pre>
<p>
The type of the partition.
For <code class="literal">dos</code> partition tables, this string is a
hexadecimal number e.g. <code class="literal">0x83</code> or
<code class="literal">0xfd</code>. For <code class="literal">gpt</code> partition
tables this is the UUID
e.g. <code class="literal">ebd0a0a2-b9e5-4433-87c0-68b6b72699c7</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Flags"></a><h3>The "Flags" property</h3>
<pre class="programlisting">
Flags readable t
</pre>
<p>
Flags describing the partition.
Known flags for <code class="literal">dos</code> partitions include:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Bit 7</span></p></td>
<td><p>The partition is marked as bootable</p></td>
</tr></tbody>
</table></div>
<p>
Known flags for <code class="literal">gpt</code> partitions include:
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Bit 0</span></p></td>
<td><p>System partition</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 2</span></p></td>
<td><p>Legacy BIOS Bootable</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 60</span></p></td>
<td><p>Read-only</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 62</span></p></td>
<td><p>Hidden</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 63</span></p></td>
<td><p>Do not automount</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Offset"></a><h3>The "Offset" property</h3>
<pre class="programlisting">
Offset readable t
</pre>
<p>
Offset of partition, in bytes.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size readable t
</pre>
<p>
Size of partition, in bytes.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Name"></a><h3>The "Name" property</h3>
<pre class="programlisting">
Name readable s
</pre>
<p>
Label of partition or blank if not supported or unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.UUID"></a><h3>The "UUID" property</h3>
<pre class="programlisting">
UUID readable s
</pre>
<p>
The UUID of the partition or blank if not supported or unknown.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Table"></a><h3>The "Table" property</h3>
<pre class="programlisting">
Table readable o
</pre>
<p>
</p>
<p>
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>
object that the partition entry belongs to.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer"></a><h3>The "IsContainer" property</h3>
<pre class="programlisting">
IsContainer readable b
</pre>
<p>
</p>
<p>
Set to <code class="constant">TRUE</code> if the partition itself is a container for other
partitions.
</p>
<p>
For example, for <code class="literal">dos</code> partition tables,
this applies to socalled <span class="emphasis"><em>extended partition</em></span> (partitions of type
<code class="constant">0x05</code>, <code class="constant">0x0f</code> or <code class="constant">0x85</code>)
containing socalled <span class="emphasis"><em>logical partitions</em></span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContained"></a><h3>The "IsContained" property</h3>
<pre class="programlisting">
IsContained readable b
</pre>
<p>
</p>
<p>
Set to <code class="constant">TRUE</code> of the partition is contained in another partition.
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.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.35.1</div>
</body>
</html>
|
