~ubuntu-branches/ubuntu/wily/telepathy-glib/wily

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-dbus-properties-mixin.html

Tags: upstream-0.7.13
Import upstream version 0.7.13

Show diffs side-by-side

added added

removed removed

Lines of Context:
152
152
                                                         <a
153
153
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
154
154
>gpointer</a> iface_data);
 
155
<a
 
156
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
157
>gboolean</a>            <a class="link" href="telepathy-glib-dbus-properties-mixin.html#tp-dbus-properties-mixin-get" title="tp_dbus_properties_mixin_get ()">tp_dbus_properties_mixin_get</a>        (<a
 
158
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
159
>GObject</a> *self,
 
160
                                                         const <a
 
161
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
162
>gchar</a> *interface_name,
 
163
                                                         const <a
 
164
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
165
>gchar</a> *property_name,
 
166
                                                         <a
 
167
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
 
168
>GValue</a> *value,
 
169
                                                         <a
 
170
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
171
>GError</a> **error);
155
172
</pre>
156
173
</div>
157
174
<div class="refsect1" lang="en">
949
966
</tbody>
950
967
</table></div>
951
968
</div>
 
969
<hr>
 
970
<div class="refsect2" lang="en">
 
971
<a name="tp-dbus-properties-mixin-get"></a><h3>tp_dbus_properties_mixin_get ()</h3>
 
972
<pre class="programlisting"><a
 
973
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
974
>gboolean</a>            tp_dbus_properties_mixin_get        (<a
 
975
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
976
>GObject</a> *self,
 
977
                                                         const <a
 
978
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
979
>gchar</a> *interface_name,
 
980
                                                         const <a
 
981
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
982
>gchar</a> *property_name,
 
983
                                                         <a
 
984
href="/usr/share/gtk-doc/html/gobject/gobject-Generic-values.html#GValue"
 
985
>GValue</a> *value,
 
986
                                                         <a
 
987
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
988
>GError</a> **error);</pre>
 
989
<p>
 
990
Initialize <em class="parameter"><code>value</code></em> with the type of the property <em class="parameter"><code>property_name</code></em> on
 
991
<em class="parameter"><code>interface_name</code></em>, and write the value of that property into it as if
 
992
by calling the D-Bus method org.freedesktop.DBus.Properties.Get.
 
993
</p>
 
994
<p>
 
995
If Get would return a D-Bus error, <em class="parameter"><code>value</code></em> remains unset and <em class="parameter"><code>error</code></em>
 
996
is filled in instead.</p>
 
997
<p>
 
998
 
 
999
</p>
 
1000
<div class="variablelist"><table border="0">
 
1001
<col align="left" valign="top">
 
1002
<tbody>
 
1003
<tr>
 
1004
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 
1005
<td> an object with this mixin
 
1006
</td>
 
1007
</tr>
 
1008
<tr>
 
1009
<td><p><span class="term"><em class="parameter"><code>interface_name</code></em> :</span></p></td>
 
1010
<td> a D-Bus interface name
 
1011
</td>
 
1012
</tr>
 
1013
<tr>
 
1014
<td><p><span class="term"><em class="parameter"><code>property_name</code></em> :</span></p></td>
 
1015
<td> a D-Bus property name
 
1016
</td>
 
1017
</tr>
 
1018
<tr>
 
1019
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
 
1020
<td> an unset GValue (initialized to all zeroes)
 
1021
</td>
 
1022
</tr>
 
1023
<tr>
 
1024
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1025
<td> used to return an error on failure
 
1026
</td>
 
1027
</tr>
 
1028
<tr>
 
1029
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1030
<td> <a
 
1031
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
1032
><code class="literal">TRUE</code></a> (filling <em class="parameter"><code>value</code></em>) on success, <a
 
1033
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
1034
><code class="literal">FALSE</code></a> (setting <em class="parameter"><code>error</code></em>)
 
1035
 on failure
 
1036
</td>
 
1037
</tr>
 
1038
</tbody>
 
1039
</table></div>
 
1040
<p class="since">Since  0.7.13
 
1041
</p>
 
1042
</div>
952
1043
</div>
953
1044
<div class="refsect1" lang="en">
954
1045
<a name="telepathy-glib-dbus-properties-mixin.see-also"></a><h2>See Also</h2>