Moving files to packaging and extracing new tarball.
[profile/ivi/glib2.git] / docs / reference / gio / html / gio-D-Bus-Utilities.html
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>D-Bus Utilities</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GIO Reference Manual">
8 <link rel="up" href="gdbus-lowlevel.html" title="Lowlevel D-Bus Support">
9 <link rel="prev" href="gdbus-lowlevel.html" title="Lowlevel D-Bus Support">
10 <link rel="next" href="gio-D-Bus-Addresses.html" title="D-Bus Addresses">
11 <meta name="generator" content="GTK-Doc V1.18 (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="gdbus-lowlevel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="gdbus-lowlevel.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">GIO Reference Manual</th>
21 <td><a accesskey="n" href="gio-D-Bus-Addresses.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="#gio-D-Bus-Utilities.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gio-D-Bus-Utilities.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gio-D-Bus-Utilities"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gio-D-Bus-Utilities.top_of_page"></a>D-Bus Utilities</span></h2>
34 <p>D-Bus Utilities — Various utilities related to D-Bus.</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gio-D-Bus-Utilities.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">
41 #include &lt;gio/gio.h&gt;
42
43 <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-generate-guid" title="g_dbus_generate_guid ()">g_dbus_generate_guid</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
44 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-is-guid" title="g_dbus_is_guid ()">g_dbus_is_guid</a>                      (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
45 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-is-name" title="g_dbus_is_name ()">g_dbus_is_name</a>                      (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
46 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-is-unique-name" title="g_dbus_is_unique_name ()">g_dbus_is_unique_name</a>               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
47 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-is-member-name" title="g_dbus_is_member_name ()">g_dbus_is_member_name</a>               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
48 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-is-interface-name" title="g_dbus_is_interface_name ()">g_dbus_is_interface_name</a>            (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);
49 <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-gvalue-to-gvariant" title="g_dbus_gvalue_to_gvariant ()">g_dbus_gvalue_to_gvariant</a>           (<em class="parameter"><code>const <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *gvalue</code></em>,
50                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> *type</code></em>);
51 <span class="returnvalue">void</span>                <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-gvariant-to-gvalue" title="g_dbus_gvariant_to_gvalue ()">g_dbus_gvariant_to_gvalue</a>           (<em class="parameter"><code><a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
52                                                          <em class="parameter"><code><a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *out_gvalue</code></em>);
53 </pre>
54 </div>
55 <div class="refsect1">
56 <a name="gio-D-Bus-Utilities.description"></a><h2>Description</h2>
57 <p>
58 Various utility routines related to D-Bus.
59 </p>
60 </div>
61 <div class="refsect1">
62 <a name="gio-D-Bus-Utilities.details"></a><h2>Details</h2>
63 <div class="refsect2">
64 <a name="g-dbus-generate-guid"></a><h3>g_dbus_generate_guid ()</h3>
65 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             g_dbus_generate_guid                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
66 <p>
67 Generate a D-Bus GUID that can be used with
68 e.g. <a class="link" href="GDBusConnection.html#g-dbus-connection-new" title="g_dbus_connection_new ()"><code class="function">g_dbus_connection_new()</code></a>.
69 </p>
70 <p>
71 See the D-Bus specification regarding what strings are valid D-Bus
72 GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
73 </p>
74 <div class="variablelist"><table border="0">
75 <col align="left" valign="top">
76 <tbody><tr>
77 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
78 <td>A valid D-Bus GUID. Free with <a href="./../glib/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</td>
79 </tr></tbody>
80 </table></div>
81 <p class="since">Since 2.26</p>
82 </div>
83 <hr>
84 <div class="refsect2">
85 <a name="g-dbus-is-guid"></a><h3>g_dbus_is_guid ()</h3>
86 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_is_guid                      (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
87 <p>
88 Checks if <em class="parameter"><code>string</code></em> is a D-Bus GUID.
89 </p>
90 <p>
91 See the D-Bus specification regarding what strings are valid D-Bus
92 GUID (for example, D-Bus GUIDs are not RFC-4122 compliant).
93 </p>
94 <div class="variablelist"><table border="0">
95 <col align="left" valign="top">
96 <tbody>
97 <tr>
98 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
99 <td>The string to check.</td>
100 </tr>
101 <tr>
102 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
103 <td>
104 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>string</code></em> is a guid, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
105 </tr>
106 </tbody>
107 </table></div>
108 <p class="since">Since 2.26</p>
109 </div>
110 <hr>
111 <div class="refsect2">
112 <a name="g-dbus-is-name"></a><h3>g_dbus_is_name ()</h3>
113 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_is_name                      (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
114 <p>
115 Checks if <em class="parameter"><code>string</code></em> is a valid D-Bus bus name (either unique or well-known).
116 </p>
117 <div class="variablelist"><table border="0">
118 <col align="left" valign="top">
119 <tbody>
120 <tr>
121 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
122 <td>The string to check.</td>
123 </tr>
124 <tr>
125 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
126 <td>
127 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if valid, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
128 </tr>
129 </tbody>
130 </table></div>
131 <p class="since">Since 2.26</p>
132 </div>
133 <hr>
134 <div class="refsect2">
135 <a name="g-dbus-is-unique-name"></a><h3>g_dbus_is_unique_name ()</h3>
136 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_is_unique_name               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
137 <p>
138 Checks if <em class="parameter"><code>string</code></em> is a valid D-Bus unique bus name.
139 </p>
140 <div class="variablelist"><table border="0">
141 <col align="left" valign="top">
142 <tbody>
143 <tr>
144 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
145 <td>The string to check.</td>
146 </tr>
147 <tr>
148 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
149 <td>
150 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if valid, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
151 </tr>
152 </tbody>
153 </table></div>
154 <p class="since">Since 2.26</p>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="g-dbus-is-member-name"></a><h3>g_dbus_is_member_name ()</h3>
159 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_is_member_name               (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
160 <p>
161 Checks if <em class="parameter"><code>string</code></em> is a valid D-Bus member (e.g. signal or method) name.
162 </p>
163 <div class="variablelist"><table border="0">
164 <col align="left" valign="top">
165 <tbody>
166 <tr>
167 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
168 <td>The string to check.</td>
169 </tr>
170 <tr>
171 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
172 <td>
173 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if valid, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
174 </tr>
175 </tbody>
176 </table></div>
177 <p class="since">Since 2.26</p>
178 </div>
179 <hr>
180 <div class="refsect2">
181 <a name="g-dbus-is-interface-name"></a><h3>g_dbus_is_interface_name ()</h3>
182 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_is_interface_name            (<em class="parameter"><code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>);</pre>
183 <p>
184 Checks if <em class="parameter"><code>string</code></em> is a valid D-Bus interface name.
185 </p>
186 <div class="variablelist"><table border="0">
187 <col align="left" valign="top">
188 <tbody>
189 <tr>
190 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
191 <td>The string to check.</td>
192 </tr>
193 <tr>
194 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
195 <td>
196 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if valid, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
197 </tr>
198 </tbody>
199 </table></div>
200 <p class="since">Since 2.26</p>
201 </div>
202 <hr>
203 <div class="refsect2">
204 <a name="g-dbus-gvalue-to-gvariant"></a><h3>g_dbus_gvalue_to_gvariant ()</h3>
205 <pre class="programlisting"><a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *          g_dbus_gvalue_to_gvariant           (<em class="parameter"><code>const <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *gvalue</code></em>,
206                                                          <em class="parameter"><code>const <a href="./../glib/glib/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a> *type</code></em>);</pre>
207 <p>
208 Converts a <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to a <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of the type indicated by the <em class="parameter"><code>type</code></em> parameter.
209 </p>
210 <p>
211 The conversion is using the following rules:
212 </p>
213 <div class="table">
214 <a name="id864450"></a><p class="title"><b>Table 4. <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> / <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> conversion rules</b></p>
215 <div class="table-contents"><table summary="GValue / GVariant conversion rules" border="1">
216 <colgroup>
217 <col>
218 <col>
219 </colgroup>
220 <thead><tr>
221 <th align="left">If the <a href="./../gobject/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <em class="parameter"><code>gvalue</code></em> is...</th>
222 <th align="left">... then <em class="parameter"><code>type</code></em> must be</th>
223 </tr></thead>
224 <tbody>
225 <tr>
226 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><span class="type">G_TYPE_STRING</span></a></td>
227 <td align="left">
228 <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-STRING:CAPS">'s'</a>, <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-OBJECT-PATH:CAPS">'o'</a>, <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-SIGNATURE:CAPS">'g'</a> or <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-BYTESTRING:CAPS">'ay'</a>
229 </td>
230 </tr>
231 <tr>
232 <td align="left"><a href="./../gobject/gobject/gobject-Boxed-Types.html#G-TYPE-STRV:CAPS"><span class="type">G_TYPE_STRV</span></a></td>
233 <td align="left">
234 <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-STRING-ARRAY:CAPS">'as'</a>, <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-OBJECT-PATH-ARRAY:CAPS">'ao'</a> or <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-BYTESTRING-ARRAY:CAPS">'aay'</a>
235 </td>
236 </tr>
237 <tr>
238 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS"><span class="type">G_TYPE_BOOLEAN</span></a></td>
239 <td align="left"><a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-BOOLEAN:CAPS">'b'</a></td>
240 </tr>
241 <tr>
242 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-UCHAR:CAPS"><span class="type">G_TYPE_UCHAR</span></a></td>
243 <td align="left"><a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-BYTE:CAPS">'y'</a></td>
244 </tr>
245 <tr>
246 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-INT:CAPS"><span class="type">G_TYPE_INT</span></a></td>
247 <td align="left">
248 <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-INT32:CAPS">'i'</a> or <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-INT16:CAPS">'n'</a>
249 </td>
250 </tr>
251 <tr>
252 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-UINT:CAPS"><span class="type">G_TYPE_UINT</span></a></td>
253 <td align="left">
254 <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-UINT32:CAPS">'u'</a> or <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-UINT16:CAPS">'q'</a>
255 </td>
256 </tr>
257 <tr>
258 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-INT64:CAPS"><span class="type">G_TYPE_INT64</span></a></td>
259 <td align="left"><a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-INT64:CAPS">'x'</a></td>
260 </tr>
261 <tr>
262 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-UINT64:CAPS"><span class="type">G_TYPE_UINT64</span></a></td>
263 <td align="left"><a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-UINT64:CAPS">'t'</a></td>
264 </tr>
265 <tr>
266 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-DOUBLE:CAPS"><span class="type">G_TYPE_DOUBLE</span></a></td>
267 <td align="left"><a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-DOUBLE:CAPS">'d'</a></td>
268 </tr>
269 <tr>
270 <td align="left"><a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-VARIANT:CAPS"><span class="type">G_TYPE_VARIANT</span></a></td>
271 <td align="left">Any <a href="./../glib/glib/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a>
272 </td>
273 </tr>
274 </tbody>
275 </table></div>
276 </div>
277 <p><br class="table-break">
278 This can fail if e.g. <em class="parameter"><code>gvalue</code></em> is of type <a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><span class="type">G_TYPE_STRING</span></a> and <em class="parameter"><code>type</code></em>
279 is <a href="./../glib/glib/glib-GVariantType.html#G-VARIANT-TYPE-INT32:CAPS">'i'</a>. It will
280 also fail for any <a href="./../gobject/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> (including e.g. <a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-OBJECT:CAPS"><span class="type">G_TYPE_OBJECT</span></a> and
281 <a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-BOXED:CAPS"><span class="type">G_TYPE_BOXED</span></a> derived-types) not in the table above.
282 </p>
283 <p>
284 Note that if <em class="parameter"><code>gvalue</code></em> is of type <a href="./../gobject/gobject/gobject-Type-Information.html#G-TYPE-VARIANT:CAPS"><span class="type">G_TYPE_VARIANT</span></a> and its value is
285 <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <span class="emphasis"><em>empty</em></span> <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> instance (never
286 <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) for <em class="parameter"><code>type</code></em> is returned (e.g. 0 for scalar types, the empty
287 string for string types, <code class="literal">'/'</code> for object path
288 types, the empty array for any array type and so on).
289 </p>
290 <p>
291 See the <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-gvariant-to-gvalue" title="g_dbus_gvariant_to_gvalue ()"><code class="function">g_dbus_gvariant_to_gvalue()</code></a> function for how to convert a
292 <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to a <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>.
293 </p>
294 <div class="variablelist"><table border="0">
295 <col align="left" valign="top">
296 <tbody>
297 <tr>
298 <td><p><span class="term"><em class="parameter"><code>gvalue</code></em> :</span></p></td>
299 <td>A <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> to convert to a <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.</td>
300 </tr>
301 <tr>
302 <td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
303 <td>A <a href="./../glib/glib/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a>.</td>
304 </tr>
305 <tr>
306 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
307 <td>A <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> (never floating) of <a href="./../glib/glib/glib-GVariantType.html#GVariantType"><span class="type">GVariantType</span></a>
308 <em class="parameter"><code>type</code></em> holding the data from <em class="parameter"><code>gvalue</code></em> or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in case of
309 failure. Free with <a href="./../glib/glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>.</td>
310 </tr>
311 </tbody>
312 </table></div>
313 <p class="since">Since 2.30</p>
314 </div>
315 <hr>
316 <div class="refsect2">
317 <a name="g-dbus-gvariant-to-gvalue"></a><h3>g_dbus_gvariant_to_gvalue ()</h3>
318 <pre class="programlisting"><span class="returnvalue">void</span>                g_dbus_gvariant_to_gvalue           (<em class="parameter"><code><a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *value</code></em>,
319                                                          <em class="parameter"><code><a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *out_gvalue</code></em>);</pre>
320 <p>
321 Converts a <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> to a <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>. If <em class="parameter"><code>value</code></em> is floating, it is consumed.
322 </p>
323 <p>
324 The rules specified in the <a class="link" href="gio-D-Bus-Utilities.html#g-dbus-gvalue-to-gvariant" title="g_dbus_gvalue_to_gvariant ()"><code class="function">g_dbus_gvalue_to_gvariant()</code></a> function are
325 used - this function is essentially its reverse form.
326 </p>
327 <p>
328 The conversion never fails - a valid <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> is always returned in
329 <em class="parameter"><code>out_gvalue</code></em>.
330 </p>
331 <div class="variablelist"><table border="0">
332 <col align="left" valign="top">
333 <tbody>
334 <tr>
335 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
336 <td>A <a href="./../glib/glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>.</td>
337 </tr>
338 <tr>
339 <td><p><span class="term"><em class="parameter"><code>out_gvalue</code></em> :</span></p></td>
340 <td>Return location pointing to a zero-filled (uninitialized) <a href="./../gobject/gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>.</td>
341 </tr>
342 </tbody>
343 </table></div>
344 <p class="since">Since 2.30</p>
345 </div>
346 </div>
347 </div>
348 <div class="footer">
349 <hr>
350           Generated by GTK-Doc V1.18</div>
351 </body>
352 </html>