108 lines
6.1 KiB
HTML
108 lines
6.1 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="SQLReleaseEnv - Release all environment resources" />
|
||
|
|
<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="rzadpfnrelv" />
|
||
|
|
<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>SQLReleaseEnv</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzadpfnrelv"><a name="rzadpfnrelv"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">SQLReleaseEnv - Release all environment resources</h1>
|
||
|
|
<div><div class="section"></div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Purpose</h4> <p><samp class="codeph">SQLReleaseEnv()</samp> invalidates
|
||
|
|
and frees the environment handle. All DB2<sup>®</sup> UDB CLI resources associated with the
|
||
|
|
environment handle are freed.</p>
|
||
|
|
<p><samp class="codeph">SQLFreeConnect()</samp> must
|
||
|
|
be called before calling this function.</p>
|
||
|
|
<p>This function is the last DB2 UDB
|
||
|
|
CLI step an application needs to do before terminating.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Syntax</h4><pre>SQLRETURN SQLReleaseEnv (SQLHENV henv);</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. SQLReleaseEnv arguments</caption><thead align="left"><tr><th align="left" valign="top" width="20%" id="d0e66">Data type</th>
|
||
|
|
<th align="left" valign="top" width="20%" id="d0e68">Argument</th>
|
||
|
|
<th align="left" valign="top" width="20%" id="d0e70">Use</th>
|
||
|
|
<th align="left" valign="top" width="40%" id="d0e72">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="20%" headers="d0e66 ">SQLHENV</td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e68 "><em>henv</em></td>
|
||
|
|
<td align="left" valign="top" width="20%" headers="d0e70 ">Input</td>
|
||
|
|
<td align="left" valign="top" width="40%" headers="d0e72 ">Environment handle.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">Usage</h4><p>If this function is called when there is still
|
||
|
|
a valid connection handle, SQL_ERROR is returned, and the environment handle
|
||
|
|
remains valid.</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. SQLReleaseEnv SQLSTATEs</caption><thead align="left"><tr><th align="left" valign="top" width="25%" id="d0e115">SQLSTATE</th>
|
||
|
|
<th align="left" valign="top" width="25%" id="d0e117">Description</th>
|
||
|
|
<th align="left" valign="top" width="50%" id="d0e119">Explanation</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td align="left" valign="top" width="25%" headers="d0e115 "><strong>58</strong>004</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e117 ">System error</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e119 ">Unrecoverable system error.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e115 "><strong>HY</strong>001</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e117 ">Memory allocation failure</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e119 ">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="d0e115 "><strong>HY</strong>010</td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e117 ">Function sequence error</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e119 ">There is an <em>hdbc</em> which is in allocated
|
||
|
|
or connected state. Call SQLDisconnect and SQLFreeConnect for the <em>hdbc</em> before
|
||
|
|
calling SQLReleaseEnv.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td align="left" valign="top" width="25%" headers="d0e115 "><strong>HY</strong>013 <strong>*</strong></td>
|
||
|
|
<td align="left" valign="top" width="25%" headers="d0e117 ">Memory management problem</td>
|
||
|
|
<td align="left" valign="top" width="50%" headers="d0e119 ">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="rzadpfnrelv__xmrelv"><a name="rzadpfnrelv__xmrelv"><!-- --></a><p>Refer to the example in the <a href="rzadpfnaenv.htm">SQLAllocEnv - Allocate environment handle</a>.</p>
|
||
|
|
</div>
|
||
|
|
<div class="section"><h4 class="sectiontitle">References</h4><ul><li><a href="rzadpfnfconn.htm#rzadpfnfconn">SQLFreeConnect - Free connection 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>
|