Imported Upstream version 1.59.4
[platform/upstream/gobject-introspection.git] / docs / reference / html / gi-GIFunctionInfo.html
index 965ae5c..e739743 100644 (file)
@@ -2,13 +2,13 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>GIFunctionInfo: GObject Introspection Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
-<link rel="home" href="index.html" title="GObject Introspection Reference Manual">
-<link rel="up" href="ch01.html" title="GIRepository">
+<title>GIFunctionInfo: libgirepository API Reference</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
+<link rel="home" href="index.html" title="libgirepository API Reference">
+<link rel="up" href="ch01.html" title="GIBaseInfo">
 <link rel="prev" href="gi-GICallableInfo.html" title="GICallableInfo">
 <link rel="next" href="gi-GICallbackInfo.html" title="GICallbackInfo">
-<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -33,7 +33,7 @@
 </tr></table></div>
 <div class="refsect1">
 <a name="gi-GIFunctionInfo.functions"></a><h2>Functions</h2>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="functions_return">
 <col class="functions_name">
 </td>
 </tr>
 <tr>
-<td class="define_keyword">#define</td>
-<td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#G-INVOKE-ERROR:CAPS" title="G_INVOKE_ERROR">G_INVOKE_ERROR</a></td>
-</tr>
-<tr>
 <td class="function_type">
 <span class="returnvalue">GQuark</span>
 </td>
 </div>
 <div class="refsect1">
 <a name="gi-GIFunctionInfo.other"></a><h2>Types and Values</h2>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="name">
 <col class="description">
 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfoFlags" title="enum GIFunctionInfoFlags">GIFunctionInfoFlags</a></td>
 </tr>
 <tr>
+<td class="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#G-INVOKE-ERROR:CAPS" title="G_INVOKE_ERROR">G_INVOKE_ERROR</a></td>
+</tr>
+<tr>
 <td class="datatype_keyword">enum</td>
 <td class="function_name"><a class="link" href="gi-GIFunctionInfo.html#GInvokeError" title="enum GInvokeError">GInvokeError</a></td>
 </tr>
@@ -132,7 +132,7 @@ other metadata.</p>
 <div class="refsect1">
 <a name="gi-gifunctioninfo.struct-hierarchy"></a><h2>Struct hierarchy</h2>
 <pre class="synopsis">
-  <a class="link" href="gi-GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
+  <a class="link" href="GIBaseInfo.html" title="GIBaseInfo">GIBaseInfo</a>
    +----<a class="link" href="gi-GICallableInfo.html" title="GICallableInfo">GICallableInfo</a>
          +----GIFunctionInfo
          +----<a class="link" href="gi-GISignalInfo.html" title="GISignalInfo">GISignalInfo</a>
@@ -148,8 +148,8 @@ other metadata.</p>
 <p>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>.</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.2.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="GI-IS-FUNCTION-INFO.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -171,8 +171,8 @@ g_function_info_get_flags (<em class="parameter"><code><a class="link" href="gi-
 <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>
 .</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.3.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="g-function-info-get-flags.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -186,9 +186,8 @@ g_function_info_get_flags (<em class="parameter"><code><a class="link" href="gi-
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.3.6"></a><h4>Returns</h4>
+<a name="g-function-info-get-flags.returns"></a><h4>Returns</h4>
 <p> the flags</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -201,8 +200,8 @@ Only <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunct
 <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,
 <code class="literal">NULL</code> will be returned.</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.4.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="g-function-info-get-property.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -216,9 +215,9 @@ Only <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunct
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.4.6"></a><h4>Returns</h4>
-<p> the property or <code class="literal">NULL</code> if not set. Free it with
-<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>
+<a name="g-function-info-get-property.returns"></a><h4>Returns</h4>
+<p>the property or <code class="literal">NULL</code> if not set. Free it with
+<a class="link" href="GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
@@ -231,8 +230,8 @@ g_function_info_get_symbol (<em class="parameter"><code><a class="link" href="gi
 exported function, suitable to be used as an argument to
 <code class="function">g_module_symbol()</code>.</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.5.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="g-function-info-get-symbol.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -246,9 +245,8 @@ exported function, suitable to be used as an argument to
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.5.6"></a><h4>Returns</h4>
+<a name="g-function-info-get-symbol.returns"></a><h4>Returns</h4>
 <p> the symbol</p>
-<p></p>
 </div>
 </div>
 <hr>
@@ -260,8 +258,8 @@ g_function_info_get_vfunc (<em class="parameter"><code><a class="link" href="gi-
 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
 a virtual function set. For other cases, <code class="literal">NULL</code> will be returned.</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.6.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="g-function-info-get-vfunc.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -275,9 +273,9 @@ a virtual function set. For other cases, <code class="literal">NULL</code> will
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.6.6"></a><h4>Returns</h4>
-<p> the virtual function or <code class="literal">NULL</code> if not set.
-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>
+<a name="g-function-info-get-vfunc.returns"></a><h4>Returns</h4>
+<p>the virtual function or <code class="literal">NULL</code> if not set.
+Free it by calling <a class="link" href="GIBaseInfo.html#g-base-info-unref" title="g_base_info_unref ()"><code class="function">g_base_info_unref()</code></a> when done. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
@@ -286,11 +284,11 @@ Free it by calling <a class="link" href="gi-GIBaseInfo.html#g-base-info-unref" t
 <a name="g-function-info-invoke"></a><h3>g_function_info_invoke ()</h3>
 <pre class="programlisting"><span class="returnvalue">gboolean</span>
 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>,
-                        <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>,
+                        <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>,
                         <em class="parameter"><code><span class="type">int</span> n_in_args</code></em>,
-                        <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>,
+                        <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>,
                         <em class="parameter"><code><span class="type">int</span> n_out_args</code></em>,
-                        <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>,
+                        <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>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 <p>Invokes the function described in <em class="parameter"><code>info</code></em>
  with the given
@@ -299,9 +297,10 @@ argument lists. This function uses <code class="function">dlsym()</code> to obta
 to the function, so the library or shared object containing the
 described function must either be linked to the caller, or must
 have been <code class="function">g_module_symbol()</code>ed before calling this function.</p>
+<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.7.5"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="g-function-info-invoke.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -315,11 +314,11 @@ have been <code class="function">g_module_symbol()</code>ed before calling this
 </tr>
 <tr>
 <td class="parameter_name"><p>in_args</p></td>
-<td class="parameter_description"><p>an array of <a class="link" href="gi-common-types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a>s, one for each in
+<td class="parameter_description"><p>an array of <a class="link" href="gi-Common-Types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a>s, one for each in
 parameter of <em class="parameter"><code>info</code></em>
 . If there are no in parameter, <em class="parameter"><code>in_args</code></em>
-can be <code class="literal">NULL</code></p></td>
-<td class="parameter_annotations"> </td>
+can be <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_in_args]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>n_in_args</p></td>
@@ -329,11 +328,11 @@ array</p></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>out_args</p></td>
-<td class="parameter_description"><p>an array of <a class="link" href="gi-common-types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a>s, one for each out
+<td class="parameter_description"><p>an array of <a class="link" href="gi-Common-Types.html#GIArgument" title="GIArgument"><span class="type">GIArgument</span></a>s, one for each out
 parameter of <em class="parameter"><code>info</code></em>
 . If there are no out parameters, <em class="parameter"><code>out_args</code></em>
-may be <code class="literal">NULL</code></p></td>
-<td class="parameter_annotations"> </td>
+may be <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_out_args]</span></td>
 </tr>
 <tr>
 <td class="parameter_name"><p>n_out_args</p></td>
