88 lines
4.7 KiB
HTML
88 lines
4.7 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="reference" />
|
||
|
|
<meta name="DC.Title" content="SQLCancel - Cancel statement" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzadphdapi.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzadpfncan" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>SQLCancel - Cancel statement</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzadpfncan"><a name="rzadpfncan"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">SQLCancel - Cancel statement</h1>
|
||
|
|
<div><div class="section"></div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLCancel()</samp> attempts to
|
||
|
|
end the processing of an ongoing SQL statement operation that is executing
|
||
|
|
synchronously. To cancel the function, the application calls <samp class="codeph">SQLCancel()</samp> with
|
||
|
|
the same statement handle that is used by the target function, but on a different
|
||
|
|
thread. How the function is canceled depends on the operating
|
||
|
|
system.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4> <pre>SQLRETURN SQLCancel (SQLHSTMT hstmt);</pre>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Function arguments</h4>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="hsides" border="1" rules="all"><caption>Table 1. SQLCancel arguments</caption><thead align="left"><tr><th align="left" valign="bottom" width="20%" id="d0e49">Data type</th>
|
||
|
|
<th align="left" valign="bottom" width="20%" id="d0e51">Argument</th>
|
||
|
|
<th align="left" valign="bottom" width="20%" id="d0e53">Use</th>
|
||
|
|
<th align="left" valign="bottom" width="40%" id="d0e55">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e49 ">SQLHSTMT</td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e51 "><em>hstmt</em></td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e53 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e55 ">Statement handle</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>A successful return code indicates that the
|
||
|
|
implementation has accepted the cancel request; it does not ensure that the
|
||
|
|
processing is cancelled.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Return codes</h4><ul><li>SQL_SUCCESS</li>
|
||
|
|
<li>SQL_INVALID_HANDLE</li>
|
||
|
|
<li>SQL_ERROR</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Diagnostics</h4>
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" width="100%" frame="hsides" border="1" rules="rows"><caption>Table 2. SQLCancel SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="bottom" width="25%" id="d0e98">SQLSTATE</th>
|
||
|
|
<th align="left" valign="bottom" width="25%" id="d0e100">Description</th>
|
||
|
|
<th align="left" valign="bottom" width="50%" id="d0e102">Explanation</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e98 "><strong>HY</strong>009 <strong>*</strong></td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e100 ">Argument value that is not valid</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e102 "><em>hstmt</em> is not a statement handle.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Restrictions</h4><p>DB2<sup>®</sup> UDB CLI does not support asynchronous
|
||
|
|
statement processing.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzadphdapi.htm" title="This topic provides a description of each CLI function.">DB2 UDB CLI functions</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|