1
<refentry id="gnome-vfs-20-gnome-vfs-module-callback-module-api">
3
<refentrytitle>gnome-vfs-module-callback-module-api</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
9
<refname>gnome-vfs-module-callback-module-api</refname><refpurpose>invoking callbacks from a gnome-vfs module to ask the application for necessary information (authentication, ...)</refpurpose>
12
<refsynopsisdiv><title>Synopsis</title>
18
<link linkend="gboolean">gboolean</link> <link linkend="gnome-vfs-module-callback-invoke">gnome_vfs_module_callback_invoke</link>
19
(const <link linkend="char">char</link> *callback_name,
20
<link linkend="gconstpointer">gconstpointer</link> in,
21
<link linkend="gsize">gsize</link> in_size,
22
<link linkend="gpointer">gpointer</link> out,
23
<link linkend="gsize">gsize</link> out_size);
36
<title>Description</title>
43
<title>Details</title>
45
<title><anchor id="gnome-vfs-module-callback-invoke"/>gnome_vfs_module_callback_invoke ()</title>
46
<indexterm><primary>gnome_vfs_module_callback_invoke</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gnome_vfs_module_callback_invoke
47
(const <link linkend="char">char</link> *callback_name,
48
<link linkend="gconstpointer">gconstpointer</link> in,
49
<link linkend="gsize">gsize</link> in_size,
50
<link linkend="gpointer">gpointer</link> out,
51
<link linkend="gsize">gsize</link> out_size);</programlisting>
53
Invoke a default callback for <parameter>callback_name</parameter>, with in arguments
54
specified by <parameter>in</parameter> and <parameter>in_size</parameter>, and out arguments specified by <parameter>out</parameter>
55
and <parameter>out_size</parameter>.
58
This function should only be called by gnome-vfs modules.
61
If this function is called from an async job thread, it will invoke
62
the current async handler for <parameter>callback_name</parameter>, if any. If no async
63
handler is set, or the function is not called from an async job
64
thread, the regular handler, if any, will be invoked instead. If no
65
handler at all is found for <parameter>callback_name</parameter>, the function returns
69
</para><variablelist role="params">
70
<varlistentry><term><parameter>callback_name</parameter> :</term>
71
<listitem><simpara> The name of the module callback to set
72
</simpara></listitem></varlistentry>
73
<varlistentry><term><parameter>in</parameter> :</term>
74
<listitem><simpara> In argument - type dependent on the specific callback
75
</simpara></listitem></varlistentry>
76
<varlistentry><term><parameter>in_size</parameter> :</term>
77
<listitem><simpara> Size of the in argument
78
</simpara></listitem></varlistentry>
79
<varlistentry><term><parameter>out</parameter> :</term>
80
<listitem><simpara> Out argument - type dependent on the specific callback
81
</simpara></listitem></varlistentry>
82
<varlistentry><term><parameter>out_size</parameter> :</term>
83
<listitem><simpara> Size of the out argument
84
</simpara></listitem></varlistentry>
85
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a callback was invoked, FALSE if none was set.
87
</simpara></listitem></varlistentry>
88
</variablelist></refsect2>
added
removed
doc/xml/gnome-vfs-module-callback-module-api.xml
