Imported Upstream version 1.49.1
[platform/upstream/gobject-introspection.git] / docs / reference / html / gi-GICallableInfo.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>GICallableInfo: GObject Introspection Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="GObject Introspection Reference Manual">
8 <link rel="up" href="ch01.html" title="GIRepository">
9 <link rel="prev" href="gi-GIBaseInfo.html" title="GIBaseInfo">
10 <link rel="next" href="gi-GIFunctionInfo.html" title="GIFunctionInfo">
11 <meta name="generator" content="GTK-Doc V1.25.1 (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="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18                   <a href="#gi-GICallableInfo.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="gi-GIBaseInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gi-GIFunctionInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="gi-GICallableInfo"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="gi-GICallableInfo.top_of_page"></a>GICallableInfo</span></h2>
30 <p>GICallableInfo — Struct representing a callable</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="gi-GICallableInfo.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="define_keyword">#define</td>
44 <td class="function_name">
45 <a class="link" href="gi-GICallableInfo.html#GI-IS-CALLABLE-INFO:CAPS" title="GI_IS_CALLABLE_INFO()">GI_IS_CALLABLE_INFO</a><span class="c_punctuation">()</span>
46 </td>
47 </tr>
48 <tr>
49 <td class="function_type">
50 <span class="returnvalue">gboolean</span>
51 </td>
52 <td class="function_name">
53 <a class="link" href="gi-GICallableInfo.html#g-callable-info-can-throw-gerror" title="g_callable_info_can_throw_gerror ()">g_callable_info_can_throw_gerror</a> <span class="c_punctuation">()</span>
54 </td>
55 </tr>
56 <tr>
57 <td class="function_type">
58 <span class="returnvalue">gint</span>
59 </td>
60 <td class="function_name">
61 <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-n-args" title="g_callable_info_get_n_args ()">g_callable_info_get_n_args</a> <span class="c_punctuation">()</span>
62 </td>
63 </tr>
64 <tr>
65 <td class="function_type">
66 <a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="returnvalue">GIArgInfo</span></a> *
67 </td>
68 <td class="function_name">
69 <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-arg" title="g_callable_info_get_arg ()">g_callable_info_get_arg</a> <span class="c_punctuation">()</span>
70 </td>
71 </tr>
72 <tr>
73 <td class="function_type">
74 <a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>
75 </td>
76 <td class="function_name">
77 <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-caller-owns" title="g_callable_info_get_caller_owns ()">g_callable_info_get_caller_owns</a> <span class="c_punctuation">()</span>
78 </td>
79 </tr>
80 <tr>
81 <td class="function_type">const <span class="returnvalue">gchar</span> *
82 </td>
83 <td class="function_name">
84 <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-return-attribute" title="g_callable_info_get_return_attribute ()">g_callable_info_get_return_attribute</a> <span class="c_punctuation">()</span>
85 </td>
86 </tr>
87 <tr>
88 <td class="function_type">
89 <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *
90 </td>
91 <td class="function_name">
92 <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-return-type" title="g_callable_info_get_return_type ()">g_callable_info_get_return_type</a> <span class="c_punctuation">()</span>
93 </td>
94 </tr>
95 <tr>
96 <td class="function_type">
97 <span class="returnvalue">gboolean</span>
98 </td>
99 <td class="function_name">
100 <a class="link" href="gi-GICallableInfo.html#g-callable-info-invoke" title="g_callable_info_invoke ()">g_callable_info_invoke</a> <span class="c_punctuation">()</span>
101 </td>
102 </tr>
103 <tr>
104 <td class="function_type">
105 <span class="returnvalue">gboolean</span>
106 </td>
107 <td class="function_name">
108 <a class="link" href="gi-GICallableInfo.html#g-callable-info-is-method" title="g_callable_info_is_method ()">g_callable_info_is_method</a> <span class="c_punctuation">()</span>
109 </td>
110 </tr>
111 <tr>
112 <td class="function_type">
113 <span class="returnvalue">gboolean</span>
114 </td>
115 <td class="function_name">
116 <a class="link" href="gi-GICallableInfo.html#g-callable-info-iterate-return-attributes" title="g_callable_info_iterate_return_attributes ()">g_callable_info_iterate_return_attributes</a> <span class="c_punctuation">()</span>
117 </td>
118 </tr>
119 <tr>
120 <td class="function_type">
121 <span class="returnvalue">void</span>
122 </td>
123 <td class="function_name">
124 <a class="link" href="gi-GICallableInfo.html#g-callable-info-load-arg" title="g_callable_info_load_arg ()">g_callable_info_load_arg</a> <span class="c_punctuation">()</span>
125 </td>
126 </tr>
127 <tr>
128 <td class="function_type">
129 <span class="returnvalue">void</span>
130 </td>
131 <td class="function_name">
132 <a class="link" href="gi-GICallableInfo.html#g-callable-info-load-return-type" title="g_callable_info_load_return_type ()">g_callable_info_load_return_type</a> <span class="c_punctuation">()</span>
133 </td>
134 </tr>
135 <tr>
136 <td class="function_type">
137 <span class="returnvalue">gboolean</span>
138 </td>
139 <td class="function_name">
140 <a class="link" href="gi-GICallableInfo.html#g-callable-info-may-return-null" title="g_callable_info_may_return_null ()">g_callable_info_may_return_null</a> <span class="c_punctuation">()</span>
141 </td>
142 </tr>
143 <tr>
144 <td class="function_type">
145 <span class="returnvalue">gboolean</span>
146 </td>
147 <td class="function_name">
148 <a class="link" href="gi-GICallableInfo.html#g-callable-info-skip-return" title="g_callable_info_skip_return ()">g_callable_info_skip_return</a> <span class="c_punctuation">()</span>
149 </td>
150 </tr>
151 </tbody>
152 </table></div>
153 </div>
154 <div class="refsect1">
155 <a name="gi-GICallableInfo.other"></a><h2>Types and Values</h2>
156 <div class="informaltable"><table class="informaltable" width="100%" border="0">
157 <colgroup>
158 <col width="150px" class="name">
159 <col class="description">
160 </colgroup>
161 <tbody><tr>
162 <td class="typedef_keyword">typedef</td>
163 <td class="function_name"><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo">GICallableInfo</a></td>
164 </tr></tbody>
165 </table></div>
166 </div>
167 <div class="refsect1">
168 <a name="gi-GICallableInfo.description"></a><h2>Description</h2>
169 <p>GICallableInfo represents an entity which is callable.
170 Currently a function (<a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>), virtual function,
171 (<a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>) or callback (<a class="link" href="gi-GICallbackInfo.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a>).</p>
172 <p>A callable has a list of arguments (<a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a>), a return type,
173 direction and a flag which decides if it returns null.</p>
174 <div class="refsect1">
175 <a name="gi-gicallableinfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
176 <pre class="synopsis">
177   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
178    +----GICallableInfo
179          +----<a class="link" href="gi-GIFunctionInfo.html" title="GIFunctionInfo">GIFunctionInfo</a>
180          +----<a class="link" href="gi-GISignalInfo.html" title="GISignalInfo">GISignalInfo</a>
181          +----<a class="link" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">GIVFuncInfo</a>
182 </pre>
183 </div>
184 </div>
185 <div class="refsect1">
186 <a name="gi-GICallableInfo.functions_details"></a><h2>Functions</h2>
187 <div class="refsect2">
188 <a name="GI-IS-CALLABLE-INFO:CAPS"></a><h3>GI_IS_CALLABLE_INFO()</h3>
189 <pre class="programlisting">#define             GI_IS_CALLABLE_INFO(info)</pre>
190 <p>Checks if <em class="parameter"><code>info</code></em>
191  is a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> or derived from it.</p>
192 <div class="refsect3">
193 <a name="GI-IS-CALLABLE-INFO.parameters"></a><h4>Parameters</h4>
194 <div class="informaltable"><table class="informaltable" width="100%" border="0">
195 <colgroup>
196 <col width="150px" class="parameters_name">
197 <col class="parameters_description">
198 <col width="200px" class="parameters_annotations">
199 </colgroup>
200 <tbody><tr>
201 <td class="parameter_name"><p>info</p></td>
202 <td class="parameter_description"><p>an info structure</p></td>
203 <td class="parameter_annotations"> </td>
204 </tr></tbody>
205 </table></div>
206 </div>
207 </div>
208 <hr>
209 <div class="refsect2">
210 <a name="g-callable-info-can-throw-gerror"></a><h3>g_callable_info_can_throw_gerror ()</h3>
211 <pre class="programlisting"><span class="returnvalue">gboolean</span>
212 g_callable_info_can_throw_gerror (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
213 <p>TODO</p>
214 <div class="refsect3">
215 <a name="g-callable-info-can-throw-gerror.parameters"></a><h4>Parameters</h4>
216 <div class="informaltable"><table class="informaltable" width="100%" border="0">
217 <colgroup>
218 <col width="150px" class="parameters_name">
219 <col class="parameters_description">
220 <col width="200px" class="parameters_annotations">
221 </colgroup>
222 <tbody><tr>
223 <td class="parameter_name"><p>info</p></td>
224 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
225 <td class="parameter_annotations"> </td>
226 </tr></tbody>
227 </table></div>
228 </div>
229 <div class="refsect3">
230 <a name="g-callable-info-can-throw-gerror.returns"></a><h4>Returns</h4>
231 <p> <code class="literal">TRUE</code> if this <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> can throw a <span class="type">GError</span></p>
232 </div>
233 <p class="since">Since: <a class="link" href="api-index-1-34.html#api-index-1.34">1.34</a></p>
234 </div>
235 <hr>
236 <div class="refsect2">
237 <a name="g-callable-info-get-n-args"></a><h3>g_callable_info_get_n_args ()</h3>
238 <pre class="programlisting"><span class="returnvalue">gint</span>
239 g_callable_info_get_n_args (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
240 <p>Obtain the number of arguments (both IN and OUT) for this callable.</p>
241 <div class="refsect3">
242 <a name="g-callable-info-get-n-args.parameters"></a><h4>Parameters</h4>
243 <div class="informaltable"><table class="informaltable" width="100%" border="0">
244 <colgroup>
245 <col width="150px" class="parameters_name">
246 <col class="parameters_description">
247 <col width="200px" class="parameters_annotations">
248 </colgroup>
249 <tbody><tr>
250 <td class="parameter_name"><p>info</p></td>
251 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
252 <td class="parameter_annotations"> </td>
253 </tr></tbody>
254 </table></div>
255 </div>
256 <div class="refsect3">
257 <a name="g-callable-info-get-n-args.returns"></a><h4>Returns</h4>
258 <p> The number of arguments this callable expects.</p>
259 </div>
260 </div>
261 <hr>
262 <div class="refsect2">
263 <a name="g-callable-info-get-arg"></a><h3>g_callable_info_get_arg ()</h3>
264 <pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="returnvalue">GIArgInfo</span></a> *
265 g_callable_info_get_arg (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
266                          <em class="parameter"><code><span class="type">gint</span> n</code></em>);</pre>
267 <p>Obtain information about a particular argument of this callable.</p>
268 <div class="refsect3">
269 <a name="g-callable-info-get-arg.parameters"></a><h4>Parameters</h4>
270 <div class="informaltable"><table class="informaltable" width="100%" border="0">
271 <colgroup>
272 <col width="150px" class="parameters_name">
273 <col class="parameters_description">
274 <col width="200px" class="parameters_annotations">
275 </colgroup>
276 <tbody>
277 <tr>
278 <td class="parameter_name"><p>info</p></td>
279 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
280 <td class="parameter_annotations"> </td>
281 </tr>
282 <tr>
283 <td class="parameter_name"><p>n</p></td>
284 <td class="parameter_description"><p>the argument index to fetch</p></td>
285 <td class="parameter_annotations"> </td>
286 </tr>
287 </tbody>
288 </table></div>
289 </div>
290 <div class="refsect3">
291 <a name="g-callable-info-get-arg.returns"></a><h4>Returns</h4>
292 <p> the <a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a>. Free it with
293 <a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. </p>
294 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
295 </div>
296 </div>
297 <hr>
298 <div class="refsect2">
299 <a name="g-callable-info-get-caller-owns"></a><h3>g_callable_info_get_caller_owns ()</h3>
300 <pre class="programlisting"><a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="returnvalue">GITransfer</span></a>
301 g_callable_info_get_caller_owns (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
302 <p>See whether the caller owns the return value of this callable.
303 <a class="link" href="gi-GIArgInfo.html#GITransfer" title="enum GITransfer"><span class="type">GITransfer</span></a> contains a list of possible transfer values.</p>
304 <div class="refsect3">
305 <a name="g-callable-info-get-caller-owns.parameters"></a><h4>Parameters</h4>
306 <div class="informaltable"><table class="informaltable" width="100%" border="0">
307 <colgroup>
308 <col width="150px" class="parameters_name">
309 <col class="parameters_description">
310 <col width="200px" class="parameters_annotations">
311 </colgroup>
312 <tbody><tr>
313 <td class="parameter_name"><p>info</p></td>
314 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
315 <td class="parameter_annotations"> </td>
316 </tr></tbody>
317 </table></div>
318 </div>
319 <div class="refsect3">
320 <a name="g-callable-info-get-caller-owns.returns"></a><h4>Returns</h4>
321 <p> the transfer mode for the return value of the callable</p>
322 </div>
323 </div>
324 <hr>
325 <div class="refsect2">
326 <a name="g-callable-info-get-return-attribute"></a><h3>g_callable_info_get_return_attribute ()</h3>
327 <pre class="programlisting">const <span class="returnvalue">gchar</span> *
328 g_callable_info_get_return_attribute (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
329                                       <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
330 <p>Retrieve an arbitrary attribute associated with the return value.</p>
331 <div class="refsect3">
332 <a name="g-callable-info-get-return-attribute.parameters"></a><h4>Parameters</h4>
333 <div class="informaltable"><table class="informaltable" width="100%" border="0">
334 <colgroup>
335 <col width="150px" class="parameters_name">
336 <col class="parameters_description">
337 <col width="200px" class="parameters_annotations">
338 </colgroup>
339 <tbody>
340 <tr>
341 <td class="parameter_name"><p>info</p></td>
342 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
343 <td class="parameter_annotations"> </td>
344 </tr>
345 <tr>
346 <td class="parameter_name"><p>name</p></td>
347 <td class="parameter_description"><p>a freeform string naming an attribute</p></td>
348 <td class="parameter_annotations"> </td>
349 </tr>
350 </tbody>
351 </table></div>
352 </div>
353 <div class="refsect3">
354 <a name="g-callable-info-get-return-attribute.returns"></a><h4>Returns</h4>
355 <p> The value of the attribute, or <code class="literal">NULL</code> if no such attribute exists</p>
356 </div>
357 </div>
358 <hr>
359 <div class="refsect2">
360 <a name="g-callable-info-get-return-type"></a><h3>g_callable_info_get_return_type ()</h3>
361 <pre class="programlisting"><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="returnvalue">GITypeInfo</span></a> *
362 g_callable_info_get_return_type (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
363 <p>Obtain the return type of a callable item as a <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>.</p>
364 <div class="refsect3">
365 <a name="g-callable-info-get-return-type.parameters"></a><h4>Parameters</h4>
366 <div class="informaltable"><table class="informaltable" width="100%" border="0">
367 <colgroup>
368 <col width="150px" class="parameters_name">
369 <col class="parameters_description">
370 <col width="200px" class="parameters_annotations">
371 </colgroup>
372 <tbody><tr>
373 <td class="parameter_name"><p>info</p></td>
374 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
375 <td class="parameter_annotations"> </td>
376 </tr></tbody>
377 </table></div>
378 </div>
379 <div class="refsect3">
380 <a name="g-callable-info-get-return-type.returns"></a><h4>Returns</h4>
381 <p> the <a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a>. Free the struct by calling
382 <a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. </p>
383 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
384 </div>
385 </div>
386 <hr>
387 <div class="refsect2">
388 <a name="g-callable-info-invoke"></a><h3>g_callable_info_invoke ()</h3>
389 <pre class="programlisting"><span class="returnvalue">gboolean</span>
390 g_callable_info_invoke (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
391                         <em class="parameter"><code><span class="type">gpointer</span> function</code></em>,
392                         <em class="parameter"><code>const <a class="link" href="gi-common-types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a> *in_args</code></em>,
393                         <em class="parameter"><code><span class="type">int</span> n_in_args</code></em>,
394                         <em class="parameter"><code>const <a class="link" href="gi-common-types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a> *out_args</code></em>,
395                         <em class="parameter"><code><span class="type">int</span> n_out_args</code></em>,
396                         <em class="parameter"><code><a class="link" href="gi-common-types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a> *return_value</code></em>,
397                         <em class="parameter"><code><span class="type">gboolean</span> is_method</code></em>,
398                         <em class="parameter"><code><span class="type">gboolean</span> throws</code></em>,
399                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
400 <p>TODO</p>
401 <div class="refsect3">
402 <a name="g-callable-info-invoke.parameters"></a><h4>Parameters</h4>
403 <div class="informaltable"><table class="informaltable" width="100%" border="0">
404 <colgroup>
405 <col width="150px" class="parameters_name">
406 <col class="parameters_description">
407 <col width="200px" class="parameters_annotations">
408 </colgroup>
409 <tbody>
410 <tr>
411 <td class="parameter_name"><p>info</p></td>
412 <td class="parameter_description"><p>TODO</p></td>
413 <td class="parameter_annotations"> </td>
414 </tr>
415 <tr>
416 <td class="parameter_name"><p>function</p></td>
417 <td class="parameter_description"><p>TODO</p></td>
418 <td class="parameter_annotations"> </td>
419 </tr>
420 <tr>
421 <td class="parameter_name"><p>in_args</p></td>
422 <td class="parameter_description"><p>TODO</p></td>
423 <td class="parameter_annotations"> </td>
424 </tr>
425 <tr>
426 <td class="parameter_name"><p>n_in_args</p></td>
427 <td class="parameter_description"><p>TODO</p></td>
428 <td class="parameter_annotations"> </td>
429 </tr>
430 <tr>
431 <td class="parameter_name"><p>out_args</p></td>
432 <td class="parameter_description"><p>TODO</p></td>
433 <td class="parameter_annotations"> </td>
434 </tr>
435 <tr>
436 <td class="parameter_name"><p>n_out_args</p></td>
437 <td class="parameter_description"><p>TODO</p></td>
438 <td class="parameter_annotations"> </td>
439 </tr>
440 <tr>
441 <td class="parameter_name"><p>return_value</p></td>
442 <td class="parameter_description"><p>TODO</p></td>
443 <td class="parameter_annotations"> </td>
444 </tr>
445 <tr>
446 <td class="parameter_name"><p>is_method</p></td>
447 <td class="parameter_description"><p>TODO</p></td>
448 <td class="parameter_annotations"> </td>
449 </tr>
450 <tr>
451 <td class="parameter_name"><p>throws</p></td>
452 <td class="parameter_description"><p>TODO</p></td>
453 <td class="parameter_annotations"> </td>
454 </tr>
455 <tr>
456 <td class="parameter_name"><p>error</p></td>
457 <td class="parameter_description"><p>TODO</p></td>
458 <td class="parameter_annotations"> </td>
459 </tr>
460 </tbody>
461 </table></div>
462 </div>
463 </div>
464 <hr>
465 <div class="refsect2">
466 <a name="g-callable-info-is-method"></a><h3>g_callable_info_is_method ()</h3>
467 <pre class="programlisting"><span class="returnvalue">gboolean</span>
468 g_callable_info_is_method (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
469 <p>Determines if the callable info is a method. For <a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>s,
470 <a class="link" href="gi-GICallbackInfo.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a>s, and <a class="link" href="gi-GISignalInfo.html#GISignalInfo" title="GISignalInfo"><span class="type">GISignalInfo</span></a>s,
471 this is always true. Otherwise, this looks at the <a class="link" href="gi-GIFunctionInfo.html#GI-FUNCTION-IS-METHOD:CAPS"><code class="literal">GI_FUNCTION_IS_METHOD</code></a>
472 flag on the <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.</p>
473 <p>Concretely, this function returns whether <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-n-args" title="g_callable_info_get_n_args ()"><code class="function">g_callable_info_get_n_args()</code></a>
474 matches the number of arguments in the raw C method. For methods, there
475 is one more C argument than is exposed by introspection: the "self"
476 or "this" object.</p>
477 <div class="refsect3">
478 <a name="g-callable-info-is-method.parameters"></a><h4>Parameters</h4>
479 <div class="informaltable"><table class="informaltable" width="100%" border="0">
480 <colgroup>
481 <col width="150px" class="parameters_name">
482 <col class="parameters_description">
483 <col width="200px" class="parameters_annotations">
484 </colgroup>
485 <tbody><tr>
486 <td class="parameter_name"><p>info</p></td>
487 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
488 <td class="parameter_annotations"> </td>
489 </tr></tbody>
490 </table></div>
491 </div>
492 <div class="refsect3">
493 <a name="g-callable-info-is-method.returns"></a><h4>Returns</h4>
494 <p> <code class="literal">TRUE</code> if <em class="parameter"><code>info</code></em>
495 is a method, <code class="literal">FALSE</code> otherwise</p>
496 </div>
497 <p class="since">Since: <a class="link" href="api-index-1-34.html#api-index-1.34">1.34</a></p>
498 </div>
499 <hr>
500 <div class="refsect2">
501 <a name="g-callable-info-iterate-return-attributes"></a><h3>g_callable_info_iterate_return_attributes ()</h3>
502 <pre class="programlisting"><span class="returnvalue">gboolean</span>
503 g_callable_info_iterate_return_attributes
504                                (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
505                                 <em class="parameter"><code><a class="link" href="gi-GIBaseInfo.html#GIAttributeIter" title="GIAttributeIter"><span class="type">GIAttributeIter</span></a> *iterator</code></em>,
506                                 <em class="parameter"><code><span class="type">char</span> **name</code></em>,
507                                 <em class="parameter"><code><span class="type">char</span> **value</code></em>);</pre>
508 <p>Iterate over all attributes associated with the return value.  The
509 iterator structure is typically stack allocated, and must have its
510 first member initialized to <code class="literal">NULL</code>.</p>
511 <p>Both the <em class="parameter"><code>name</code></em>
512  and <em class="parameter"><code>value</code></em>
513  should be treated as constants
514 and must not be freed.</p>
515 <p>See <a class="link" href="gi-GIBaseInfo.html#g-base-info-iterate-attributes" title="g_base_info_iterate_attributes ()"><code class="function">g_base_info_iterate_attributes()</code></a> for an example of how to use a
516 similar API.</p>
517 <div class="refsect3">
518 <a name="g-callable-info-iterate-return-attributes.parameters"></a><h4>Parameters</h4>
519 <div class="informaltable"><table class="informaltable" width="100%" border="0">
520 <colgroup>
521 <col width="150px" class="parameters_name">
522 <col class="parameters_description">
523 <col width="200px" class="parameters_annotations">
524 </colgroup>
525 <tbody>
526 <tr>
527 <td class="parameter_name"><p>info</p></td>
528 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
529 <td class="parameter_annotations"> </td>
530 </tr>
531 <tr>
532 <td class="parameter_name"><p>iterator</p></td>
533 <td class="parameter_description"><p>a <a class="link" href="gi-GIBaseInfo.html#GIAttributeIter" title="GIAttributeIter"><span class="type">GIAttributeIter</span></a> structure, must be initialized; see below</p></td>
534 <td class="parameter_annotations"> </td>
535 </tr>
536 <tr>
537 <td class="parameter_name"><p>name</p></td>
538 <td class="parameter_description"><p> Returned name, must not be freed. </p></td>
539 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
540 </tr>
541 <tr>
542 <td class="parameter_name"><p>value</p></td>
543 <td class="parameter_description"><p> Returned name, must not be freed. </p></td>
544 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
545 </tr>
546 </tbody>
547 </table></div>
548 </div>
549 <div class="refsect3">
550 <a name="g-callable-info-iterate-return-attributes.returns"></a><h4>Returns</h4>
551 <p> <code class="literal">TRUE</code> if there are more attributes</p>
552 </div>
553 </div>
554 <hr>
555 <div class="refsect2">
556 <a name="g-callable-info-load-arg"></a><h3>g_callable_info_load_arg ()</h3>
557 <pre class="programlisting"><span class="returnvalue">void</span>
558 g_callable_info_load_arg (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
559                           <em class="parameter"><code><span class="type">gint</span> n</code></em>,
560                           <em class="parameter"><code><a class="link" href="gi-GIArgInfo.html#GIArgInfo" title="GIArgInfo"><span class="type">GIArgInfo</span></a> *arg</code></em>);</pre>
561 <p>Obtain information about a particular argument of this callable; this
562 function is a variant of <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-arg" title="g_callable_info_get_arg ()"><code class="function">g_callable_info_get_arg()</code></a> designed for stack
563 allocation.</p>
564 <p>The initialized <em class="parameter"><code>arg</code></em>
565  must not be referenced after <em class="parameter"><code>info</code></em>
566  is deallocated.</p>
567 <div class="refsect3">
568 <a name="g-callable-info-load-arg.parameters"></a><h4>Parameters</h4>
569 <div class="informaltable"><table class="informaltable" width="100%" border="0">
570 <colgroup>
571 <col width="150px" class="parameters_name">
572 <col class="parameters_description">
573 <col width="200px" class="parameters_annotations">
574 </colgroup>
575 <tbody>
576 <tr>
577 <td class="parameter_name"><p>info</p></td>
578 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
579 <td class="parameter_annotations"> </td>
580 </tr>
581 <tr>
582 <td class="parameter_name"><p>n</p></td>
583 <td class="parameter_description"><p>the argument index to fetch</p></td>
584 <td class="parameter_annotations"> </td>
585 </tr>
586 <tr>
587 <td class="parameter_name"><p>arg</p></td>
588 <td class="parameter_description"><p> Initialize with argument number <em class="parameter"><code>n</code></em>
589 . </p></td>
590 <td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
591 </tr>
592 </tbody>
593 </table></div>
594 </div>
595 </div>
596 <hr>
597 <div class="refsect2">
598 <a name="g-callable-info-load-return-type"></a><h3>g_callable_info_load_return_type ()</h3>
599 <pre class="programlisting"><span class="returnvalue">void</span>
600 g_callable_info_load_return_type (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>,
601                                   <em class="parameter"><code><a class="link" href="gi-GITypeInfo.html#GITypeInfo" title="GITypeInfo"><span class="type">GITypeInfo</span></a> *type</code></em>);</pre>
602 <p>Obtain information about a return value of callable; this
603 function is a variant of <a class="link" href="gi-GICallableInfo.html#g-callable-info-get-return-type" title="g_callable_info_get_return_type ()"><code class="function">g_callable_info_get_return_type()</code></a> designed for stack
604 allocation.</p>
605 <p>The initialized <em class="parameter"><code>type</code></em>
606  must not be referenced after <em class="parameter"><code>info</code></em>
607  is deallocated.</p>
608 <div class="refsect3">
609 <a name="g-callable-info-load-return-type.parameters"></a><h4>Parameters</h4>
610 <div class="informaltable"><table class="informaltable" width="100%" border="0">
611 <colgroup>
612 <col width="150px" class="parameters_name">
613 <col class="parameters_description">
614 <col width="200px" class="parameters_annotations">
615 </colgroup>
616 <tbody>
617 <tr>
618 <td class="parameter_name"><p>info</p></td>
619 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
620 <td class="parameter_annotations"> </td>
621 </tr>
622 <tr>
623 <td class="parameter_name"><p>type</p></td>
624 <td class="parameter_description"><p> Initialized with return type of <em class="parameter"><code>info</code></em>
625 . </p></td>
626 <td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
627 </tr>
628 </tbody>
629 </table></div>
630 </div>
631 </div>
632 <hr>
633 <div class="refsect2">
634 <a name="g-callable-info-may-return-null"></a><h3>g_callable_info_may_return_null ()</h3>
635 <pre class="programlisting"><span class="returnvalue">gboolean</span>
636 g_callable_info_may_return_null (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
637 <p>See if a callable could return <code class="literal">NULL</code>.</p>
638 <div class="refsect3">
639 <a name="g-callable-info-may-return-null.parameters"></a><h4>Parameters</h4>
640 <div class="informaltable"><table class="informaltable" width="100%" border="0">
641 <colgroup>
642 <col width="150px" class="parameters_name">
643 <col class="parameters_description">
644 <col width="200px" class="parameters_annotations">
645 </colgroup>
646 <tbody><tr>
647 <td class="parameter_name"><p>info</p></td>
648 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
649 <td class="parameter_annotations"> </td>
650 </tr></tbody>
651 </table></div>
652 </div>
653 <div class="refsect3">
654 <a name="g-callable-info-may-return-null.returns"></a><h4>Returns</h4>
655 <p> <code class="literal">TRUE</code> if callable could return <code class="literal">NULL</code></p>
656 </div>
657 </div>
658 <hr>
659 <div class="refsect2">
660 <a name="g-callable-info-skip-return"></a><h3>g_callable_info_skip_return ()</h3>
661 <pre class="programlisting"><span class="returnvalue">gboolean</span>
662 g_callable_info_skip_return (<em class="parameter"><code><a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> *info</code></em>);</pre>
663 <p>See if a callable's return value is only useful in C.</p>
664 <div class="refsect3">
665 <a name="g-callable-info-skip-return.parameters"></a><h4>Parameters</h4>
666 <div class="informaltable"><table class="informaltable" width="100%" border="0">
667 <colgroup>
668 <col width="150px" class="parameters_name">
669 <col class="parameters_description">
670 <col width="200px" class="parameters_annotations">
671 </colgroup>
672 <tbody><tr>
673 <td class="parameter_name"><p>info</p></td>
674 <td class="parameter_description"><p>a <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a></p></td>
675 <td class="parameter_annotations"> </td>
676 </tr></tbody>
677 </table></div>
678 </div>
679 <div class="refsect3">
680 <a name="g-callable-info-skip-return.returns"></a><h4>Returns</h4>
681 <p> <code class="literal">TRUE</code> if return value is only useful in C.</p>
682 </div>
683 </div>
684 </div>
685 <div class="refsect1">
686 <a name="gi-GICallableInfo.other_details"></a><h2>Types and Values</h2>
687 <div class="refsect2">
688 <a name="GICallableInfo"></a><h3>GICallableInfo</h3>
689 <pre class="programlisting">typedef GIBaseInfo GICallableInfo;
690 </pre>
691 <p>Represents a callable, either <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>, <a class="link" href="gi-GICallbackInfo.html#GICallbackInfo" title="GICallbackInfo"><span class="type">GICallbackInfo</span></a> or
692 <a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="type">GIVFuncInfo</span></a>.</p>
693 </div>
694 </div>
695 </div>
696 <div class="footer">
697 <hr>Generated by GTK-Doc V1.25.1</div>
698 </body>
699 </html>