📄 gcancellable.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"><title>GCancellable</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="GIO Reference Manual"><link rel="up" href="async.html" title="Asynchronous I/O"><link rel="prev" href="async.html" title="Asynchronous I/O"><link rel="next" href="GAsyncResult.html" title="GAsyncResult"><meta name="generator" content="GTK-Doc V1.9 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="pt01.html" title="Part I. GIO Overview"><link rel="chapter" href="ch01.html" title="Introduction"><link rel="chapter" href="ch02.html" title="Compiling GIO applications"><link rel="chapter" href="ch03.html" title="Running GIO applications"><link rel="chapter" href="gio-extension-points.html" title="Extending GIO"><link rel="part" href="pt02.html" title="Part II. API Reference"><link rel="chapter" href="file_ops.html" title="File Operations"><link rel="chapter" href="file_mon.html" title="File System Monitoring"><link rel="chapter" href="async.html" title="Asynchronous I/O"><link rel="chapter" href="streaming.html" title="Streaming I/O"><link rel="chapter" href="types.html" title="File types and applications"><link rel="chapter" href="volume_mon.html" title="Volumes and Drives"><link rel="chapter" href="icons.html" title="Icons"><link rel="chapter" href="utils.html" title="Utilities"><link rel="chapter" href="extending.html" title="Extending GIO"><link rel="part" href="migrating.html" title="Part III. Migrating to GIO"><link rel="chapter" href="ch14.html" title="Migrating from POSIX to GIO"><link rel="chapter" href="ch15.html" title="Migrating from GnomeVFS to GIO"><link rel="chapter" href="gio-hierarchy.html" title="Object Hierarchy"><link rel="index" href="ix01.html" title="Index"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="async.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="async.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">GIO Reference Manual</th><td><a accesskey="n" href="GAsyncResult.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr><tr><td colspan="5" class="shortcuts"><nobr><a href="#id3090591" class="shortcut">Top</a>  |  <a href="#id3097204" class="shortcut">Description</a>  |  <a href="#id3097156" class="shortcut">Object Hierarchy</a>  |  <a href="#id3097180" class="shortcut">Signals</a></nobr></td></tr></table><div class="refentry" lang="en"><a name="GCancellable"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><a name="id3090591"></a><span class="refentrytitle">GCancellable</span></h2><p>GCancellable — Thread-safe Operation Cancellation Stack</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">#include <gio/gio.h> <a class="link" href="GCancellable.html#GCancellable-struct">GCancellable</a>;<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>* <a class="link" href="GCancellable.html#g-cancellable-new">g_cancellable_new</a> (void);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GCancellable.html#g-cancellable-is-cancelled">g_cancellable_is_cancelled</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);<ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GCancellable.html#g-cancellable-set-error-if-cancelled">g_cancellable_set_error_if_cancelled</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);int <a class="link" href="GCancellable.html#g-cancellable-get-fd">g_cancellable_get_fd</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>* <a class="link" href="GCancellable.html#g-cancellable-get-current">g_cancellable_get_current</a> (void);void <a class="link" href="GCancellable.html#g-cancellable-pop-current">g_cancellable_pop_current</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);void <a class="link" href="GCancellable.html#g-cancellable-push-current">g_cancellable_push_current</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);void <a class="link" href="GCancellable.html#g-cancellable-reset">g_cancellable_reset</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);void <a class="link" href="GCancellable.html#g-cancellable-cancel">g_cancellable_cancel</a> (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre></div><div class="refsect1" lang="en"><a name="id3097156"></a><h2>Object Hierarchy</h2><pre class="synopsis"> <ahref="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a> +----GCancellable</pre></div><div class="refsect1" lang="en"><a name="id3097180"></a><h2>Signals</h2><pre class="synopsis"> "<a class="link" href="GCancellable.html#GCancellable-cancelled">cancelled</a>" : Run Last</pre></div><div class="refsect1" lang="en"><a name="id3097204"></a><h2>Description</h2><p>GCancellable is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous andasynchronous operations.</p><p></p></div><div class="refsect1" lang="en"><a name="id3097226"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id3097237"></a><h3><a name="GCancellable-struct"></a>GCancellable</h3><a class="indexterm" name="id3097249"></a><pre class="programlisting">typedef struct _GCancellable GCancellable;</pre><p>Allows actions to be cancelled.</p><p></p></div><hr><div class="refsect2" lang="en"><a name="id3097268"></a><h3><a name="g-cancellable-new"></a>g_cancellable_new ()</h3><a class="indexterm" name="id3097281"></a><pre class="programlisting"><a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a>* g_cancellable_new (void);</pre><p>Creates a new <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.</p><p>Applications that want to start one or more operationsthat should be cancellable should create a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>and pass it to the operations.</p><p>One <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> can be used in multiple consecutiveoperations, but not in multiple concurrent operations.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a>.</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3142474"></a><h3><a name="g-cancellable-is-cancelled"></a>g_cancellable_is_cancelled ()</h3><a class="indexterm" name="id3142485"></a><pre class="programlisting"><ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_cancellable_is_cancelled (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable);</pre><p>Checks if a cancellable job has been cancelled.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td><td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> or NULL.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td> <ahref="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>cancellable</code></em> is cancelled, FALSE if called with <ahref="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> or if item is not cancelled. </td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id3145223"></a><h3><a name="g-cancellable-set-error-if-cancelled"></a>g_cancellable_set_error_if_cancelled ()</h3><a class="indexterm" name="id3145234"></a><pre class="programlisting"><ahref="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_cancellable_set_error_if_cancelled (<a class="link" href="GCancellable.html" title="GCancellable">GCancellable</a> *cancellable, <ahref="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError">GError</a> **error);</pre><p>If the <em class="parameter"><code>cancelalble</code></em> is cancelled, sets the error to notifythat the operation was cancelled.</p><p></p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td><td> a <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object.⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -