108 lines
6.2 KiB
HTML
108 lines
6.2 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="SQLFreeHandle - Free a handle" />
|
|
<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="rzadpfnfhdl" />
|
|
<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>SQLFreeHandle</title>
|
|
</head>
|
|
<body id="rzadpfnfhdl"><a name="rzadpfnfhdl"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">SQLFreeHandle - Free a handle</h1>
|
|
<div><div class="section"></div>
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLFreeHandle()</samp> invalidates
|
|
and frees a handle.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLFreeHandle (SQLSMALLINT htype,
|
|
SQLINTEGER handle);</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. SQLFreeHandle arguments</caption><thead align="left"><tr><th align="left" valign="top" width="20%" id="d0e54">Data type</th>
|
|
<th align="left" valign="top" width="20%" id="d0e56">Argument</th>
|
|
<th align="left" valign="top" width="20%" id="d0e58">Use</th>
|
|
<th align="left" valign="top" width="40%" id="d0e60">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e54 ">SQLINTEGER</td>
|
|
<td align="left" valign="top" width="20%" headers="d0e56 "><em>handle</em></td>
|
|
<td align="left" valign="top" width="20%" headers="d0e58 ">Input</td>
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">The handle to be freed.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="20%" headers="d0e54 ">SQLSMALLINT</td>
|
|
<td align="left" valign="top" width="20%" headers="d0e56 "><em>hType</em></td>
|
|
<td align="left" valign="top" width="20%" headers="d0e58 ">Input</td>
|
|
<td align="left" valign="top" width="40%" headers="d0e60 ">Handle type that must be SQL_HANDLE_ENV,
|
|
SQL_HANDLE_DBC, SQL_HANDLE_STMT, or SQL_HANDLE_DESC.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p><samp class="codeph">SQLFreeHandle()</samp> combines
|
|
the function of <samp class="codeph">SQLFreeEnv(), SQLFreeConnect(),</samp> and <samp class="codeph">SQLFreeStmt()</samp>.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Return codes</h4><ul><li>SQL_SUCCESS</li>
|
|
<li>SQL_ERROR</li>
|
|
<li>SQL_INVALID_HANDLE</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. SQLFreeHandle SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e121">SQLSTATE</th>
|
|
<th align="left" valign="top" width="25%" id="d0e123">Description</th>
|
|
<th align="left" valign="top" width="50%" id="d0e125">Explanation</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e121 "><strong>58</strong>004</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e123 ">System error</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e125 ">Unrecoverable system error.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e121 "><strong>HY</strong>001</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e123 ">Memory allocation failure</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e125 ">The driver is unable to allocate memory required
|
|
to support the processing or completion of the function.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e121 "><strong>HY</strong>010</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e123 ">Function sequence error</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e125 ">There is an <em>hdbc</em> which is in allocated
|
|
or connected state. Call SQLDisconnect and SQLFreeConnect for the <em>hdbc</em> before
|
|
calling SQLFreeHandle.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e121 "><strong>HY</strong>013 <strong>*</strong></td>
|
|
<td align="left" valign="top" width="25%" headers="d0e123 ">Memory management problem</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e125 ">The driver is unable to access memory required
|
|
to support the processing or completion of the function.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">References</h4><ul><li><a href="rzadpfnfconn.htm#rzadpfnfconn">SQLFreeConnect - Free connection handle</a></li>
|
|
<li><a href="rzadpfnfenv.htm#rzadpfnfenv">SQLFreeEnv - Free environment handle</a></li>
|
|
<li><a href="rzadpfnfstmt.htm#rzadpfnfstmt">SQLFreeStmt - Free (or reset) a statement handle</a></li>
|
|
</ul>
|
|
</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> |