95 lines
5.3 KiB
HTML
95 lines
5.3 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="SQLCloseCursor - Close cursor 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="rzadpclscur" />
|
|
<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>SQLCloseCursor - Close cursor statement</title>
|
|
</head>
|
|
<body id="rzadpclscur"><a name="rzadpclscur"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">SQLCloseCursor - Close cursor statement</h1>
|
|
<div><div class="section"></div>
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLCloseCursor()</samp> closes
|
|
the open cursor on a statement handle.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLCloseCursor (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. SQLCloseCursor arguments</caption><thead align="left"><tr><th align="left" valign="bottom" width="20%" id="d0e45">Data type</th>
|
|
<th align="left" valign="bottom" width="20%" id="d0e47">Argument</th>
|
|
<th align="left" valign="bottom" width="20%" id="d0e49">Use</th>
|
|
<th align="left" valign="bottom" width="40%" id="d0e51">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e45 ">SQLHSTMT</td>
|
|
<td align="left" valign="top" width="20%" headers="d0e47 "><em>hstmt</em></td>
|
|
<td align="left" valign="top" width="20%" headers="d0e49 ">Input</td>
|
|
<td align="left" valign="top" width="40%" headers="d0e51 ">Statement handle</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>Calling <samp class="codeph">SQLCloseCursor()</samp> closes
|
|
any cursor associated with the statement handle and discards any pending results.
|
|
If no open cursor is associated with the statement handle, the function has
|
|
no effect.</p>
|
|
<p>If the statement handle references a stored procedure that
|
|
has multiple result sets, the <samp class="codeph">SQLCloseCursor()</samp> closes only
|
|
the current result set. Any additional result sets remain open and usable.</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. SQLCloseCursor SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e102">SQLSTATE</th>
|
|
<th align="left" valign="top" width="25%" id="d0e104">Description</th>
|
|
<th align="left" valign="top" width="50%" id="d0e106">Explanation</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e102 "><strong>08</strong>003 <strong>*</strong></td>
|
|
<td align="left" valign="top" width="25%" headers="d0e104 ">Connection not open</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e106 ">The connection for <samp class="codeph">hstmt</samp> is
|
|
not established.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e102 "><strong>HY</strong>009 <strong>*</strong></td>
|
|
<td align="left" valign="top" width="25%" headers="d0e104 ">Argument value that is not valid</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e106 "><em>hstmt</em> is not a statement handle.</td>
|
|
</tr>
|
|
<tr><td valign="top" width="25%" headers="d0e102 "><strong>HY</strong>021</td>
|
|
<td valign="top" width="25%" headers="d0e104 ">Internal descriptor that is not valid</td>
|
|
<td valign="top" width="50%" headers="d0e106 ">The internal descriptor cannot be addressed or allocated,
|
|
or it contains a value that is not valid.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</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> |