summaryrefslogtreecommitdiff
path: root/tests/doctool/GIRepository-2.0-C-expected/GIRepository.function_info_invoke.page
blob: dbd543e5f493b7bcbc9e6418667619baffb588d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?xml version="1.0"?>

<page id="GIRepository.function_info_invoke"
      type="topic"
      style="function"
      xmlns="http://projectmallard.org/1.0/"
      xmlns:api="http://projectmallard.org/experimental/api/"
      xmlns:ui="http://projectmallard.org/experimental/ui/">
  <info>
    <link type="guide" xref="index" group="function"/>
    <api:function>
      <api:returns>
        <api:type>gboolean</api:type>
      </api:returns>
      <api:name>g_function_info_invoke</api:name>
      <api:arg>
        <api:type>GIFunctionInfo*</api:type>
        <api:name>info</api:name>
      </api:arg>
      <api:arg>
        <api:type>GIArgument*</api:type>
        <api:name>in_args</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>n_in_args</api:name>
      </api:arg>
      <api:arg>
        <api:type>GIArgument*</api:type>
        <api:name>out_args</api:name>
      </api:arg>
      <api:arg>
        <api:type>int</api:type>
        <api:name>n_out_args</api:name>
      </api:arg>
      <api:arg>
        <api:type>GIArgument*</api:type>
        <api:name>return_value</api:name>
      </api:arg>
    </api:function>
  </info>
  <title>g_function_info_invoke</title>
<synopsis><code mime="text/x-csrc">
gboolean g_function_info_invoke (GIFunctionInfo* info,
                                 GIArgument* in_args,
                                 int n_in_args,
                                 GIArgument* out_args,
                                 int n_out_args,
                                 GIArgument* return_value);
</code></synopsis>
<p>Invokes the function described in @info with the given
arguments. Note that inout parameters must appear in both
argument lists. This function uses dlsym() to obtain a pointer
to the function, so the library or shared object containing the
described function must either be linked to the caller, or must
have been g_module_symbol()&lt;!-- --&gt;ed before calling this function.</p><p>error occurred.</p>

<table>
<tr>
<td><p>info :</p></td>
<td><p>a <link xref="GIFunctionInfo">GIFunctionInfo</link> describing the function to invoke</p></td>
</tr>
<tr>
<td><p>in_args :</p></td>
<td><p>an array of <link xref="GIArgument">GIArgument</link>&lt;!-- --&gt;s, one for each in parameter of @info. If there are no in parameter, @in_args can be %NULL</p></td>
</tr>
<tr>
<td><p>n_in_args :</p></td>
<td><p>the length of the @in_args array</p></td>
</tr>
<tr>
<td><p>out_args :</p></td>
<td><p>an array of <link xref="GIArgument">GIArgument</link>&lt;!-- --&gt;s, one for each out parameter of @info. If there are no out parameters, @out_args may be %NULL</p></td>
</tr>
<tr>
<td><p>n_out_args :</p></td>
<td><p>the length of the @out_args array</p></td>
</tr>
<tr>
<td><p>return_value :</p></td>
<td><p>return location for the return value of the function. If the function returns void, @return_value may be %NULL</p></td>
</tr>
<tr>
<td><p>Returns :</p></td>
<td><p>%TRUE if the function has been invoked, %FALSE if an</p></td>
</tr>
</table>
</page>