File: telepathy-glib-handle.html

package info (click to toggle)
telepathy-glib 0.24.2-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 31,756 kB
  • sloc: ansic: 124,638; xml: 34,410; sh: 4,531; python: 3,528; makefile: 1,722; javascript: 211; cpp: 16
file content (195 lines) | stat: -rw-r--r-- 8,484 bytes parent folder | download | duplicates (3) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpHandle: telepathy-glib API Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-protocol.html" title="The Telepathy protocol">
<link rel="prev" href="telepathy-glib-defs.html" title="Miscellaneous definitions">
<link rel="next" href="telepathy-glib-interfaces.html" title="Telepathy protocol interface and property names">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#telepathy-glib-handle.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch-protocol.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="telepathy-glib-defs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="telepathy-glib-interfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="telepathy-glib-handle"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-handle.top_of_page"></a>TpHandle</span></h2>
<p>TpHandle — type representing handles</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="telepathy-glib-handle.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-handle.html#tp-handle-type-is-valid" title="tp_handle_type_is_valid ()">tp_handle_type_is_valid</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="telepathy-glib-handle.html#tp-handle-type-to-string" title="tp_handle_type_to_string ()">tp_handle_type_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle">TpHandle</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="telepathy-glib-handle.html#TP-TYPE-HANDLE:CAPS" title="TP_TYPE_HANDLE">TP_TYPE_HANDLE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="telepathy-glib-handle.html#TP-UNKNOWN-HANDLE-TYPE:CAPS" title="TP_UNKNOWN_HANDLE_TYPE">TP_UNKNOWN_HANDLE_TYPE</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;telepathy-glib/telepathy-glib.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.description"></a><h2>Description</h2>
<p>The TpHandle type represents a Telepathy handle.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tp-handle-type-is-valid"></a><h3>tp_handle_type_is_valid ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
tp_handle_type_is_valid (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> type</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>If the given handle type is valid, return <code class="literal">TRUE</code>. If not, set <em class="parameter"><code>error</code></em>

and return <code class="literal">FALSE</code>.</p>
<div class="refsect3">
<a name="tp-handle-type-is-valid.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>A handle type, valid or not, to be checked</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Set if the handle type is invalid</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-handle-type-is-valid.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the handle type is valid.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tp-handle-type-to-string"></a><h3>tp_handle_type_to_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
tp_handle_type_to_string (<em class="parameter"><code><a class="link" href="telepathy-glib-enums.html#TpHandleType" title="enum TpHandleType"><span class="type">TpHandleType</span></a> type</code></em>);</pre>
<p></p>
<div class="refsect3">
<a name="tp-handle-type-to-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>A handle type, which need not be valid</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="tp-handle-type-to-string.returns"></a><h4>Returns</h4>
<p> a human-readable string describing the handle type, e.g. "contact".
For invalid handle types, returns "(no handle)" for 0 or
"(invalid handle type)" for others.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TpHandle"></a><h3>TpHandle</h3>
<pre class="programlisting">typedef guint TpHandle;
</pre>
<p>Type representing Telepathy handles within telepathy-glib.</p>
<p>This is guint despite the wire protocol having 32-bit integers, because
dbus-glib expects GArrays of guint and so on. If the dbus-glib ABI changes
in future, telepathy-glib is likely to have a matching ABI change.</p>
</div>
<hr>
<div class="refsect2">
<a name="TP-TYPE-HANDLE:CAPS"></a><h3>TP_TYPE_HANDLE</h3>
<pre class="programlisting">#define TP_TYPE_HANDLE G_TYPE_UINT
</pre>
<p>The GType of a TpHandle, currently G_TYPE_UINT.</p>
<p>This won't change unless in an ABI-incompatible version of telepathy-glib.</p>
</div>
<hr>
<div class="refsect2">
<a name="TP-UNKNOWN-HANDLE-TYPE:CAPS"></a><h3>TP_UNKNOWN_HANDLE_TYPE</h3>
<pre class="programlisting">#define TP_UNKNOWN_HANDLE_TYPE ((TpHandleType) -1)
</pre>
<p>An invalid handle type (-1 cast to TpHandleType) used to represent an
unknown handle type.</p>
<p class="since">Since: 0.7.0</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-handle.see-also"></a><h2>See Also</h2>
<p>TpHandleRepoIface</p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>