<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Closes a persistent database connection</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-num-rows.html">db2_num_rows</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-pconnect.html">db2_pconnect</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.db2-pclose" class="refentry">
<div class="refnamediv">
<h1 class="refname">db2_pclose</h1>
<p class="verinfo">(PECL ibm_db2 >= 1.8.0)</p><p class="refpurpose"><span class="refname">db2_pclose</span> — <span class="dc-title">Closes a persistent database connection</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.db2-pclose-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>db2_pclose</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$resource</code></span>
)</div>
<p class="para rdfs-comment">
This function closes a DB2 client connection created with
<span class="function"><a href="function.db2-pconnect.html" class="function">db2_pconnect()</a></span> and returns the corresponding resources
to the database server.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function is only available on i5/OS in response to i5/OS system
administration requests.
</p>
</p></blockquote>
</p>
<p class="para">
If you have a persistent DB2 client connection created with
<span class="function"><a href="function.db2-pconnect.html" class="function">db2_pconnect()</a></span>, you may use this function to close the
connection. To avoid substantial connection performance penalties, this
function should only be used in rare cases when the persistent connection
has become unresponsive or the persistent connection will not be needed for
a long period of time.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.db2-pclose-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">connection</code></dt>
<dd>
<p class="para">
Specifies an active DB2 client connection.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.db2-pclose-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.db2-pclose-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1300">
<p><strong>Example #1 Closing a persistent connection</strong></p>
<div class="example-contents"><p>
The following example demonstrates a successful attempt to close a
connection to an IBM DB2 i5/OS database.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_pconnect</span><span style="color: #007700">(</span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rc </span><span style="color: #007700">= </span><span style="color: #0000BB">db2_pclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$rc</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Connection was successfully closed."</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Connection was successfully closed.
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.db2-pclose-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.db2-close.html" class="function" rel="rdfs-seeAlso">db2_close()</a> - Closes a database connection</span></li>
<li class="member"><span class="function"><a href="function.db2-pconnect.html" class="function" rel="rdfs-seeAlso">db2_pconnect()</a> - Returns a persistent connection to a database</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.db2-num-rows.html">db2_num_rows</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.db2-pconnect.html">db2_pconnect</a></div>
<div class="up"><a href="ref.ibm-db2.html">IBM DB2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
