~behda/+junk/udisks2.original

« back to all changes in this revision

Viewing changes to doc/html/gdbus-org.freedesktop.UDisks2.PartitionTable.html

  • Committer: behda
  • Date: 2014-05-24 15:15:11 UTC
  • Revision ID: pauvitk@gmail.com-20140524151511-3vtr0uubjewx3z2j
Initial commit of source code and Debian packaging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>UDisks Reference Manual: org.freedesktop.UDisks2.PartitionTable</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="UDisks Reference Manual">
 
8
<link rel="up" href="ch02.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.20 (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="10"><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="ch02.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
</pre>
 
45
</div>
 
46
<div class="refsect1">
 
47
<a name="id-1.3.3.8.4"></a><h2>Properties</h2>
 
48
<pre class="synopsis">
 
49
<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
 
50
</pre>
 
51
</div>
 
52
<div class="refsect1">
 
53
<a name="gdbus-interface-org-freedesktop-UDisks2-PartitionTable"></a><h2>Description</h2>
 
54
<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>
 
55
      devices that contain a partition table.
 
56
</p>
 
57
</div>
 
58
<div class="refsect1">
 
59
<a name="gdbus-methods-org.freedesktop.UDisks2.PartitionTable"></a><h2>Method Details</h2>
 
60
<div class="refsect2">
 
61
<a name="gdbus-method-org-freedesktop-UDisks2-PartitionTable.CreatePartition"></a><h3>The CreatePartition() method</h3>
 
62
<pre class="programlisting">
 
63
CreatePartition (IN  t     offset,
 
64
                 IN  t     size,
 
65
                 IN  s     type,
 
66
                 IN  s     name,
 
67
                 IN  a{sv} options,
 
68
                 OUT o     created_partition);
 
69
</pre>
 
70
<p>        Creates a new partition.
 
71
</p>
 
72
<p>        Note that the created partition won't necessarily be created
 
73
        at the exact <em class="parameter"><code>offset</code></em> due to disk geometry and other alignment
 
74
        constraints (e.g. 1MiB alignment).
 
75
</p>
 
76
<p>        The newly created partition may also end up being slightly
 
77
        larger or smaller than the requested <em class="parameter"><code>size</code></em> bytes for the same
 
78
        reasons.
 
79
</p>
 
80
<p>        The newly created partition will be wiped of known filesystem
 
81
        signatures using the
 
82
        <span class="citerefentry"><span class="refentrytitle">wipefs</span>(8)</span>
 
83
        command.
 
84
</p>
 
85
<div class="variablelist"><table border="0" class="variablelist">
 
86
<colgroup>
 
87
<col align="left" valign="top">
 
88
<col>
 
89
</colgroup>
 
90
<tbody>
 
91
<tr>
 
92
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>offset</code></em></code>:</span></p></td>
 
93
<td><p>The desired offset where the partition should be created, in bytes.</p></td>
 
94
</tr>
 
95
<tr>
 
96
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
 
97
<td><p>The desired size of the partition, in bytes.</p></td>
 
98
</tr>
 
99
<tr>
 
100
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
 
101
<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>
 
102
</tr>
 
103
<tr>
 
104
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
 
105
<td><p>The name for the new partition or blank if the partition table do not support names.</p></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><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
 
110
</tr>
 
111
<tr>
 
112
<td><p><span class="term"><code class="literal">OUT o <em class="parameter"><code>created_partition</code></em></code>:</span></p></td>
 
113
<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>
 
114
</tr>
 
115
</tbody>
 
116
</table></div>
 
117
</div>
 
118
</div>
 
119
<div class="refsect1">
 
120
<a name="gdbus-properties-org.freedesktop.UDisks2.PartitionTable"></a><h2>Property Details</h2>
 
121
<div class="refsect2">
 
122
<a name="gdbus-property-org-freedesktop-UDisks2-PartitionTable.Type"></a><h3>The "Type" property</h3>
 
123
<pre class="programlisting">
 
124
Type  readable   s
 
125
</pre>
 
126
<p>The type of partition table detected.</p>
 
127
<p>         Known values include:
 
128
         </p>
 
129
<div class="variablelist"><table border="0" class="variablelist">
 
130
<colgroup>
 
131
<col align="left" valign="top">
 
132
<col>
 
133
</colgroup>
 
134
<tbody>
 
135
<tr>
 
136
<td><p><span class="term">dos</span></p></td>
 
137
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/Master_Boot_Record" target="_top">Master Boot Record</a></p></td>
 
138
</tr>
 
139
<tr>
 
140
<td><p><span class="term">gpt</span></p></td>
 
141
<td><p><a class="ulink" href="http://en.wikipedia.org/wiki/GUID_Partition_Table" target="_top">GUID Partition Table</a></p></td>
 
142
</tr>
 
143
</tbody>
 
144
</table></div>
 
145
<p>
 
146
         If blank it means that a partition table was detected but its
 
147
         scheme is unknown.
 
148
</p>
 
149
</div>
 
150
</div>
 
151
</div>
 
152
<div class="footer">
 
153
<hr>
 
154
          Generated by GTK-Doc V1.20</div>
 
155
</body>
 
156
</html>
 
 
b'\\ No newline at end of file'