@@ -358,29 +357,20 @@ may be
 </table></div>
 </div>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.7.6"></a><h4>Returns</h4>
+<a name="g-function-info-invoke.returns"></a><h4>Returns</h4>
 <p> <code class="literal">TRUE</code> if the function has been invoked, <code class="literal">FALSE</code> if an
 error occurred.</p>
-<p></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
-<a name="G-INVOKE-ERROR:CAPS"></a><h3>G_INVOKE_ERROR</h3>
-<pre class="programlisting">#define G_INVOKE_ERROR (g_invoke_error_quark ())
-</pre>
-<p>TODO</p>
-</div>
-<hr>
-<div class="refsect2">
 <a name="g-invoke-error-quark"></a><h3>g_invoke_error_quark ()</h3>
 <pre class="programlisting"><span class="returnvalue">GQuark</span>
 g_invoke_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 <p>TODO</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.6.9.5"></a><h4>Returns</h4>
+<a name="g-invoke-error-quark.returns"></a><h4>Returns</h4>
 <p> TODO</p>
-<p></p>
 </div>
 </div>
 </div>
@@ -397,8 +387,8 @@ g_invoke_error_quark (<em class="parameter"><code><span class="type">void</span>
 <a name="GIFunctionInfoFlags"></a><h3>enum GIFunctionInfoFlags</h3>
 <p>Flags for a <a class="link" href="gi-GIFunctionInfo.html#GIFunctionInfo" title="GIFunctionInfo"><span class="type">GIFunctionInfo</span></a> struct.</p>
 <div class="refsect3">
-<a name="id-1.4.2.7.7.3.4"></a><h4>Members</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="GIFunctionInfoFlags.members"></a><h4>Members</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="300px" class="enum_members_name">
 <col class="enum_members_description">
@@ -453,12 +443,19 @@ g_invoke_error_quark (<em class="parameter"><code><span class="type">void</span>
 </div>
 <hr>
 <div class="refsect2">
+<a name="G-INVOKE-ERROR:CAPS"></a><h3>G_INVOKE_ERROR</h3>
+<pre class="programlisting">#define G_INVOKE_ERROR (g_invoke_error_quark ())
+</pre>
+<p>TODO</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="GInvokeError"></a><h3>enum GInvokeError</h3>
 <p>An error occuring while invoking a function via
 <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>
 <div class="refsect3">
-<a name="id-1.4.2.7.7.4.4"></a><h4>Members</h4>
-<div class="informaltable"><table width="100%" border="0">
+<a name="GInvokeError.members"></a><h4>Members</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="300px" class="enum_members_name">
 <col class="enum_members_description">
@@ -495,7 +492,6 @@ the expected arguments for the functions type signature.</p>
 </div>
 </div>
 <div class="footer">
-<hr>
-          Generated by GTK-Doc V1.21.1</div>
+<hr>Generated by GTK-Doc V1.29.1</div>
 </body>
 </html>
\ No newline at end of file