<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>GObject_introspection__Function_info (gobject-introspection.GObject_introspection__Function_info)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc %%VERSION%%"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> – <a href="../index.html">gobject-introspection</a> &#x00BB; GObject_introspection__Function_info</nav><h1>Module <code>GObject_introspection__Function_info</code></h1><p>Function_info — Struct representing a function.</p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt><dd><p>Function_info represents a function, method or constructor. To find out what kind of entity a Function_info represents, call Function_info.get_flags. See also Callable_info for information on how to retreive arguments and other metadata.</p></dd></dl><dl><dt class="spec value" id="val-functioninfo"><a href="#val-functioninfo" class="anchor"></a><code><span class="keyword">val</span> functioninfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.typ</span></code></dt><dt class="spec value" id="val-get_symbol"><a href="#val-get_symbol" class="anchor"></a><code><span class="keyword">val</span> get_symbol : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> string</code></dt><dd><p>Obtain the symbol of the function. The symbol is the name of the exported function, suitable to be used as an argument to g_module_symbol().</p></dd></dl><dl><dt class="spec value" id="val-get_flags"><a href="#val-get_flags" class="anchor"></a><code><span class="keyword">val</span> get_flags : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><a href="../Bindings/Function_info/index.html#type-flags">Bindings.Function_info.flags</a> list</span></code></dt><dd><p>Obtain the Function_infoFlags for the info .</p></dd></dl><dl><dt class="spec value" id="val-get_property"><a href="#val-get_property" class="anchor"></a><code><span class="keyword">val</span> get_property : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><span><a href="../GObject_introspection/Property_info/index.html#type-t">GObject_introspection.Property_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> option</span></code></dt><dd><p>Obtain the property associated with this Function_info. Only Function_info with the flag GIFunction.Is_getter or GIFunction.Is_setter have a property set. For other cases, NULL will be returned.</p></dd></dl><dl><dt class="spec value" id="val-get_vfunc"><a href="#val-get_vfunc" class="anchor"></a><code><span class="keyword">val</span> get_vfunc : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><span><a href="../GObject_introspection/Callable_info/index.html#type-t">GObject_introspection.Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> option</span></code></dt><dd><p>Obtain the virtual function associated with this Function_info. Only Function_info with the flag Wraps_vfunc has a virtual function set. For other cases, None will be returned. In order to avoid circular call graph between Function_info and VFunc_info, this function will return a Callable_info. It is upto the user to use VFunc_info.from_callableinfo in order to have the VFunc_info.</p></dd></dl><dl><dt class="spec value" id="val-cast_from_baseinfo"><a href="#val-cast_from_baseinfo" class="anchor"></a><code><span class="keyword">val</span> cast_from_baseinfo : <span><span><a href="../GObject_introspection/Base_info/index.html#type-t">GObject_introspection.Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes base info to function info.</p></dd></dl><dl><dt class="spec value" id="val-cast_to_baseinfo"><a href="#val-cast_to_baseinfo" class="anchor"></a><code><span class="keyword">val</span> cast_to_baseinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../GObject_introspection/Base_info/index.html#type-t">GObject_introspection.Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes function info to base info</p></dd></dl><dl><dt class="spec value" id="val-add_unref_finaliser"><a href="#val-add_unref_finaliser" class="anchor"></a><code><span class="keyword">val</span> add_unref_finaliser : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Add unref of the C underlying structure whith Gc.finalise.</p></dd></dl><dl><dt class="spec value" id="val-from_baseinfo"><a href="#val-from_baseinfo" class="anchor"></a><code><span class="keyword">val</span> from_baseinfo : <span><span><a href="../GObject_introspection/Base_info/index.html#type-t">GObject_introspection.Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Function_info.t from a Base_info.t, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-to_baseinfo"><a href="#val-to_baseinfo" class="anchor"></a><code><span class="keyword">val</span> to_baseinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../GObject_introspection/Base_info/index.html#type-t">GObject_introspection.Base_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Base_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-cast_from_callableinfo"><a href="#val-cast_from_callableinfo" class="anchor"></a><code><span class="keyword">val</span> cast_from_callableinfo : <span><span><a href="../GObject_introspection/Callable_info/index.html#type-t">GObject_introspection.Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes callable info to function info.</p></dd></dl><dl><dt class="spec value" id="val-cast_to_callableinfo"><a href="#val-cast_to_callableinfo" class="anchor"></a><code><span class="keyword">val</span> cast_to_callableinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../GObject_introspection/Callable_info/index.html#type-t">GObject_introspection.Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Just cast OCaml Ctypes function info to callable info</p></dd></dl><dl><dt class="spec value" id="val-from_callableinfo"><a href="#val-from_callableinfo" class="anchor"></a><code><span class="keyword">val</span> from_callableinfo : <span><span><a href="../GObject_introspection/Callable_info/index.html#type-t">GObject_introspection.Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Function_info.t from a Callable_info.t, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl><dl><dt class="spec value" id="val-to_callableinfo"><a href="#val-to_callableinfo" class="anchor"></a><code><span class="keyword">val</span> to_callableinfo : <span><span><a href="index.html#type-t">t</a> Ctypes.structure</span> Ctypes.ptr</span> <span>&#45;&gt;</span> <span><span><a href="../GObject_introspection/Callable_info/index.html#type-t">GObject_introspection.Callable_info.t</a> Ctypes.structure</span> Ctypes.ptr</span></code></dt><dd><p>Return a Callable_info.t from a Function_info, the underlying C structure ref count is increased and the value is Gc.finalis&quot;ed&quot; with Base_info.baseinfo_unref.</p></dd></dl></div></body></html>