doc/html/gnome-vfs-gnome-vfs-context.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>
   2 GnomeVFSContext</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">
   3         .synopsis, .classsynopsis {
   4             background: #eeeeee;
   5             border: solid 1px #aaaaaa;
   6             padding: 0.5em;
   7         }
   8         .programlisting {
   9             background: #eeeeff;
  10             border: solid 1px #aaaaff;
  11             padding: 0.5em;
  12         }
  13         .variablelist {
  14             padding: 4px;
  15             margin-left: 3em;
  16         }
  17         .navigation {
  18             background: #ffeeee;
  19             border: solid 1px #ffaaaa;
  20             margin-top: 0.5em;
  21             margin-bottom: 0.5em;
  22         }
  23         .navigation a {
  24             color: #770000;
  25         }
  26         .navigation a:visited {
  27             color: #550000;
  28         }
  29         .navigation .title {
  30             font-size: 200%;
  31         }
  32       </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-gnome-vfs-ssl.html" title="gnome-vfs-ssl"><link rel="next" href="gnome-vfs-gnome-vfs-socket.html" title="gnome-vfs-socket"></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-gnome-vfs-ssl.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-gnome-vfs-socket.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-gnome-vfs-context"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2><span class="refentrytitle">
  33 GnomeVFSContext</span></h2><p>
  34 GnomeVFSContext &#8212;
  35 contexts allows modules to track thread usage and cancellation properly</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  36
  37
  38
  39 GnomeVFSContext* <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-new">gnome_vfs_context_new</a>      (void);
  40 void        <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-free">gnome_vfs_context_free</a>          (GnomeVFSContext *ctx);
  41 GnomeVFSCancellation* <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-get-cancellation">gnome_vfs_context_get_cancellation</a>
  42                                             (const GnomeVFSContext *ctx);
  43 #define     <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-check-cancellation">gnome_vfs_context_check_cancellation</a>(x)
  44 const GnomeVFSContext* <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-peek-current">gnome_vfs_context_peek_current</a>
  45                                             (void);
  46 <a
  47 href="../glib/glib-Basic-Types.html#gboolean"
  48 >gboolean</a>    <a href="gnome-vfs-gnome-vfs-context.html#gnome-vfs-context-check-cancellation-current">gnome_vfs_context_check_cancellation_current</a>
  49                                             (void);
  50 </pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
  51
  52 </p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-new"></a>gnome_vfs_context_new ()</h3><pre class="programlisting">GnomeVFSContext* gnome_vfs_context_new      (void);</pre><p>
  53 Creates a new context and cancellation object. Must be called
  54 from the main glib event loop.</p><p>
  55
  56 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a newly allocated GnomeVFSContext
  57 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-free"></a>gnome_vfs_context_free ()</h3><pre class="programlisting">void        gnome_vfs_context_free          (GnomeVFSContext *ctx);</pre><p>
  58 Free <i class="parameter"><tt>ctx</tt></i> and destroy the associated GnomeVFSCancellation.</p><p>
  59
  60 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> context to be freed
  61 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-get-cancellation"></a>gnome_vfs_context_get_cancellation ()</h3><pre class="programlisting">GnomeVFSCancellation* gnome_vfs_context_get_cancellation
  62                                             (const GnomeVFSContext *ctx);</pre><p>
  63 Retrieve the GnomeVFSCancellation associated with <i class="parameter"><tt>ctx</tt></i>.</p><p>
  64
  65 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>ctx</tt></i> :</span></td><td> context to get the GnomeVFSCancellation from
  66 </td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <i class="parameter"><tt>ctx</tt></i> 's GnomeVFSCancellation
  67 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-check-cancellation"></a>gnome_vfs_context_check_cancellation()</h3><pre class="programlisting">#define     gnome_vfs_context_check_cancellation(x)</pre><p>
  68
  69 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>x</tt></i> :</span></td><td>
  70
  71
  72 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-peek-current"></a>gnome_vfs_context_peek_current ()</h3><pre class="programlisting">const GnomeVFSContext* gnome_vfs_context_peek_current
  73                                             (void);</pre><p>
  74 Get the currently active context. It shouldn't be
  75 manipulated but can be compared to context's the module
  76 holds to determine whether they are active.</p><p>
  77
  78 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the currently active GnomeVFSContext
  79 </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><h3><a name="gnome-vfs-context-check-cancellation-current"></a>gnome_vfs_context_check_cancellation_current ()</h3><pre class="programlisting"><a
  80 href="../glib/glib-Basic-Types.html#gboolean"
  81 >gboolean</a>    gnome_vfs_context_check_cancellation_current
  82                                             (void);</pre><p>
  83 Check to see if the currently active context has been cancelled.</p><p>
  84
  85 </p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if the currently active context has been cancelled, otherwise <tt class="literal">FALSE</tt>
  86 </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-gnome-vfs-ssl.html"><b>&lt;&lt; gnome-vfs-ssl</b></a></td><td align="right"><a accesskey="n" href="gnome-vfs-gnome-vfs-socket.html"><b>gnome-vfs-socket &gt;&gt;</b></a></td></tr></table></body></html>