File: gdbus-org.freedesktop.UDisks2.PartitionTable.html

package info (click to toggle)
udisks2 2.10.1-12.1%2Bdeb13u1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 24,708 kB
  • sloc: ansic: 48,127; python: 7,874; sh: 5,089; xml: 1,462; makefile: 1,235; sed: 85
file content (283 lines) | stat: -rw-r--r-- 13,314 bytes parent folder | download
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
<!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.PartitionTable: 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.Partition.html" title="org.freedesktop.UDisks2.Partition">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Filesystem.html" title="org.freedesktop.UDisks2.Filesystem">
<meta name="generator" content="GTK-Doc V1.33.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.PartitionTable.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.PartitionTable.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.Partition.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.Filesystem.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.PartitionTable"></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-PartitionTable.top_of_page"></a>org.freedesktop.UDisks2.PartitionTable</span></h2>
<p>org.freedesktop.UDisks2.PartitionTable — Block device containing a partition table</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.PartitionTable.html#gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition" title="The CreatePartition() method">CreatePartition</a>          (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          OUT o     created_partition);
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartitionAndFormat" title="The CreatePartitionAndFormat() method">CreatePartitionAndFormat</a> (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          IN  s     format_type,
                          IN  a{sv} format_options,
                          OUT o     created_partition);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.8.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-property-org-freedesktop-UDisks2-PartitionTable.Partitions" title='The "Partitions" property'>Partitions</a>  readable   ao
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type" title='The "Type" property'>Type</a>        readable   s
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-PartitionTable"></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 contain a partition table.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.PartitionTable"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition"></a><h3>The CreatePartition() method</h3>
<pre class="programlisting">
CreatePartition (IN  t     offset,
                 IN  t     size,
                 IN  s     type,
                 IN  s     name,
                 IN  a{sv} options,
                 OUT o     created_partition);
</pre>
<p>
Creates a new partition.
</p>
<p>
Note that the created partition won't necessarily be created
at the exact <em class="parameter"><code>offset</code></em> but slightly behind due to disk geometry
and other alignment constraints (e.g. 1MiB alignment).
</p>
<p>
The newly created partition may also end up being slightly
larger than the requested <em class="parameter"><code>size</code></em> bytes for the same reasons.
The maximal size can be automatically set by using 0 as size.
</p>
<p>
For <code class="literal">dos</code> partition tables, the partition type can be
set with the <em class="parameter"><code>partition</code></em>-type option. Possible values are: "primary",
"extended" or "logical".
</p>
<p>
An optional parameter <em class="parameter"><code>partition-uuid</code></em> denotes
the partition UUID to set for the newly created partition (GPT only).
</p>
<p>
The newly created partition will be wiped of known filesystem
signatures using the
<span class="citerefentry"><span class="refentrytitle">wipefs</span>(8)</span>
command.
</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>offset</code></em></code>:</span></p></td>
<td><p>
The desired offset where the partition should be created, in bytes.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>
The desired size of the partition, in bytes (0 for maximal size).
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>
The type of partition to create (cf. 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) or blank to use the default for the partition table type and OS.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>
The name for the new partition or blank if the partition table do not support names.
</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 - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) include <em class="parameter"><code>partition-type</code></em> (of type 's') and <em class="parameter"><code>partition-uuid</code></em> (of type 's').
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td>
<td><p>
An object path to the created block device object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a> interface.
</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartitionAndFormat"></a><h3>The CreatePartitionAndFormat() method</h3>
<pre class="programlisting">
CreatePartitionAndFormat (IN  t     offset,
                          IN  t     size,
                          IN  s     type,
                          IN  s     name,
                          IN  a{sv} options,
                          IN  s     format_type,
                          IN  a{sv} format_options,
                          OUT o     created_partition);
</pre>
<p>
This is a combination of
<a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-interface-org-freedesktop-UDisks2-PartitionTable.top_of_page">org.freedesktop.UDisks2.PartitionTable</a>:CreatePartition and
<a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>:Format.  After creating the
partition, the resulting block device is formatted.
</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>offset</code></em></code>:</span></p></td>
<td><p>
The desired offset where the partition should be created, in bytes.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>
The desired size of the partition, in bytes (0 for maximal size).
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>
The type of partition to create (cf. 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) or blank to use the default for the partition table type and OS.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>
The name for the new partition or blank if the partition table do not support names.
</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 - known options (in addition to <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>) include <em class="parameter"><code>partition-type</code></em> (of type 's') and <em class="parameter"><code>partition-uuid</code></em> (of type 's').
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>format_type</code></em></code>:</span></p></td>
<td><p>
The type to use for Format.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>format_options</code></em></code>:</span></p></td>
<td><p>
Options for Format.
</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td>
<td><p>
An object path to the created block device object implementing the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a> interface.
</p></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.PartitionTable"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Partitions"></a><h3>The "Partitions" property</h3>
<pre class="programlisting">
Partitions  readable   ao
</pre>
<p>
List of object paths of the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page">org.freedesktop.UDisks2.Partition</a>
</p>
<p>
objects that belongs to this partition table.
<em class="parameter"><code>since</code></em>: 2.7.2
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type"></a><h3>The "Type" property</h3>
<pre class="programlisting">
Type  readable   s
</pre>
<p>
The type of partition table detected.
</p>
<p>
Known values 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">dos</span></p></td>
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/Master_Boot_Record" target="_top">Master Boot Record</a></p></td>
</tr>
<tr>
<td><p><span class="term">gpt</span></p></td>
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/GUID_Partition_Table" target="_top">GUID Partition Table</a></p></td>
</tr>
</tbody>
</table></div>
<p>
If blank it means that a partition table was detected but its
scheme is unknown.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>