1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>cancel_work_sync</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Linux Device Drivers"><link rel="up" href="ch01s06.html" title="Workqueues and Kevents"><link rel="prev" href="API-flush-work.html" title="flush_work"><link rel="next" href="API-flush-delayed-work.html" title="flush_delayed_work"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">cancel_work_sync</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-flush-work.html">Prev</a>&#160;</td><th width="60%" align="center">Workqueues and Kevents</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-flush-delayed-work.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-cancel-work-sync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>cancel_work_sync &#8212; 
2     cancel a work and wait for it to finish
3 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">bool <b class="fsfunc">cancel_work_sync </b>(</code></td><td>struct work_struct * <var class="pdparam">work</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a name="idp1107733756"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>work</code></em></span></dt><dd><p>
4     the work to cancel
5    </p></dd></dl></div></div><div class="refsect1"><a name="idp1107735372"></a><h2>Description</h2><p>
6   Cancel <em class="parameter"><code>work</code></em> and wait for its execution to finish.  This function
7   can be used even if the work re-queues itself or migrates to
8   another workqueue.  On return from this function, <em class="parameter"><code>work</code></em> is
9   guaranteed to be not pending or executing on any CPU.
10   </p><p>
11
12   cancel_work_sync(<span class="structname">delayed_work</span>-&gt;work) must not be used for
13   delayed_work's.  Use <code class="function">cancel_delayed_work_sync</code> instead.
14   </p><p>
15
16   The caller must ensure that the workqueue on which <em class="parameter"><code>work</code></em> was last
17   queued can't be destroyed before this function returns.
18</p></div><div class="refsect1"><a name="idp1107738412"></a><h2>Return</h2><p>
19   <code class="constant">true</code> if <em class="parameter"><code>work</code></em> was pending, <code class="constant">false</code> otherwise.
20</p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-flush-work.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="ch01s06.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-flush-delayed-work.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">flush_work</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">flush_delayed_work</span></td></tr></table></div></body></html>
21