doc/xml/gnome-vfs-module-callback-module-api.xml

   1 <refentry id="gnome-vfs-20-gnome-vfs-module-callback-module-api">
   2 <refmeta>
   3 <refentrytitle>gnome-vfs-module-callback-module-api</refentrytitle>
   4 <manvolnum>3</manvolnum>
   5 <refmiscinfo>GNOME-VFS-2.0 Library</refmiscinfo>
   6 </refmeta>
   7
   8 <refnamediv>
   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>
  10 </refnamediv>
  11
  12 <refsynopsisdiv><title>Synopsis</title>
  13
  14 <synopsis>
  15
  16
  17
  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);
  24 </synopsis>
  25 </refsynopsisdiv>
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35 <refsect1>
  36 <title>Description</title>
  37 <para>
  38
  39 </para>
  40 </refsect1>
  41
  42 <refsect1>
  43 <title>Details</title>
  44 <refsect2>
  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>
  52 <para>
  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>.
  56 </para>
  57 <para>
  58 This function should only be called by gnome-vfs modules.
  59 </para>
  60 <para>
  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
  66 FALSE.</para>
  67 <para>
  68
  69 </para><variablelist role="params">
  70 <varlistentry><term><parameter>callback_name</parameter>&nbsp;:</term>
  71 <listitem><simpara> The name of the module callback to set
  72 </simpara></listitem></varlistentry>
  73 <varlistentry><term><parameter>in</parameter>&nbsp;:</term>
  74 <listitem><simpara> In argument - type dependent on the specific callback
  75 </simpara></listitem></varlistentry>
  76 <varlistentry><term><parameter>in_size</parameter>&nbsp;:</term>
  77 <listitem><simpara> Size of the in argument
  78 </simpara></listitem></varlistentry>
  79 <varlistentry><term><parameter>out</parameter>&nbsp;:</term>
  80 <listitem><simpara> Out argument - type dependent on the specific callback
  81 </simpara></listitem></varlistentry>
  82 <varlistentry><term><parameter>out_size</parameter>&nbsp;:</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.
  86
  87 </simpara></listitem></varlistentry>
  88 </variablelist></refsect2>
  89
  90 </refsect1>
  91
  92
  93
  94
  95 </refentry>