~ubuntu-branches/ubuntu/precise/telepathy-glib/precise-201111172307

« back to all changes in this revision

Viewing changes to docs/reference/html/telepathy-glib-handle.html

  • Committer: Ken VanDine
  • Date: 2011-11-17 20:53:21 UTC
  • mfrom: (1.6.34 upstream)
  • Revision ID: ken.vandine@canonical.com-20111117205321-l704j7kr1zgw5v9h
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch-protocol.html" title="The Telepathy protocol">
9
9
<link rel="prev" href="telepathy-glib-defs.html" title="Miscellaneous definitions">
10
10
<link rel="next" href="telepathy-glib-interfaces.html" title="Telepathy protocol interface and property names">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
43
43
typedef             <a class="link" href="telepathy-glib-handle.html#TpHandle" title="TpHandle">TpHandle</a>;
44
44
#define             <a class="link" href="telepathy-glib-handle.html#TP-TYPE-HANDLE:CAPS" title="TP_TYPE_HANDLE">TP_TYPE_HANDLE</a>
45
45
#define             <a class="link" href="telepathy-glib-handle.html#TP-UNKNOWN-HANDLE-TYPE:CAPS" title="TP_UNKNOWN_HANDLE_TYPE">TP_UNKNOWN_HANDLE_TYPE</a>
46
 
<span class="returnvalue">gboolean</span>            <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>             (<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>,
47
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
48
 
const <span class="returnvalue">gchar</span> *       <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>            (<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>);
 
46
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <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>             (<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>,
 
47
                                                         <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>);
 
48
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="telepathy-glib-handle.html#tp-handle-type-to-string" title="tp_handle_type_to_string ()">tp_handle_type_to_string</a>            (<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>);
49
49
</pre>
50
50
</div>
51
51
<div class="refsect1">
95
95
<hr>
96
96
<div class="refsect2">
97
97
<a name="tp-handle-type-is-valid"></a><h3>tp_handle_type_is_valid ()</h3>
98
 
<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>,
99
 
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
98
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 
99
                                                         <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>
100
100
<p>
101
 
If the given handle type is valid, return <code class="literal">TRUE</code>. If not, set <em class="parameter"><code>error</code></em>
102
 
and return <code class="literal">FALSE</code>.
 
101
If the given handle type is valid, return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. If not, set <em class="parameter"><code>error</code></em>
 
102
and return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
103
103
</p>
104
104
<div class="variablelist"><table border="0">
105
105
<col align="left" valign="top">
115
115
<tr>
116
116
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
117
117
<td>
118
 
<code class="literal">TRUE</code> if the handle type is valid.</td>
 
118
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the handle type is valid.</td>
119
119
</tr>
120
120
</tbody>
121
121
</table></div>
123
123
<hr>
124
124
<div class="refsect2">
125
125
<a name="tp-handle-type-to-string"></a><h3>tp_handle_type_to_string ()</h3>
126
 
<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>
 
126
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
127
127
<p>
128
128
 
129
129
</p>
151
151
</div>
152
152
<div class="footer">
153
153
<hr>
154
 
          Generated by GTK-Doc V1.17</div>
 
154
          Generated by GTK-Doc V1.18</div>
155
155
</body>
156
156
</html>
 
 
b'\\ No newline at end of file'