| 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.PartitionTable: 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.Partition.html" title="org.freedesktop.UDisks2.Partition"> |
| 10 |
<link rel="next" href="gdbus-org.freedesktop.UDisks2.Filesystem.html" title="org.freedesktop.UDisks2.Filesystem"> |
| 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.PartitionTable.description" class="shortcut">Description</a></span><span id="nav_properties"> <span class="dim">|</span> |
| 19 |
<a href="#gdbus-org.freedesktop.UDisks2.PartitionTable.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.Partition.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.Filesystem.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.PartitionTable"></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-PartitionTable.top_of_page"></a>org.freedesktop.UDisks2.PartitionTable</span></h2> |
| 31 |
<p>org.freedesktop.UDisks2.PartitionTable — Block device containing a partition table</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.PartitionTable.html#gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition" title="The CreatePartition() method">CreatePartition</a> (IN t offset, |
| 39 |
IN t size, |
| 40 |
IN s type, |
| 41 |
IN s name, |
| 42 |
IN a{sv} options, |
| 43 |
OUT o created_partition); |
| 44 |
<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, |
| 45 |
IN t size, |
| 46 |
IN s type, |
| 47 |
IN s name, |
| 48 |
IN a{sv} options, |
| 49 |
IN s format_type, |
| 50 |
IN a{sv} format_options, |
| 51 |
OUT o created_partition); |
| 52 |
</pre> |
| 53 |
</div> |
| 54 |
<div class="refsect1"> |
| 55 |
<a name="id-1.3.3.8.4"></a><h2>Properties</h2> |
| 56 |
<pre class="synopsis"> |
| 57 |
<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 |
| 58 |
<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 |
| 59 |
</pre> |
| 60 |
</div> |
| 61 |
<div class="refsect1"> |
| 62 |
<a name="gdbus-interface-org-freedesktop-UDisks2-PartitionTable"></a><h2>Description</h2> |
| 63 |
<p> |
| 64 |
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> |
| 65 |
devices that contain a partition table. |
| 66 |
</p> |
| 67 |
</div> |
| 68 |
<div class="refsect1"> |
| 69 |
<a name="gdbus-methods-org.freedesktop.UDisks2.PartitionTable"></a><h2>Method Details</h2> |
| 70 |
<div class="refsect2"> |
| 71 |
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition"></a><h3>The CreatePartition() method</h3> |
| 72 |
<pre class="programlisting"> |
| 73 |
CreatePartition (IN t offset, |
| 74 |
IN t size, |
| 75 |
IN s type, |
| 76 |
IN s name, |
| 77 |
IN a{sv} options, |
| 78 |
OUT o created_partition); |
| 79 |
</pre> |
| 80 |
<p> |
| 81 |
Creates a new partition. |
| 82 |
</p> |
| 83 |
<p> |
| 84 |
Note that the created partition won't necessarily be created |
| 85 |
at the exact <em class="parameter"><code>offset</code></em> but slightly behind due to disk geometry |
| 86 |
and other alignment constraints (e.g. 1MiB alignment). |
| 87 |
</p> |
| 88 |
<p> |
| 89 |
The newly created partition may also end up being slightly |
| 90 |
larger than the requested <em class="parameter"><code>size</code></em> bytes for the same reasons. |
| 91 |
The maximal size can be automatically set by using 0 as size. |
| 92 |
</p> |
| 93 |
<p> |
| 94 |
For <code class="literal">dos</code> partition tables, the partition type can be |
| 95 |
set with the <em class="parameter"><code>partition</code></em>-type option. Possible values are: "primary", |
| 96 |
"extended" or "logical". |
| 97 |
</p> |
| 98 |
<p> |
| 99 |
An optional parameter <em class="parameter"><code>partition-uuid</code></em> denotes |
| 100 |
the partition UUID to set for the newly created partition (GPT only). |
| 101 |
</p> |
| 102 |
<p> |
| 103 |
The newly created partition will be wiped of known filesystem |
| 104 |
signatures using the |
| 105 |
<span class="citerefentry"><span class="refentrytitle">wipefs</span>(8)</span> |
| 106 |
command. |
| 107 |
</p> |
| 108 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 109 |
<colgroup> |
| 110 |
<col align="left" valign="top"> |
| 111 |
<col> |
| 112 |
</colgroup> |
| 113 |
<tbody> |
| 114 |
<tr> |
| 115 |
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>offset</code></em></code>:</span></p></td> |
| 116 |
<td><p> |
| 117 |
The desired offset where the partition should be created, in bytes. |
| 118 |
</p></td> |
| 119 |
</tr> |
| 120 |
<tr> |
| 121 |
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td> |
| 122 |
<td><p> |
| 123 |
The desired size of the partition, in bytes (0 for maximal size). |
| 124 |
</p></td> |
| 125 |
</tr> |
| 126 |
<tr> |
| 127 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td> |
| 128 |
<td><p> |
| 129 |
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. |
| 130 |
</p></td> |
| 131 |
</tr> |
| 132 |
<tr> |
| 133 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td> |
| 134 |
<td><p> |
| 135 |
The name for the new partition or blank if the partition table do not support names. |
| 136 |
</p></td> |
| 137 |
</tr> |
| 138 |
<tr> |
| 139 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 140 |
<td><p> |
| 141 |
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'). |
| 142 |
</p></td> |
| 143 |
</tr> |
| 144 |
<tr> |
| 145 |
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td> |
| 146 |
<td><p> |
| 147 |
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. |
| 148 |
</p></td> |
| 149 |
</tr> |
| 150 |
</tbody> |
| 151 |
</table></div> |
| 152 |
</div> |
| 153 |
<hr> |
| 154 |
<div class="refsect2"> |
| 155 |
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartitionAndFormat"></a><h3>The CreatePartitionAndFormat() method</h3> |
| 156 |
<pre class="programlisting"> |
| 157 |
CreatePartitionAndFormat (IN t offset, |
| 158 |
IN t size, |
| 159 |
IN s type, |
| 160 |
IN s name, |
| 161 |
IN a{sv} options, |
| 162 |
IN s format_type, |
| 163 |
IN a{sv} format_options, |
| 164 |
OUT o created_partition); |
| 165 |
</pre> |
| 166 |
<p> |
| 167 |
This is a combination of |
| 168 |
<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 |
| 169 |
<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 |
| 170 |
partition, the resulting block device is formatted. |
| 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 t <em class="parameter"><code>offset</code></em></code>:</span></p></td> |
| 180 |
<td><p> |
| 181 |
The desired offset where the partition should be created, in bytes. |
| 182 |
</p></td> |
| 183 |
</tr> |
| 184 |
<tr> |
| 185 |
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td> |
| 186 |
<td><p> |
| 187 |
The desired size of the partition, in bytes (0 for maximal size). |
| 188 |
</p></td> |
| 189 |
</tr> |
| 190 |
<tr> |
| 191 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td> |
| 192 |
<td><p> |
| 193 |
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. |
| 194 |
</p></td> |
| 195 |
</tr> |
| 196 |
<tr> |
| 197 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td> |
| 198 |
<td><p> |
| 199 |
The name for the new partition or blank if the partition table do not support names. |
| 200 |
</p></td> |
| 201 |
</tr> |
| 202 |
<tr> |
| 203 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td> |
| 204 |
<td><p> |
| 205 |
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'). |
| 206 |
</p></td> |
| 207 |
</tr> |
| 208 |
<tr> |
| 209 |
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>format_type</code></em></code>:</span></p></td> |
| 210 |
<td><p> |
| 211 |
The type to use for Format. |
| 212 |
</p></td> |
| 213 |
</tr> |
| 214 |
<tr> |
| 215 |
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>format_options</code></em></code>:</span></p></td> |
| 216 |
<td><p> |
| 217 |
Options for Format. |
| 218 |
</p></td> |
| 219 |
</tr> |
| 220 |
<tr> |
| 221 |
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td> |
| 222 |
<td><p> |
| 223 |
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. |
| 224 |
</p></td> |
| 225 |
</tr> |
| 226 |
</tbody> |
| 227 |
</table></div> |
| 228 |
</div> |
| 229 |
</div> |
| 230 |
<div class="refsect1"> |
| 231 |
<a name="gdbus-properties-org.freedesktop.UDisks2.PartitionTable"></a><h2>Property Details</h2> |
| 232 |
<div class="refsect2"> |
| 233 |
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Partitions"></a><h3>The "Partitions" property</h3> |
| 234 |
<pre class="programlisting"> |
| 235 |
Partitions readable ao |
| 236 |
</pre> |
| 237 |
<p> |
| 238 |
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> |
| 239 |
</p> |
| 240 |
<p> |
| 241 |
objects that belongs to this partition table. |
| 242 |
<em class="parameter"><code>since</code></em>: 2.7.2 |
| 243 |
</p> |
| 244 |
</div> |
| 245 |
<hr> |
| 246 |
<div class="refsect2"> |
| 247 |
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type"></a><h3>The "Type" property</h3> |
| 248 |
<pre class="programlisting"> |
| 249 |
Type readable s |
| 250 |
</pre> |
| 251 |
<p> |
| 252 |
The type of partition table detected. |
| 253 |
</p> |
| 254 |
<p> |
| 255 |
Known values include: |
| 256 |
</p> |
| 257 |
<div class="variablelist"><table border="0" class="variablelist"> |
| 258 |
<colgroup> |
| 259 |
<col align="left" valign="top"> |
| 260 |
<col> |
| 261 |
</colgroup> |
| 262 |
<tbody> |
| 263 |
<tr> |
| 264 |
<td><p><span class="term">dos</span></p></td> |
| 265 |
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/Master_Boot_Record" target="_top">Master Boot Record</a></p></td> |
| 266 |
</tr> |
| 267 |
<tr> |
| 268 |
<td><p><span class="term">gpt</span></p></td> |
| 269 |
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/GUID_Partition_Table" target="_top">GUID Partition Table</a></p></td> |
| 270 |
</tr> |
| 271 |
</tbody> |
| 272 |
</table></div> |
| 273 |
<p> |
| 274 |
If blank it means that a partition table was detected but its |
| 275 |
scheme is unknown. |
| 276 |
</p> |
| 277 |
</div> |
| 278 |
</div> |
| 279 |
</div> |
| 280 |
<div class="footer"> |
| 281 |
<hr>Generated by GTK-Doc V1.35.1</div> |
| 282 |
</body> |
| 283 |
</html> |