doc/html/gnome-vfs-20-gnome-vfs-module-callback-module-api.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gnome-vfs-module-callback-module-api</title><meta name="generator" content="DocBook XSL Stylesheets V1.61.0"><meta name="generator" content="GTK-Doc V1.1 (XML mode)"><style type="text/css">
   2         .synopsis, .classsynopsis {
   3             background: #eeeeee;
   4             border: solid 1px #aaaaaa;
   5             padding: 0.5em;
   6         }
   7         .programlisting {
   8             background: #eeeeff;
   9             border: solid 1px #aaaaff;
  10             padding: 0.5em;
  11         }
  12         .variablelist {
  13             padding: 4px;
  14             margin-left: 3em;
  15         }
  16         .navigation {
  17             background: #ffeeee;
  18             border: solid 1px #ffaaaa;
  19             margin-top: 0.5em;
  20             margin-bottom: 0.5em;
  21         }
  22         .navigation a {
  23             color: #770000;
  24         }
  25         .navigation a:visited {
  26             color: #550000;
  27         }
  28         .navigation .title {
  29             font-size: 200%;
  30         }
  31       </style><link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library"><link rel="up" href="modules.html" title="Filesystem Modules"><link rel="previous" href="gnome-vfs-20-gnome-vfs-module-shared.html" title="gnome-vfs-module-shared"><link rel="next" href="gnome-vfs-20-gnome-vfs-ssl.html" title="gnome-vfs-ssl"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="gnome-vfs-20-gnome-vfs-module-shared.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th><td><a accesskey="n" href="gnome-vfs-20-gnome-vfs-ssl.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="gnome-vfs-20-gnome-vfs-module-callback-module-api"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">gnome-vfs-module-callback-module-api</span></h2><p>gnome-vfs-module-callback-module-api &#8212; invoking callbacks from a gnome-vfs module to ask the application for necessary information (authentication, ...)</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  32
  33
  34
  35 <a
  36 href="../glib/glib-Basic-Types.html#gboolean"
  37 >gboolean</a>    <a href="gnome-vfs-20-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke">gnome_vfs_module_callback_invoke</a>
  38                                             (const char *callback_name,
  39                                              <a
  40 href="../glib/glib-Basic-Types.html#gconstpointer"
  41 >gconstpointer</a> in,
  42                                              <a
  43 href="../glib/glib-Basic-Types.html#gsize"
  44 >gsize</a> in_size,
  45                                              <a
  46 href="../glib/glib-Basic-Types.html#gpointer"
  47 >gpointer</a> out,
  48                                              <a
  49 href="../glib/glib-Basic-Types.html#gsize"
  50 >gsize</a> out_size);
  51 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  52
  53 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="gnome-vfs-module-callback-invoke"></a>gnome_vfs_module_callback_invoke ()</h3><a class="indexterm" name="id2980583"></a><pre class="programlisting"><a
  54 href="../glib/glib-Basic-Types.html#gboolean"
  55 >gboolean</a>    gnome_vfs_module_callback_invoke
  56                                             (const char *callback_name,
  57                                              <a
  58 href="../glib/glib-Basic-Types.html#gconstpointer"
  59 >gconstpointer</a> in,
  60                                              <a
  61 href="../glib/glib-Basic-Types.html#gsize"
  62 >gsize</a> in_size,
  63                                              <a
  64 href="../glib/glib-Basic-Types.html#gpointer"
  65 >gpointer</a> out,
  66                                              <a
  67 href="../glib/glib-Basic-Types.html#gsize"
  68 >gsize</a> out_size);</pre><p>
  69 Invoke a default callback for <i class="parameter"><tt>callback_name</tt></i>, with in arguments
  70 specified by <i class="parameter"><tt>in</tt></i> and <i class="parameter"><tt>in_size</tt></i>, and out arguments specified by <i class="parameter"><tt>out</tt></i>
  71 and <i class="parameter"><tt>out_size</tt></i>.
  72 </p><p>
  73 This function should only be called by gnome-vfs modules.
  74 </p><p>
  75 If this function is called from an async job thread, it will invoke
  76 the current async handler for <i class="parameter"><tt>callback_name</tt></i>, if any. If no async
  77 handler is set, or the function is not called from an async job
  78 thread, the regular handler, if any, will be invoked instead. If no
  79 handler at all is found for <i class="parameter"><tt>callback_name</tt></i>, the function returns
  80 FALSE.</p><p>
  81
  82 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>callback_name</tt></i> :</span></td><td> The name of the module callback to set
  83 </td></tr><tr><td><span class="term"><i class="parameter"><tt>in</tt></i> :</span></td><td> In argument - type dependent on the specific callback
  84 </td></tr><tr><td><span class="term"><i class="parameter"><tt>in_size</tt></i> :</span></td><td> Size of the in argument
  85 </td></tr><tr><td><span class="term"><i class="parameter"><tt>out</tt></i> :</span></td><td> Out argument - type dependent on the specific callback
  86 </td></tr><tr><td><span class="term"><i class="parameter"><tt>out_size</tt></i> :</span></td><td> Size of the out argument
  87 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE if a callback was invoked, FALSE if none was set.
  88
  89 </td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="gnome-vfs-20-gnome-vfs-module-shared.html"><b>&lt;&lt; gnome-vfs-module-shared</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-20-gnome-vfs-ssl.html"><b>gnome-vfs-ssl &gt;&gt;</b></a></td></tr></table></body></html>