��JFIF��2� /usr/share/doc/liblqr-1-0-dev/html/ Current File: //usr/share/doc/liblqr-1-0-dev/html/ref-lqr-carver-cancel.html
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>lqr_carver_cancel</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="The Liquid Rescale library Manual"><link rel="up" href="ref-carve.html" title="Carver objects"><link rel="prev" href="ref-lqr-carver-flatten.html" title="lqr_carver_flatten"><link rel="next" href="ref-lqr-carver-scan-reset.html" title="lqr_carver_scan_reset"></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"><code class="function">lqr_carver_cancel</code></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ref-lqr-carver-flatten.html">Prev</a>�</td><th width="60%" align="center">Carver objects</th><td width="20%" align="right">�<a accesskey="n" href="ref-lqr-carver-scan-reset.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="ref-lqr-carver-cancel"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>lqr_carver_cancel &#8212; cancel ongoing operations on a <code class="classname">LqrCarver</code> object</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include &lt;lqr.h&gt;</pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">LqrRetVal <b class="fsfunc">lqr_carver_cancel</b>(</code></td><td>LqrCarver* <var class="pdparam">carver</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">�</div></div></div><div class="refsect1"><a name="id3591"></a><h2>Description</h2><p>
                        The function <code class="function">lqr_carver_cancel</code> can be used to cancel an ongoing operation
                        which is currently being performed on the the <code class="classname">LqrCarver</code> object pointed to by
                        <em class="parameter"><code>carver</code></em>. It must be used asynchronouly, from within an independent thread.
                    </p><p>
                        If an operation is in fact cancelled by this function, the function which was performing the
                        operation will return the value <code class="literal"><span class="errorcode">LQR_USRCANCEL</span></code>, and so will do any other operation successively
                        called on the same <code class="classname">LqrCarver</code> object whose return type is <code class="classname">LqrRetVal</code>;
                        otherwise it will have no effect.
                    </p><p>
                        Whenever a function returns <code class="literal"><span class="errorcode">LQR_USRCANCEL</span></code>, it means that the <code class="classname">LqrCarver</code> object is in an
                        inconsistent state, and, since there is currently no way to recover from this situation, any
                        further operation on that object must be avoided, and it must be destroyed.
                    </p><p>
                        This function will fail if invoked over attached <code class="classname">LqrCarver</code> objects.
                    </p></div><div class="refsect1"><a name="id3608"></a><h2>Return value</h2><p>
                        The return value follows the Liquid Rescale library signalling system. However, it can be called multiple times,
                        so it will never return <code class="literal"><span class="errorcode">LQR_USRCANCEL</span></code> itself.
                    </p></div><div class="refsect1"><a name="id3613"></a><h2>See also</h2><p>
                        <span class="simplelist"><a class="xref" href="ref-lqr-ret-val.html" title="LqrRetVal"><span class="refentrytitle"><span class="type">LqrRetVal</span></span>(3)</a>, <a class="xref" href="ref-lqr-carver-resize.html" title="lqr_carver_resize"><span class="refentrytitle"><code class="function">lqr_carver_resize</code></span>(3)</a>, <a class="xref" href="ref-lqr-carver-flatten.html" title="lqr_carver_flatten"><span class="refentrytitle"><code class="function">lqr_carver_flatten</code></span>(3)</a></span>
                    </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ref-lqr-carver-flatten.html">Prev</a>�</td><td width="20%" align="center"><a accesskey="u" href="ref-carve.html">Up</a></td><td width="40%" align="right">�<a accesskey="n" href="ref-lqr-carver-scan-reset.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><code class="function">lqr_carver_flatten</code>�</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">�<code class="function">lqr_carver_scan_reset</code></td></tr></table></div></body></html>