Debian Codegraph @

doc/html/gdbus-org.freedesktop.UDisks2.Loop.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.Loop: 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.Encrypted.html" title="org.freedesktop.UDisks2.Encrypted">
10 <link rel="next" href="gdbus-org.freedesktop.UDisks2.Job.html" title="org.freedesktop.UDisks2.Job">
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.Loop.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
19 <a href="#gdbus-org.freedesktop.UDisks2.Loop.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.Encrypted.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.Job.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.Loop"></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-Loop.top_of_page"></a>org.freedesktop.UDisks2.Loop</span></h2>
31 <p>org.freedesktop.UDisks2.Loop — Block device backed by a file</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.Loop.html#gdbus-method-org-freedesktop-UDisks2-Loop.Delete" title="The Delete() method">Delete</a> (IN a{sv} options);
39 <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-method-org-freedesktop-UDisks2-Loop.SetAutoclear" title="The SetAutoclear() method">SetAutoclear</a> (IN b value,
40 IN a{sv} options);
41 <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-method-org-freedesktop-UDisks2-Loop.SetCapacity" title="The SetCapacity() method">SetCapacity</a> (IN a{sv} options);
42 </pre>
43 </div>
44 <div class="refsect1">
45 <a name="id-1.3.3.12.4"></a><h2>Properties</h2>
46 <pre class="synopsis">
47 <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-property-org-freedesktop-UDisks2-Loop.BackingFile" title='The "BackingFile" property'>BackingFile</a> readable ay
48 <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-property-org-freedesktop-UDisks2-Loop.Autoclear" title='The "Autoclear" property'>Autoclear</a> readable b
49 <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-property-org-freedesktop-UDisks2-Loop.SetupByUID" title='The "SetupByUID" property'>SetupByUID</a> readable u
50 </pre>
51 </div>
52 <div class="refsect1">
53 <a name="gdbus-interface-org-freedesktop-UDisks2-Loop"></a><h2>Description</h2>
54 <p>
55 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>
56 devices that are loop devices.
57 </p>
58 </div>
59 <div class="refsect1">
60 <a name="gdbus-methods-org.freedesktop.UDisks2.Loop"></a><h2>Method Details</h2>
61 <div class="refsect2">
62 <a name="gdbus-method-org-freedesktop-UDisks2-Loop.Delete"></a><h3>The Delete() method</h3>
63 <pre class="programlisting">
64 Delete (IN a{sv} options);
65 </pre>
66 <p>
67 Deletes the loop device.
68 </p>
69 <div class="variablelist"><table border="0" class="variablelist">
70 <colgroup>
71 <col align="left" valign="top">
72 <col>
73 </colgroup>
74 <tbody><tr>
75 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
76 <td><p>
77 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
78 </p></td>
79 </tr></tbody>
80 </table></div>
81 </div>
82 <hr>
83 <div class="refsect2">
84 <a name="gdbus-method-org-freedesktop-UDisks2-Loop.SetAutoclear"></a><h3>The SetAutoclear() method</h3>
85 <pre class="programlisting">
86 SetAutoclear (IN b value,
87 IN a{sv} options);
88 </pre>
89 <p>
90 Setter for the <a class="link" href="gdbus-org.freedesktop.UDisks2.Loop.html#gdbus-property-org-freedesktop-UDisks2-Loop.Autoclear" title='The "Autoclear" property'>"Autoclear"</a>
91 property. Since this may require authentication and thus may
92 fail, it is implemented this way instead of the property being
93 writable.
94 </p>
95 <div class="variablelist"><table border="0" class="variablelist">
96 <colgroup>
97 <col align="left" valign="top">
98 <col>
99 </colgroup>
100 <tbody>
101 <tr>
102 <td><p><span class="term"><code class="literal">IN b <em class="parameter"><code>value</code></em></code>:</span></p></td>
103 <td><p>
104 The new value of autoclear.
105 </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>
110 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
111 </p></td>
112 </tr>
113 </tbody>
114 </table></div>
115 </div>
116 <hr>
117 <div class="refsect2">
118 <a name="gdbus-method-org-freedesktop-UDisks2-Loop.SetCapacity"></a><h3>The SetCapacity() method</h3>
119 <pre class="programlisting">
120 SetCapacity (IN a{sv} options);
121 </pre>
122 <p>
123 Forces the loop driver to reread the size of the file associated
124 with this device.
125 </p>
126 <div class="variablelist"><table border="0" class="variablelist">
127 <colgroup>
128 <col align="left" valign="top">
129 <col>
130 </colgroup>
131 <tbody><tr>
132 <td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
133 <td><p>
134 Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).
135 </p></td>
136 </tr></tbody>
137 </table></div>
138 <p class="since">Since 2.11.0</p>
139 </div>
140 </div>
141 <div class="refsect1">
142 <a name="gdbus-properties-org.freedesktop.UDisks2.Loop"></a><h2>Property Details</h2>
143 <div class="refsect2">
144 <a name="gdbus-property-org-freedesktop-UDisks2-Loop.BackingFile"></a><h3>The "BackingFile" property</h3>
145 <pre class="programlisting">
146 BackingFile readable ay
147 </pre>
148 <p>
149 </p>
150 <p>
151 A path to the file that is backing the block device or blank
152 if unknown.
153 </p>
154 </div>
155 <hr>
156 <div class="refsect2">
157 <a name="gdbus-property-org-freedesktop-UDisks2-Loop.Autoclear"></a><h3>The "Autoclear" property</h3>
158 <pre class="programlisting">
159 Autoclear readable b
160 </pre>
161 <p>
162 </p>
163 <p>
164 If <code class="constant">TRUE</code>, the kernel will automatically clear the loop device
165 when the last closer closes the device. This typically
166 happens when the loop device is unmounted.
167 </p>
168 </div>
169 <hr>
170 <div class="refsect2">
171 <a name="gdbus-property-org-freedesktop-UDisks2-Loop.SetupByUID"></a><h3>The "SetupByUID" property</h3>
172 <pre class="programlisting">
173 SetupByUID readable u
174 </pre>
175 <p>
176 </p>
177 <p>
178 The id of the user who set up the loop device or 0 if set up
179 by root or not through udisks.
180 </p>
181 </div>
182 </div>
183 </div>
184 <div class="footer">
185 <hr>Generated by GTK-Doc V1.35.1</div>
186 </body>
187 </html>