~xavi-garcia-mena/upower/percentages-power-off

« back to all changes in this revision

Viewing changes to doc/html/UPower-up-device.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-10-20 17:11:30 UTC
  • mfrom: (49.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131020171130-flrh6n1po62b1130
Tags: 0.9.23-1
* New upstream bug fix release.
* Force libglib2.0-0 to be at least 2.36 to avoid running against earlier
  glib versions which still required g_type_init(). (Closes: #722612)

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>up-device</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 
7
<link rel="home" href="index.html" title="UPower Reference Manual">
 
8
<link rel="up" href="libupower-glib.html" title="libupower-glib GObjects">
 
9
<link rel="prev" href="UPower-up-client.html" title="up-client">
 
10
<link rel="next" href="UPower-up-history-item.html" title="up-history-item">
 
11
<meta name="generator" content="GTK-Doc V1.19 (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="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="UPower-up-client.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="libupower-glib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">UPower Reference Manual</th>
 
21
<td><a accesskey="n" href="UPower-up-history-item.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#UPower-up-device.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#UPower-up-device.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="UPower-up-device"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="UPower-up-device.top_of_page"></a>up-device</span></h2>
 
34
<p>up-device — Client object for accessing information about UPower devices</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="UPower-up-device.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">#define             <a class="link" href="UPower-up-device.html#UP-DEVICE-ERROR:CAPS" title="UP_DEVICE_ERROR">UP_DEVICE_ERROR</a>
 
41
#define             <a class="link" href="UPower-up-device.html#UP-DEVICE-TYPE-ERROR:CAPS" title="UP_DEVICE_TYPE_ERROR">UP_DEVICE_TYPE_ERROR</a>
 
42
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved1" title="_up_device_reserved1 ()">*_up_device_reserved1</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
43
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved2" title="_up_device_reserved2 ()">*_up_device_reserved2</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
44
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved3" title="_up_device_reserved3 ()">*_up_device_reserved3</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
45
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved4" title="_up_device_reserved4 ()">*_up_device_reserved4</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
46
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved5" title="_up_device_reserved5 ()">*_up_device_reserved5</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
47
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved6" title="_up_device_reserved6 ()">*_up_device_reserved6</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
48
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved7" title="_up_device_reserved7 ()">*_up_device_reserved7</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
49
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-device.html#up-device-reserved8" title="_up_device_reserved8 ()">*_up_device_reserved8</a>)             (<em class="parameter"><code><span class="type">void</span></code></em>);
 
50
<span class="returnvalue">void</span>                (<a class="link" href="UPower-up-client.html#changed" title="changed ()">*changed</a>)                          (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
51
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *obj</code></em>);
 
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="UPower-up-device.html#up-device-get-history-sync" title="up_device_get_history_sync ()">up_device_get_history_sync</a>          (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
53
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timespec</code></em>,
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> resolution</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
57
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
58
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="UPower-up-device.html#up-device-get-object-path" title="up_device_get_object_path ()">up_device_get_object_path</a>           (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>);
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         <a class="link" href="UPower-up-device.html#up-device-get-statistics-sync" title="up_device_get_statistics_sync ()">up_device_get_statistics_sync</a>       (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
60
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 
61
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
62
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
63
<span class="returnvalue">UpDevice</span> *          <a class="link" href="UPower-up-device.html#up-device-new" title="up_device_new ()">up_device_new</a>                       (<em class="parameter"><code><span class="type">void</span></code></em>);
 
64
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="UPower-up-device.html#up-device-refresh-sync" title="up_device_refresh_sync ()">up_device_refresh_sync</a>              (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
65
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
67
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="UPower-up-device.html#up-device-set-object-path-sync" title="up_device_set_object_path_sync ()">up_device_set_object_path_sync</a>      (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
68
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
 
69
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
70
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
71
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="UPower-up-device.html#up-device-to-text" title="up_device_to_text ()">up_device_to_text</a>                   (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>);
 
72
</pre>
 
73
</div>
 
74
<div class="refsect1">
 
75
<a name="UPower-up-device.description"></a><h2>Description</h2>
 
76
<p>
 
77
A helper GObject to use for accessing UPower devices, and to be notified
 
78
when it is changed.
 
79
</p>
 
80
<p>
 
81
See also: <span class="type">UpClient</span>
 
82
</p>
 
83
</div>
 
84
<div class="refsect1">
 
85
<a name="UPower-up-device.details"></a><h2>Details</h2>
 
86
<div class="refsect2">
 
87
<a name="UP-DEVICE-ERROR:CAPS"></a><h3>UP_DEVICE_ERROR</h3>
 
88
<pre class="programlisting">#define UP_DEVICE_ERROR             (up_device_error_quark ())
 
89
</pre>
 
90
</div>
 
91
<hr>
 
92
<div class="refsect2">
 
93
<a name="UP-DEVICE-TYPE-ERROR:CAPS"></a><h3>UP_DEVICE_TYPE_ERROR</h3>
 
94
<pre class="programlisting">#define UP_DEVICE_TYPE_ERROR (up_device_error_get_type ())
 
95
</pre>
 
96
</div>
 
97
<hr>
 
98
<div class="refsect2">
 
99
<a name="up-device-reserved1"></a><h3>_up_device_reserved1 ()</h3>
 
100
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved1)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
101
</div>
 
102
<hr>
 
103
<div class="refsect2">
 
104
<a name="up-device-reserved2"></a><h3>_up_device_reserved2 ()</h3>
 
105
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved2)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
106
</div>
 
107
<hr>
 
108
<div class="refsect2">
 
109
<a name="up-device-reserved3"></a><h3>_up_device_reserved3 ()</h3>
 
110
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved3)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
111
</div>
 
112
<hr>
 
113
<div class="refsect2">
 
114
<a name="up-device-reserved4"></a><h3>_up_device_reserved4 ()</h3>
 
115
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved4)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
116
</div>
 
117
<hr>
 
118
<div class="refsect2">
 
119
<a name="up-device-reserved5"></a><h3>_up_device_reserved5 ()</h3>
 
120
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved5)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
121
</div>
 
122
<hr>
 
123
<div class="refsect2">
 
124
<a name="up-device-reserved6"></a><h3>_up_device_reserved6 ()</h3>
 
125
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved6)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
126
</div>
 
