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.19.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="10"><tr valign="middle">
  16 <td width="100%" align="left">
  17 <a href="#" class="shortcut">Top</a>
  18                    |
  19                   <a href="#gi-GIFunctionInfo.description" class="shortcut">Description</a>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="gi-GICallableInfo.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="gi-GICallbackInfo.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="gi-GIFunctionInfo"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="gi-GIFunctionInfo.top_of_page"></a>GIFunctionInfo</span></h2>
  31 <p>GIFunctionInfo — Struct representing a function</p>
  32 </td>
  33 <td valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsynopsisdiv">
  36 <a name="gi-GIFunctionInfo.synopsis"></a><h2>Synopsis</h2>
  37 <pre class="synopsis">#define             <a class="link" href="gi-GIFunctionInfo.html#GI-IS-FUNCTION-INFO:CAPS" title="GI_IS_FUNCTION_INFO()">GI_IS_FUNCTION_INFO</a>                 (info)
  38 typedef             <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo">GIFunctionInfo</a>;
  39 enum                <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags">GIFunctionInfoFlags</a>;
  40 <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags"><span class="returnvalue">GIFunctionInfoFlags</span></a> <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-flags" title="g_function_info_get_flags ()">g_function_info_get_flags</a>           (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);
  41 <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="returnvalue">GIPropertyInfo</span></a> *    <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-property" title="g_function_info_get_property ()">g_function_info_get_property</a>        (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);
  42 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="gi-GIFunctionInfo.html#g-function-info-get-symbol" title="g_function_info_get_symbol ()">g_function_info_get_symbol</a>          (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);
  43 <a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *       <a class="link" href="gi-GIFunctionInfo.html#g-function-info-get-vfunc" title="g_function_info_get_vfunc ()">g_function_info_get_vfunc</a>           (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="gi-GIFunctionInfo.html#g-function-info-invoke" title="g_function_info_invoke ()">g_function_info_invoke</a>              (<em class="parameter"><code><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> *info</code></em>,
  45                                                          <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>,
  46                                                          <em class="parameter"><code><span class="type">int</span> n_in_args</code></em>,
  47                                                          <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>,
  48                                                          <em class="parameter"><code><span class="type">int</span> n_out_args</code></em>,
  49                                                          <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>,
  50                                                          <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>);
  51 #define             <a class="link" href="gi-GIFunctionInfo.html#G-INVOKE-ERROR:CAPS" title="G_INVOKE_ERROR">G_INVOKE_ERROR</a>
  52 <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              <a class="link" href="gi-GIFunctionInfo.html#g-invoke-error-quark" title="g_invoke_error_quark ()">g_invoke_error_quark</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
  53 enum                <a class="link" href="gi-GIFunctionInfo.html#GInvokeError" title="enum GInvokeError">GInvokeError</a>;
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gi-GIFunctionInfo.description"></a><h2>Description</h2>
  58 <p>
  59 GIFunctionInfo represents a function, method or constructor.
  60 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
  61 <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>.
  62 </p>
  63 <p>
  64 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
  65 other metadata.
  66 </p>
  67 <p>
  68 </p>
  69 <div class="refsect1">
  70 <a name="gi-gifunctioninfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
  71 <pre class="synopsis">
  72   <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
  73    +----<a class="link" href="gi-GICallableInfo.html" title="GICallableInfo">GICallableInfo</a>
  74          +----GIFunctionInfo
  75          +----<a class="link" href="gi-GISignalInfo.html" title="GISignalInfo">GISignalInfo</a>
  76          +----<a class="link" href="gi-GIVFuncInfo.html" title="GIVFuncInfo">GIVFuncInfo</a>
  77 </pre>
  78 </div>
  79 <p>
  80 </p>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gi-GIFunctionInfo.details"></a><h2>Details</h2>
  84 <div class="refsect2">
  85 <a name="GI-IS-FUNCTION-INFO:CAPS"></a><h3>GI_IS_FUNCTION_INFO()</h3>
  86 <pre class="programlisting">#define             GI_IS_FUNCTION_INFO(info)</pre>
  87 <p>
  88 Checks if <em class="parameter"><code>info</code></em> is a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.
  89 </p>
  90 <div class="variablelist"><table border="0" class="variablelist">
  91 <colgroup>
  92 <col align="left" valign="top">
  93 <col>
  94 </colgroup>
  95 <tbody><tr>
  96 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
  97 <td>an info structure</td>
  98 </tr></tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="GIFunctionInfo"></a><h3>GIFunctionInfo</h3>
 104 <pre class="programlisting">typedef GIBaseInfo GIFunctionInfo;
 105 </pre>
 106 <p>
 107 Represents a function, eg arguments and return value.
 108 </p>
 109 </div>
 110 <hr>
 111 <div class="refsect2">
 112 <a name="GIFunctionInfoFlags"></a><h3>enum GIFunctionInfoFlags</h3>
 113 <pre class="programlisting">typedef enum {
 114   GI_FUNCTION_IS_METHOD      = 1 &lt;&lt; 0,
 115   GI_FUNCTION_IS_CONSTRUCTOR = 1 &lt;&lt; 1,
 116   GI_FUNCTION_IS_GETTER      = 1 &lt;&lt; 2,
 117   GI_FUNCTION_IS_SETTER      = 1 &lt;&lt; 3,
 118   GI_FUNCTION_WRAPS_VFUNC    = 1 &lt;&lt; 4,
 119   GI_FUNCTION_THROWS         = 1 &lt;&lt; 5
 120 } GIFunctionInfoFlags;
 121 </pre>
 122 <p>
 123 Flags for a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> struct.
 124 </p>
 125 <div class="variablelist"><table border="0" class="variablelist">
 126 <colgroup>
 127 <col align="left" valign="top">
 128 <col>
 129 </colgroup>
 130 <tbody>
 131 <tr>
 132 <td><p><a name="GI-FUNCTION-IS-METHOD:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_IS_METHOD</code></span></p></td>
 133 <td>is a method.
 134 </td>
 135 </tr>
 136 <tr>
 137 <td><p><a name="GI-FUNCTION-IS-CONSTRUCTOR:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_IS_CONSTRUCTOR</code></span></p></td>
 138 <td>is a constructor.
 139 </td>
 140 </tr>
 141 <tr>
 142 <td><p><a name="GI-FUNCTION-IS-GETTER:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_IS_GETTER</code></span></p></td>
 143 <td>is a getter of a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.
 144 </td>
 145 </tr>
 146 <tr>
 147 <td><p><a name="GI-FUNCTION-IS-SETTER:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_IS_SETTER</code></span></p></td>
 148 <td>is a setter of a <a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="type">GIPropertyInfo</span></a>.
 149 </td>
 150 </tr>
 151 <tr>
 152 <td><p><a name="GI-FUNCTION-WRAPS-VFUNC:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_WRAPS_VFUNC</code></span></p></td>
 153 <td>represents a virtual function.
 154 </td>
 155 </tr>
 156 <tr>
 157 <td><p><a name="GI-FUNCTION-THROWS:CAPS"></a><span class="term"><code class="literal">GI_FUNCTION_THROWS</code></span></p></td>
 158 <td>the function may throw an error.
 159 </td>
 160 </tr>
 161 </tbody>
 162 </table></div>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="g-function-info-get-flags"></a><h3>g_function_info_get_flags ()</h3>
 167 <pre class="programlisting"><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags"><span class="returnvalue">GIFunctionInfoFlags</span></a> 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>
 168 <p>
 169 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>.
 170 </p>
 171 <div class="variablelist"><table border="0" class="variablelist">
 172 <colgroup>
 173 <col align="left" valign="top">
 174 <col>
 175 </colgroup>
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 179 <td>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>
 180 </td>
 181 </tr>
 182 <tr>
 183 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 184 <td>the flags</td>
 185 </tr>
 186 </tbody>
 187 </table></div>
 188 </div>
 189 <hr>
 190 <div class="refsect2">
 191 <a name="g-function-info-get-property"></a><h3>g_function_info_get_property ()</h3>
 192 <pre class="programlisting"><a class="link" href="gi-GIPropertyInfo.html#GIPropertyInfo" title="GIPropertyInfo"><span class="returnvalue">GIPropertyInfo</span></a> *    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>
 193 <p>
 194 Obtain the property associated with this <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.
 195 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
 196 <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,
 197 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.
 198 </p>
 199 <div class="variablelist"><table border="0" class="variablelist">
 200 <colgroup>
 201 <col align="left" valign="top">
 202 <col>
 203 </colgroup>
 204 <tbody>
 205 <tr>
 206 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 207 <td>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>
 208 </td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 212 <td>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
 213 <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. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 214 </td>
 215 </tr>
 216 </tbody>
 217 </table></div>
 218 </div>
 219 <hr>
 220 <div class="refsect2">
 221 <a name="g-function-info-get-symbol"></a><h3>g_function_info_get_symbol ()</h3>
 222 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       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>
 223 <p>
 224 Obtain the symbol of the function. The symbol is the name of the
 225 exported function, suitable to be used as an argument to
 226 <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>.
 227 </p>
 228 <div class="variablelist"><table border="0" class="variablelist">
 229 <colgroup>
 230 <col align="left" valign="top">
 231 <col>
 232 </colgroup>
 233 <tbody>
 234 <tr>
 235 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 236 <td>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>
 237 </td>
 238 </tr>
 239 <tr>
 240 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 241 <td>the symbol</td>
 242 </tr>
 243 </tbody>
 244 </table></div>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="g-function-info-get-vfunc"></a><h3>g_function_info_get_vfunc ()</h3>
 249 <pre class="programlisting"><a class="link" href="gi-GIVFuncInfo.html#GIVFuncInfo" title="GIVFuncInfo"><span class="returnvalue">GIVFuncInfo</span></a> *       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>
 250 <p>
 251 Obtain the virtual function associated with this <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>.
 252 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
 253 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.
 254 </p>
 255 <div class="variablelist"><table border="0" class="variablelist">
 256 <colgroup>
 257 <col align="left" valign="top">
 258 <col>
 259 </colgroup>
 260 <tbody>
 261 <tr>
 262 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 263 <td>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a>
 264 </td>
 265 </tr>
 266 <tr>
 267 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 268 <td>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.
 269 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. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 270 </td>
 271 </tr>
 272 </tbody>
 273 </table></div>
 274 </div>
 275 <hr>
 276 <div class="refsect2">
 277 <a name="g-function-info-invoke"></a><h3>g_function_info_invoke ()</h3>
 278 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            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>,
 279                                                          <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>,
 280                                                          <em class="parameter"><code><span class="type">int</span> n_in_args</code></em>,
 281                                                          <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>,
 282                                                          <em class="parameter"><code><span class="type">int</span> n_out_args</code></em>,
 283                                                          <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>,
 284                                                          <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>
 285 <p>
 286 Invokes the function described in <em class="parameter"><code>info</code></em> with the given
 287 arguments. Note that inout parameters must appear in both
 288 argument lists. This function uses <code class="function">dlsym()</code> to obtain a pointer
 289 to the function, so the library or shared object containing the
 290 described function must either be linked to the caller, or must
 291 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.
 292 </p>
 293 <div class="variablelist"><table border="0" class="variablelist">
 294 <colgroup>
 295 <col align="left" valign="top">
 296 <col>
 297 </colgroup>
 298 <tbody>
 299 <tr>
 300 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 301 <td>a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> describing the function to invoke</td>
 302 </tr>
 303 <tr>
 304 <td><p><span class="term"><em class="parameter"><code>in_args</code></em> :</span></p></td>
 305 <td>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
 306 parameter of <em class="parameter"><code>info</code></em>. If there are no in parameter, <em class="parameter"><code>in_args</code></em>
 307 can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 308 </td>
 309 </tr>
 310 <tr>
 311 <td><p><span class="term"><em class="parameter"><code>n_in_args</code></em> :</span></p></td>
 312 <td>the length of the <em class="parameter"><code>in_args</code></em> array</td>
 313 </tr>
 314 <tr>
 315 <td><p><span class="term"><em class="parameter"><code>out_args</code></em> :</span></p></td>
 316 <td>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
 317 parameter of <em class="parameter"><code>info</code></em>. If there are no out parameters, <em class="parameter"><code>out_args</code></em>
 318 may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 319 </td>
 320 </tr>
 321 <tr>
 322 <td><p><span class="term"><em class="parameter"><code>n_out_args</code></em> :</span></p></td>
 323 <td>the length of the <em class="parameter"><code>out_args</code></em> array</td>
 324 </tr>
 325 <tr>
 326 <td><p><span class="term"><em class="parameter"><code>return_value</code></em> :</span></p></td>
 327 <td>return location for the return value of the
 328 function. If the function returns void, <em class="parameter"><code>return_value</code></em> may be
 329 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
 330 </td>
 331 </tr>
 332 <tr>
 333 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 334 <td>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>
 335 </td>
 336 </tr>
 337 <tr>
 338 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 339 <td>
 340 <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
 341 error occurred.</td>
 342 </tr>
 343 </tbody>
 344 </table></div>
 345 </div>
 346 <hr>
 347 <div class="refsect2">
 348 <a name="G-INVOKE-ERROR:CAPS"></a><h3>G_INVOKE_ERROR</h3>
 349 <pre class="programlisting">#define G_INVOKE_ERROR (g_invoke_error_quark ())
 350 </pre>
 351 <p>
 352 TODO
 353 </p>
 354 </div>
 355 <hr>
 356 <div class="refsect2">
 357 <a name="g-invoke-error-quark"></a><h3>g_invoke_error_quark ()</h3>
 358 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>              g_invoke_error_quark                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 359 <p>
 360 TODO
 361 </p>
 362 <div class="variablelist"><table border="0" class="variablelist">
 363 <colgroup>
 364 <col align="left" valign="top">
 365 <col>
 366 </colgroup>
 367 <tbody><tr>
 368 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 369 <td>TODO</td>
 370 </tr></tbody>
 371 </table></div>
 372 </div>
 373 <hr>
 374 <div class="refsect2">
 375 <a name="GInvokeError"></a><h3>enum GInvokeError</h3>
 376 <pre class="programlisting">typedef enum {
 377   G_INVOKE_ERROR_FAILED,
 378   G_INVOKE_ERROR_SYMBOL_NOT_FOUND,
 379   G_INVOKE_ERROR_ARGUMENT_MISMATCH
 380 } GInvokeError;
 381 </pre>
 382 <p>
 383 An error occuring while invoking a function via
 384 <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>.
 385 </p>
 386 <div class="variablelist"><table border="0" class="variablelist">
 387 <colgroup>
 388 <col align="left" valign="top">
 389 <col>
 390 </colgroup>
 391 <tbody>
 392 <tr>
 393 <td><p><a name="G-INVOKE-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">G_INVOKE_ERROR_FAILED</code></span></p></td>
 394 <td>invokation failed, unknown error.
 395 </td>
 396 </tr>
 397 <tr>
 398 <td><p><a name="G-INVOKE-ERROR-SYMBOL-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">G_INVOKE_ERROR_SYMBOL_NOT_FOUND</code></span></p></td>
 399 <td>symbol couldn't be found in any of the
 400 libraries associated with the typelib of the function.
 401 </td>
 402 </tr>
 403 <tr>
 404 <td><p><a name="G-INVOKE-ERROR-ARGUMENT-MISMATCH:CAPS"></a><span class="term"><code class="literal">G_INVOKE_ERROR_ARGUMENT_MISMATCH</code></span></p></td>
 405 <td>the arguments provided didn't match
 406 the expected arguments for the functions type signature.
 407 </td>
 408 </tr>
 409 </tbody>
 410 </table></div>
 411 </div>
 412 </div>
 413 </div>
 414 <div class="footer">
 415 <hr>
 416           Generated by GTK-Doc V1.19.1</div>
 417 </body>
 418 </html>