docs/reference/html/gi-GIFunctionInfo.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>GObject Introspection Reference Manual: GIFunctionInfo</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.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-GICallableInfo.html" title="GICallableInfo">
  10 <link rel="next" href="gi-GICallbackInfo.html" title="GICallbackInfo">
  11 <meta name="generator" content="GTK-Doc V1.21.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-GIFunctionInfo.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-GICallableInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="gi-GICallbackInfo.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-GIFunctionInfo"></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-GIFunctionInfo.top_of_page"></a>GIFunctionInfo</span></h2>
  30 <p>GIFunctionInfo — Struct representing a function</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-GIFunctionInfo.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table 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-GIFunctionInfo.html#GI-IS-FUNCTION-INFO:CAPS" title="GI_IS_FUNCTION_INFO()">GI_IS_FUNCTION_INFO</a><span class="c_punctuation">()</span>
  46 </td>
  47 </tr>
  48 <tr>
  49 <td class="function_type">
  50 <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags"><span class="returnvalue">GIFunctionInfoFlags</span></a>
  51 </td>
  52 <td class="function_name">
  53 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-flags" title="g_function_info_get_flags ()">g_function_info_get_flags</a> <span class="c_punctuation">()</span>
  54 </td>
  55 </tr>
  56 <tr>
  57 <td class="function_type">
  58 <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="returnvalue">GIPropertyInfo</span></a> *
  59 </td>
  60 <td class="function_name">
  61 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-property" title="g_function_info_get_property ()">g_function_info_get_property</a> <span class="c_punctuation">()</span>
  62 </td>
  63 </tr>
  64 <tr>
  65 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  66 </td>
  67 <td class="function_name">
  68 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-symbol" title="g_function_info_get_symbol ()">g_function_info_get_symbol</a> <span class="c_punctuation">()</span>
  69 </td>
  70 </tr>
  71 <tr>
  72 <td class="function_type">
  73 <a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *
  74 </td>
  75 <td class="function_name">
  76 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-vfunc" title="g_function_info_get_vfunc ()">g_function_info_get_vfunc</a> <span class="c_punctuation">()</span>
  77 </td>
  78 </tr>
  79 <tr>
  80 <td class="function_type">
  81 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
  82 </td>
  83 <td class="function_name">
  84 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-invoke" title="g_function_info_invoke ()">g_function_info_invoke</a> <span class="c_punctuation">()</span>
  85 </td>
  86 </tr>
  87 <tr>
  88 <td class="define_keyword">#define</td>
  89 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#G-INVOKE-ERROR:CAPS" title="G_INVOKE_ERROR">G_INVOKE_ERROR</a></td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="gi-GIFunctionInfo.html#g-invoke-error-quark" title="g_invoke_error_quark ()">g_invoke_error_quark</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 </tbody>
 100 </table></div>
 101 </div>
 102 <div class="refsect1">
 103 <a name="gi-GIFunctionInfo.other"></a><h2>Types and Values</h2>
 104 <div class="informaltable"><table width="100%" border="0">
 105 <colgroup>
 106 <col width="150px" class="name">
 107 <col class="description">
 108 </colgroup>
 109 <tbody>
 110 <tr>
 111 <td class="typedef_keyword">typedef</td>
 112 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo">GIFunctionInfo</a></td>
 113 </tr>
 114 <tr>
 115 <td class="datatype_keyword">enum</td>
 116 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags">GIFunctionInfoFlags</a></td>
 117 </tr>
 118 <tr>
 119 <td class="datatype_keyword">enum</td>
 120 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#GInvokeError" title="enum GInvokeError">GInvokeError</a></td>
 121 </tr>
 122 </tbody>
 123 </table></div>
 124 </div>
 125 <div class="refsect1">
 126 <a name="gi-GIFunctionInfo.description"></a><h2>Description</h2>
 127 <p>GIFunctionInfo represents a function, method or constructor.
 128 To find out what kind of entity a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> represents, call
 129 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-flags" title="g_function_info_get_flags ()"><code class="function">g_function_info_get_flags()</code></a>.</p>
 130 <p>See also <a class="link" href="gi-GICallableInfo.html#GICallableInfo" title="GICallableInfo"><span class="type">GICallableInfo</span></a> for information on how to retreive arguments and
 131 other metadata.</p>
 132 <div class="refsect1">
 133 <a name="gi-gifunctioninfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
 134 <pre class="synopsis">
 135   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
 136    +----<a class="link" href="gi-GICallableInfo.html" title="GICallableInfo">GICallableInfo</a>
 137          +----GIFunctionInfo
 138          +----<a class="link" href="gi-GISignalInfo.html" title="GISignalInfo">GISignalInfo</a>
 139          +----<a class="link" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">GIVFuncInfo</a>
 140 </pre>
 141 </div>
 142 </div>
 143 <div class="refsect1">
 144 <a name="gi-GIFunctionInfo.functions_details"></a><h2>Functions</h2>
 145 <div class="refsect2">
 146 <a name="GI-IS-FUNCTION-INFO:CAPS"></a><h3>GI_IS_FUNCTION_INFO()</h3>
 147 <pre class="programlisting">#define             GI_IS_FUNCTION_INFO(info)</pre>
 148 <p>Checks if <em class="parameter"><code>info</code></em>
 149  is a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.</p>
 150 <div class="refsect3">
 151 <a name="id-1.4.2.7.6.2.5"></a><h4>Parameters</h4>
 152 <div class="informaltable"><table width="100%" border="0">
 153 <colgroup>
 154 <col width="150px" class="parameters_name">
 155 <col class="parameters_description">
 156 <col width="200px" class="parameters_annotations">
 157 </colgroup>
 158 <tbody><tr>
 159 <td class="parameter_name"><p>info</p></td>
 160 <td class="parameter_description"><p>an info structure</p></td>
 161 <td class="parameter_annotations"> </td>
 162 </tr></tbody>
 163 </table></div>
 164 </div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="g-function-info-get-flags"></a><h3>g_function_info_get_flags ()</h3>
 169 <pre class="programlisting"><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags"><span class="returnvalue">GIFunctionInfoFlags</span></a>
 170 g_function_info_get_flags (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);</pre>
 171 <p>Obtain the <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags"><span class="type">GIFunctionInfoFlags</span></a> for the <em class="parameter"><code>info</code></em>
 172 .</p>
 173 <div class="refsect3">
 174 <a name="id-1.4.2.7.6.3.5"></a><h4>Parameters</h4>
 175 <div class="informaltable"><table width="100%" border="0">
 176 <colgroup>
 177 <col width="150px" class="parameters_name">
 178 <col class="parameters_description">
 179 <col width="200px" class="parameters_annotations">
 180 </colgroup>
 181 <tbody><tr>
 182 <td class="parameter_name"><p>info</p></td>
 183 <td class="parameter_description"><p>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a></p></td>
 184 <td class="parameter_annotations"> </td>
 185 </tr></tbody>
 186 </table></div>
 187 </div>
 188 <div class="refsect3">
 189 <a name="id-1.4.2.7.6.3.6"></a><h4>Returns</h4>
 190 <p> the flags</p>
 191 <p></p>
 192 </div>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="g-function-info-get-property"></a><h3>g_function_info_get_property ()</h3>
 197 <pre class="programlisting"><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="returnvalue">GIPropertyInfo</span></a> *
 198 g_function_info_get_property (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);</pre>
 199 <p>Obtain the property associated with this <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.
 200 Only <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> with the flag <a class="link" href="gi-GIFunctionInfo.html#GI-FUNCTION-IS-GETTER:CAPS"><code class="literal">GI_FUNCTION_IS_GETTER</code></a> or
 201 <a class="link" href="gi-GIFunctionInfo.html#GI-FUNCTION-IS-SETTER:CAPS"><code class="literal">GI_FUNCTION_IS_SETTER</code></a> have a property set. For other cases,
 202 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
 203 <div class="refsect3">
 204 <a name="id-1.4.2.7.6.4.5"></a><h4>Parameters</h4>
 205 <div class="informaltable"><table width="100%" border="0">
 206 <colgroup>
 207 <col width="150px" class="parameters_name">
 208 <col class="parameters_description">
 209 <col width="200px" class="parameters_annotations">
 210 </colgroup>
 211 <tbody><tr>
 212 <td class="parameter_name"><p>info</p></td>
 213 <td class="parameter_description"><p>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a></p></td>
 214 <td class="parameter_annotations"> </td>
 215 </tr></tbody>
 216 </table></div>
 217 </div>
 218 <div class="refsect3">
 219 <a name="id-1.4.2.7.6.4.6"></a><h4>Returns</h4>
 220 <p> the property or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not set. Free it with
 221 <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>
 222 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 223 </div>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="g-function-info-get-symbol"></a><h3>g_function_info_get_symbol ()</h3>
 228 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 229 g_function_info_get_symbol (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);</pre>
 230 <p>Obtain the symbol of the function. The symbol is the name of the
 231 exported function, suitable to be used as an argument to
 232 <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#g-module-symbol"><code class="function">g_module_symbol()</code></a>.</p>
 233 <div class="refsect3">
 234 <a name="id-1.4.2.7.6.5.5"></a><h4>Parameters</h4>
 235 <div class="informaltable"><table width="100%" border="0">
 236 <colgroup>
 237 <col width="150px" class="parameters_name">
 238 <col class="parameters_description">
 239 <col width="200px" class="parameters_annotations">
 240 </colgroup>
 241 <tbody><tr>
 242 <td class="parameter_name"><p>info</p></td>
 243 <td class="parameter_description"><p>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a></p></td>
 244 <td class="parameter_annotations"> </td>
 245 </tr></tbody>
 246 </table></div>
 247 </div>
 248 <div class="refsect3">
 249 <a name="id-1.4.2.7.6.5.6"></a><h4>Returns</h4>
 250 <p> the symbol</p>
 251 <p></p>
 252 </div>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="g-function-info-get-vfunc"></a><h3>g_function_info_get_vfunc ()</h3>
 257 <pre class="programlisting"><a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *
 258 g_function_info_get_vfunc (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);</pre>
 259 <p>Obtain the virtual function associated with this <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.
 260 Only <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> with the flag <a class="link" href="gi-GIFunctionInfo.html#GI-FUNCTION-WRAPS-VFUNC:CAPS"><code class="literal">GI_FUNCTION_WRAPS_VFUNC</code></a> has
 261 a virtual function set. For other cases, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
 262 <div class="refsect3">
 263 <a name="id-1.4.2.7.6.6.5"></a><h4>Parameters</h4>
 264 <div class="informaltable"><table width="100%" border="0">
 265 <colgroup>
 266 <col width="150px" class="parameters_name">
 267 <col class="parameters_description">
 268 <col width="200px" class="parameters_annotations">
 269 </colgroup>
 270 <tbody><tr>
 271 <td class="parameter_name"><p>info</p></td>
 272 <td class="parameter_description"><p>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a></p></td>
 273 <td class="parameter_annotations"> </td>
 274 </tr></tbody>
 275 </table></div>
 276 </div>
 277 <div class="refsect3">
 278 <a name="id-1.4.2.7.6.6.6"></a><h4>Returns</h4>
 279 <p> the virtual function or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not set.
 280 Free it by calling <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>
 281 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 282 </div>
 283 </div>
 284 <hr>
 285 <div class="refsect2">
 286 <a name="g-function-info-invoke"></a><h3>g_function_info_invoke ()</h3>
 287 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 288 g_function_info_invoke (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>,
 289                         <em class="parameter"><code>const <a class="link" href="gi-common-types.html#GIArgument" title="union GIArgument"><span class="type">GIArgument</span></a> *in_args</code></em>,
 290                         <em class="parameter"><code><span class="type">int</span> n_in_args</code></em>,
 291                         <em class="parameter"><code>const <a class="link" href="gi-common-types.html#GIArgument" title="union GIArgument"><span class="type">GIArgument</span></a> *out_args</code></em>,
 292                         <em class="parameter"><code><span class="type">int</span> n_out_args</code></em>,
 293                         <em class="parameter"><code><a class="link" href="gi-common-types.html#GIArgument" title="union GIArgument"><span class="type">GIArgument</span></a> *return_value</code></em>,
 294                         <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>
 295 <p>Invokes the function described in <em class="parameter"><code>info</code></em>
 296  with the given
 297 arguments. Note that inout parameters must appear in both
 298 argument lists. This function uses <code class="function">dlsym()</code> to obtain a pointer
 299 to the function, so the library or shared object containing the
 300 described function must either be linked to the caller, or must
 301 have been <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#g-module-symbol"><code class="function">g_module_symbol()</code></a>ed before calling this function.</p>
 302 <div class="refsect3">
 303 <a name="id-1.4.2.7.6.7.5"></a><h4>Parameters</h4>
 304 <div class="informaltable"><table width="100%" border="0">
 305 <colgroup>
 306 <col width="150px" class="parameters_name">
 307 <col class="parameters_description">
 308 <col width="200px" class="parameters_annotations">
 309 </colgroup>
 310 <tbody>
 311 <tr>
 312 <td class="parameter_name"><p>info</p></td>
 313 <td class="parameter_description"><p>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> describing the function to invoke</p></td>
 314 <td class="parameter_annotations"> </td>
 315 </tr>
 316 <tr>
 317 <td class="parameter_name"><p>in_args</p></td>
 318 <td class="parameter_description"><p>an array of <a class="link" href="gi-common-types.html#GIArgument" title="union GIArgument"><span class="type">GIArgument</span></a>s, one for each in
 319 parameter of <em class="parameter"><code>info</code></em>
 320 . If there are no in parameter, <em class="parameter"><code>in_args</code></em>
 321 can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 322 <td class="parameter_annotations"> </td>
 323 </tr>
 324 <tr>
 325 <td class="parameter_name"><p>n_in_args</p></td>
 326 <td class="parameter_description"><p>the length of the <em class="parameter"><code>in_args</code></em>
 327 array</p></td>
 328 <td class="parameter_annotations"> </td>
 329 </tr>
 330 <tr>
 331 <td class="parameter_name"><p>out_args</p></td>
 332 <td class="parameter_description"><p>an array of <a class="link" href="gi-common-types.html#GIArgument" title="union GIArgument"><span class="type">GIArgument</span></a>s, one for each out
 333 parameter of <em class="parameter"><code>info</code></em>
 334 . If there are no out parameters, <em class="parameter"><code>out_args</code></em>
 335 may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 336 <td class="parameter_annotations"> </td>
 337 </tr>
 338 <tr>
 339 <td class="parameter_name"><p>n_out_args</p></td>
 340 <td class="parameter_description"><p>the length of the <em class="parameter"><code>out_args</code></em>
 341 array</p></td>
 342 <td class="parameter_annotations"> </td>
 343 </tr>
 344 <tr>
 345 <td class="parameter_name"><p>return_value</p></td>
 346 <td class="parameter_description"><p>return location for the return value of the
 347 function. If the function returns void, <em class="parameter"><code>return_value</code></em>
 348 may be
 349 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 350 <td class="parameter_annotations"> </td>
 351 </tr>
 352 <tr>
 353 <td class="parameter_name"><p>error</p></td>
 354 <td class="parameter_description"><p>return location for detailed error information, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 355 <td class="parameter_annotations"> </td>
 356 </tr>
 357 </tbody>
 358 </table></div>
 359 </div>
 360 <div class="refsect3">
 361 <a name="id-1.4.2.7.6.7.6"></a><h4>Returns</h4>
 362 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the function has been invoked, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if an
 363 error occurred.</p>
 364 <p></p>
 365 </div>
 366 </div>
 367 <hr>
 368 <div class="refsect2">
 369 <a name="G-INVOKE-ERROR:CAPS"></a><h3>G_INVOKE_ERROR</h3>
 370 <pre class="programlisting">#define G_INVOKE_ERROR (g_invoke_error_quark ())
 371 </pre>
 372 <p>TODO</p>
 373 </div>
 374 <hr>
 375 <div class="refsect2">
 376 <a name="g-invoke-error-quark"></a><h3>g_invoke_error_quark ()</h3>
 377 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
 378 g_invoke_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 379 <p>TODO</p>
 380 <div class="refsect3">
 381 <a name="id-1.4.2.7.6.9.5"></a><h4>Returns</h4>
 382 <p> TODO</p>
 383 <p></p>
 384 </div>
 385 </div>
 386 </div>
 387 <div class="refsect1">
 388 <a name="gi-GIFunctionInfo.other_details"></a><h2>Types and Values</h2>
 389 <div class="refsect2">
 390 <a name="GIFunctionInfo"></a><h3>GIFunctionInfo</h3>
 391 <pre class="programlisting">typedef GIBaseInfo GIFunctionInfo;
 392 </pre>
 393 <p>Represents a function, eg arguments and return value.</p>
 394 </div>
 395 <hr>
 396 <div class="refsect2">
 397 <a name="GIFunctionInfoFlags"></a><h3>enum GIFunctionInfoFlags</h3>
 398 <p>Flags for a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> struct.</p>
 399 <div class="refsect3">
 400 <a name="id-1.4.2.7.7.3.4"></a><h4>Members</h4>
 401 <div class="informaltable"><table width="100%" border="0">
 402 <colgroup>
 403 <col width="300px" class="enum_members_name">
 404 <col class="enum_members_description">
 405 <col width="200px" class="enum_members_annotations">
 406 </colgroup>
 407 <tbody>
 408 <tr>
 409 <td class="enum_member_name"><p><a name="GI-FUNCTION-IS-METHOD:CAPS"></a>GI_FUNCTION_IS_METHOD</p></td>
 410 <td class="enum_member_description">
 411 <p>is a method.</p>
 412 </td>
 413 <td class="enum_member_annotations"> </td>
 414 </tr>
 415 <tr>
 416 <td class="enum_member_name"><p><a name="GI-FUNCTION-IS-CONSTRUCTOR:CAPS"></a>GI_FUNCTION_IS_CONSTRUCTOR</p></td>
 417 <td class="enum_member_description">
 418 <p>is a constructor.</p>
 419 </td>
 420 <td class="enum_member_annotations"> </td>
 421 </tr>
 422 <tr>
 423 <td class="enum_member_name"><p><a name="GI-FUNCTION-IS-GETTER:CAPS"></a>GI_FUNCTION_IS_GETTER</p></td>
 424 <td class="enum_member_description">
 425 <p>is a getter of a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.</p>
 426 </td>
 427 <td class="enum_member_annotations"> </td>
 428 </tr>
 429 <tr>
 430 <td class="enum_member_name"><p><a name="GI-FUNCTION-IS-SETTER:CAPS"></a>GI_FUNCTION_IS_SETTER</p></td>
 431 <td class="enum_member_description">
 432 <p>is a setter of a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.</p>
 433 </td>
 434 <td class="enum_member_annotations"> </td>
 435 </tr>
 436 <tr>
 437 <td class="enum_member_name"><p><a name="GI-FUNCTION-WRAPS-VFUNC:CAPS"></a>GI_FUNCTION_WRAPS_VFUNC</p></td>
 438 <td class="enum_member_description">
 439 <p>represents a virtual function.</p>
 440 </td>
 441 <td class="enum_member_annotations"> </td>
 442 </tr>
 443 <tr>
 444 <td class="enum_member_name"><p><a name="GI-FUNCTION-THROWS:CAPS"></a>GI_FUNCTION_THROWS</p></td>
 445 <td class="enum_member_description">
 446 <p>the function may throw an error.</p>
 447 </td>
 448 <td class="enum_member_annotations"> </td>
 449 </tr>
 450 </tbody>
 451 </table></div>
 452 </div>
 453 </div>
 454 <hr>
 455 <div class="refsect2">
 456 <a name="GInvokeError"></a><h3>enum GInvokeError</h3>
 457 <p>An error occuring while invoking a function via
 458 <a class="link" href="gi-GIFunctionInfo.html#g-function-info-invoke" title="g_function_info_invoke ()"><code class="function">g_function_info_invoke()</code></a>.</p>
 459 <div class="refsect3">
 460 <a name="id-1.4.2.7.7.4.4"></a><h4>Members</h4>
 461 <div class="informaltable"><table width="100%" border="0">
 462 <colgroup>
 463 <col width="300px" class="enum_members_name">
 464 <col class="enum_members_description">
 465 <col width="200px" class="enum_members_annotations">
 466 </colgroup>
 467 <tbody>
 468 <tr>
 469 <td class="enum_member_name"><p><a name="G-INVOKE-ERROR-FAILED:CAPS"></a>G_INVOKE_ERROR_FAILED</p></td>
 470 <td class="enum_member_description">
 471 <p>invokation failed, unknown error.</p>
 472 </td>
 473 <td class="enum_member_annotations"> </td>
 474 </tr>
 475 <tr>
 476 <td class="enum_member_name"><p><a name="G-INVOKE-ERROR-SYMBOL-NOT-FOUND:CAPS"></a>G_INVOKE_ERROR_SYMBOL_NOT_FOUND</p></td>
 477 <td class="enum_member_description">
 478 <p>symbol couldn't be found in any of the
 479 libraries associated with the typelib of the function.</p>
 480 </td>
 481 <td class="enum_member_annotations"> </td>
 482 </tr>
 483 <tr>
 484 <td class="enum_member_name"><p><a name="G-INVOKE-ERROR-ARGUMENT-MISMATCH:CAPS"></a>G_INVOKE_ERROR_ARGUMENT_MISMATCH</p></td>
 485 <td class="enum_member_description">
 486 <p>the arguments provided didn't match
 487 the expected arguments for the functions type signature.</p>
 488 </td>
 489 <td class="enum_member_annotations"> </td>
 490 </tr>
 491 </tbody>
 492 </table></div>
 493 </div>
 494 </div>
 495 </div>
 496 </div>
 497 <div class="footer">
 498 <hr>
 499           Generated by GTK-Doc V1.21.1</div>
 500 </body>
 501 </html>