127
<hr>
 
128
<div class="refsect2">
 
129
<a name="up-device-reserved7"></a><h3>_up_device_reserved7 ()</h3>
 
130
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved7)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
131
</div>
 
132
<hr>
 
133
<div class="refsect2">
 
134
<a name="up-device-reserved8"></a><h3>_up_device_reserved8 ()</h3>
 
135
<pre class="programlisting"><span class="returnvalue">void</span>                (*_up_device_reserved8)             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
136
</div>
 
137
<hr>
 
138
<div class="refsect2">
 
139
<a name="changed"></a><h3>changed ()</h3>
 
140
<pre class="programlisting"><span class="returnvalue">void</span>                (*changed)                          (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
141
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> *obj</code></em>);</pre>
 
142
</div>
 
143
<hr>
 
144
<div class="refsect2">
 
145
<a name="up-device-get-history-sync"></a><h3>up_device_get_history_sync ()</h3>
 
146
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         up_device_get_history_sync          (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
147
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 
148
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timespec</code></em>,
 
149
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> resolution</code></em>,
 
150
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
151
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
152
<p>
 
153
Gets the device history.
 
154
</p>
 
155
<div class="variablelist"><table border="0" class="variablelist">
 
156
<colgroup>
 
157
<col align="left" valign="top">
 
158
<col>
 
159
</colgroup>
 
160
<tbody>
 
161
<tr>
 
162
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
163
<td>a <span class="type">UpDevice</span> instance.</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
167
<td>The type of history, known values are "rate" and "charge".</td>
 
168
</tr>
 
169
<tr>
 
170
<td><p><span class="term"><em class="parameter"><code>timespec</code></em> :</span></p></td>
 
171
<td>the amount of time to look back into time.</td>
 
172
</tr>
 
173
<tr>
 
174
<td><p><span class="term"><em class="parameter"><code>resolution</code></em> :</span></p></td>
 
175
<td>the resolution of data.</td>
 
176
</tr>
 
177
<tr>
 
178
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
179
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
180
</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
184
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
188
<td>an array of <span class="type">UpHistoryItem</span>'s, with the most
 
189
recent one being first; <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>error</code></em> is set or <em class="parameter"><code>device</code></em> is
 
190
invalid. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
191
</td>
 
192
</tr>
 
193
</tbody>
 
194
</table></div>
 
195
<p class="since">Since 0.9.0</p>
 
196
</div>
 
197
<hr>
 
198
<div class="refsect2">
 
199
<a name="up-device-get-object-path"></a><h3>up_device_get_object_path ()</h3>
 
200
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       up_device_get_object_path           (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>);</pre>
 
201
<p>
 
202
Gets the object path for the device.
 
203
</p>
 
204
<div class="variablelist"><table border="0" class="variablelist">
 
205
<colgroup>
 
206
<col align="left" valign="top">
 
207
<col>
 
208
</colgroup>
 
209
<tbody>
 
210
<tr>
 
211
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
212
<td>a <span class="type">UpDevice</span> instance.</td>
 
213
</tr>
 
214
<tr>
 
215
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
216
<td>the object path, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
217
</td>
 
218
</tr>
 
219
</tbody>
 
220
</table></div>
 
221
<p class="since">Since 0.9.0</p>
 
222
</div>
 
223
<hr>
 
224
<div class="refsect2">
 
225
<a name="up-device-get-statistics-sync"></a><h3>up_device_get_statistics_sync ()</h3>
 
226
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> *         up_device_get_statistics_sync       (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
227
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
 
228
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
229
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
230
<p>
 
231
Gets the device current statistics.
 
232
</p>
 
233
<div class="variablelist"><table border="0" class="variablelist">
 
234
<colgroup>
 
235
<col align="left" valign="top">
 
236
<col>
 
237
</colgroup>
 
238
<tbody>
 
239
<tr>
 
240
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
241
<td>a <span class="type">UpDevice</span> instance.</td>
 
242
</tr>
 
243
<tr>
 
244
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
 
245
<td>the type of statistics.</td>
 
246
</tr>
 
247
<tr>
 
248
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
249
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
250
</td>
 
251
</tr>
 
252
<tr>
 
253
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
254
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
255
</tr>
 
256
<tr>
 
257
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
258
<td>an array of <span class="type">UpStatsItem</span>'s, else <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><span class="type">NULL</span></a> and <em class="parameter"><code>error</code></em> is used. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
259
</td>
 
260
</tr>
 
261
</tbody>
 
262
</table></div>
 
263
<p class="since">Since 0.9.0</p>
 
264
</div>
 
265
<hr>
 
266
<div class="refsect2">
 
267
<a name="up-device-new"></a><h3>up_device_new ()</h3>
 
268
<pre class="programlisting"><span class="returnvalue">UpDevice</span> *          up_device_new                       (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
269
<p>
 
270
Creates a new <span class="type">UpDevice</span> object.
 
271
</p>
 
272
<div class="variablelist"><table border="0" class="variablelist">
 
273
<colgroup>
 
274
<col align="left" valign="top">
 
275
<col>
 
276
</colgroup>
 
277
<tbody><tr>
 
278
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
279
<td>a new UpDevice object.</td>
 
280
</tr></tbody>
 
281
</table></div>
 
282
<p class="since">Since 0.9.0</p>
 
283
</div>
 
284
<hr>
 
285
<div class="refsect2">
 
286
<a name="up-device-refresh-sync"></a><h3>up_device_refresh_sync ()</h3>
 
287
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            up_device_refresh_sync              (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
288
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
289
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
290
<p>
 
291
Refreshes properties on the device.
 
292
This function is normally not required.
 
293
</p>
 
294
<div class="variablelist"><table border="0" class="variablelist">
 
295
<colgroup>
 
296
<col align="left" valign="top">
 
297
<col>
 
298
</colgroup>
 
299
<tbody>
 
300
<tr>
 
301
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
302
<td>a <span class="type">UpDevice</span> instance.</td>
 
303
</tr>
 
304
<tr>
 
305
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
306
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
307
</td>
 
308
</tr>
 
309
<tr>
 
310
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
311
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
312
</tr>
 
313
<tr>
 
314
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
315
<td>
 
316
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> for success, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> and <em class="parameter"><code>error</code></em> is used</td>
 
317
</tr>
 
318
</tbody>
 
319
</table></div>
 
320
<p class="since">Since 0.9.0</p>
 
321
</div>
 
322
<hr>
 
323
<div class="refsect2">
 
324
<a name="up-device-set-object-path-sync"></a><h3>up_device_set_object_path_sync ()</h3>
 
325
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            up_device_set_object_path_sync      (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>,
 
326
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
 
327
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
328
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
329
<p>
 
330
Sets the object path of the object and fills up initial properties.
 
331
</p>
 
332
<div class="variablelist"><table border="0" class="variablelist">
 
333
<colgroup>
 
334
<col align="left" valign="top">
 
335
<col>
 
336
</colgroup>
 
337
<tbody>
 
338
<tr>
 
339
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
340
<td>a <span class="type">UpDevice</span> instance.</td>
 
341
</tr>
 
342
<tr>
 
343
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
 
344
<td>The UPower object path.</td>
 
345
</tr>
 
346
<tr>
 
347
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
348
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
349
</td>
 
350
</tr>
 
351
<tr>
 
352
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
353
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
 
354
</tr>
 
355
<tr>
 
356
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
357
<td>
 
358
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> for success, else <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> and <em class="parameter"><code>error</code></em> is used</td>
 
359
</tr>
 
360
</tbody>
 
361
</table></div>
 
362
<p class="since">Since 0.9.0</p>
 
363
</div>
 
364
<hr>
 
365
<div class="refsect2">
 
366
<a name="up-device-to-text"></a><h3>up_device_to_text ()</h3>
 
367
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             up_device_to_text                   (<em class="parameter"><code><span class="type">UpDevice</span> *device</code></em>);</pre>
 
368
<p>
 
369
Converts the device to a string description.
 
370
</p>
 
371
<div class="variablelist"><table border="0" class="variablelist">
 
372
<colgroup>
 
373
<col align="left" valign="top">
 
374
<col>
 
375
</colgroup>
 
376
<tbody>
 
377
<tr>
 
378
<td><p><span class="term"><em class="parameter"><code>device</code></em> :</span></p></td>
 
379
<td>a <span class="type">UpDevice</span> instance.</td>
 
380
</tr>
 
381
<tr>
 
382
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
383
<td>text representation of <span class="type">UpDevice</span>
 
384
</td>
 
385
</tr>
 
386
</tbody>
 
387
</table></div>
 
388
<p class="since">Since 0.9.0</p>
 
389
</div>
 
390
</div>
 
391
</div>
 
392
<div class="footer">
 
393
<hr>
 
394
          Generated by GTK-Doc V1.19</div>
 
395
</body>
 
396
</html>
 
 
b'\\ No newline at end of file'