133 lines
7.8 KiB
HTML
133 lines
7.8 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="SQLDisconnect - Disconnect from a data source" />
|
|
<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="rzadpfndconn" />
|
|
<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>SQLDisconnect</title>
|
|
</head>
|
|
<body id="rzadpfndconn"><a name="rzadpfndconn"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">SQLDisconnect - Disconnect from a data source</h1>
|
|
<div><div class="section"></div>
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLDisconnect()</samp> closes the connection
|
|
associated with the database connection handle.</p>
|
|
<p>After calling this function,
|
|
either call <samp class="codeph">SQLConnect()</samp> to connect to another database,
|
|
or call <samp class="codeph">SQLFreeConnect()</samp>.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLDisconnect (SQLHDBC hdbc);</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. SQLDisconnect arguments</caption><thead align="left"><tr><th align="left" valign="bottom" width="20%" id="d0e57">Data type</th>
|
|
<th align="left" valign="bottom" width="20%" id="d0e59">Argument</th>
|
|
<th align="left" valign="bottom" width="20%" id="d0e61">Use</th>
|
|
<th align="left" valign="bottom" width="40%" id="d0e63">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e57 ">SQLHDBC</td>
|
|
<td align="left" valign="top" width="20%" headers="d0e59 "><em>hdbc</em></td>
|
|
<td align="left" valign="top" width="20%" headers="d0e61 ">Input</td>
|
|
<td align="left" valign="top" width="40%" headers="d0e63 ">Connection handle</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>If an application calls <samp class="codeph">SQLDisconnect</samp> before
|
|
it has freed all the statement handles associated with the connection, DB2<sup>®</sup> UDB
|
|
CLI frees them after it successfully disconnects from the database.</p>
|
|
<div class="p">If
|
|
SQL_SUCCESS_WITH_INFO is returned, it implies that even though the disconnect
|
|
from the database is successful, additional error or implementation specific
|
|
information is available. For example: <ul><li>A problem is encountered on the clean up after the disconnect, or,</li>
|
|
<li>If there is no current connection because of an event that occurred independently
|
|
of the application (such as communication failure).</li>
|
|
</ul>
|
|
</div>
|
|
<p>After a successful <samp class="codeph">SQLDisconnect()</samp> call, the
|
|
application can re-use <em>hdbc</em> to make another <samp class="codeph">SQLConnect()</samp> request.</p>
|
|
<p>If
|
|
the <em>hdbc</em> is participating in a DUOW two-phase commit connection, the
|
|
disconnect might not occur immediately. The actual disconnect occurs at the
|
|
next commit issued for the distributed transaction.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">Return codes</h4><ul><li>SQL_SUCCESS</li>
|
|
<li>SQL_SUCCESS_WITH_INFO</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. SQLDisconnect SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e137">SQLSTATE</th>
|
|
<th align="left" valign="top" width="25%" id="d0e139">Description</th>
|
|
<th align="left" valign="top" width="50%" id="d0e141">Explanation</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e137 "><strong>01</strong>002</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">Disconnect error</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">An error occurred during the disconnect.
|
|
However, the disconnect succeeded. (Function returns SQL_SUCCESS_WITH_INFO.)</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e137 "><strong>08</strong>003</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">Connection not open</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">The connection specified in the argument <em>hdbc</em> is
|
|
not open.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e137 "><strong>25</strong>000</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">Transaction state that is not valid</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">There is a transaction in process on the
|
|
connection specified by the argument <em>hdbc</em>. The transaction remains
|
|
active, and the connection cannot be disconnected.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e137 "><strong>58</strong>004</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">System error</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">Unrecoverable system error.</td>
|
|
</tr>
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e137 "><strong>HY</strong>001</td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">Memory allocation failure</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">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="d0e137 "><strong>HY</strong>013 <strong>*</strong></td>
|
|
<td align="left" valign="top" width="25%" headers="d0e139 ">Memory management problem</td>
|
|
<td align="left" valign="top" width="50%" headers="d0e141 ">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">Example</h4></div>
|
|
<div class="example" id="rzadpfndconn__xmdconn"><a name="rzadpfndconn__xmdconn"><!-- --></a><p>Refer to the example in <a href="rzadpfnaenv.htm">SQLAllocEnv - Allocate environment handle</a>.</p>
|
|
</div>
|
|
<div class="section"><h4 class="sectiontitle">References</h4><ul><li><a href="rzadpfnacon.htm#rzadpfnacon">SQLAllocConnect - Allocate connection handle</a></li>
|
|
<li><a href="rzadpfnconn.htm#rzadpfnconn">SQLConnect - Connect to a data source</a></li>
|
|
<li><a href="rzadpfntrans.htm#rzadpfntrans">SQLTransact - Commit or roll back transaction</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> |