mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
e1d7da6039
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@270959 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3 KiB
XML
Executable file
124 lines
3 KiB
XML
Executable file
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision: 1.1 $ -->
|
|
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.db2-pclose">
|
|
<refnamediv>
|
|
<refname>db2_pclose</refname>
|
|
<refpurpose>Closes a persistent database connection</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>db2_pclose</methodname>
|
|
<methodparam><type>resource</type><parameter>resource</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function closes a DB2 client connection created with
|
|
<function>db2_pconnect</function> and returns the corresponding resources
|
|
to the database server.
|
|
<note>
|
|
<para>
|
|
This function is only available on i5/OS in response to i5/OS system
|
|
administration requests.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
<para>
|
|
If you have a persistent DB2 client connection created with
|
|
<function>db2_pconnect</function>, 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.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>connection</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies an active DB2 client connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="db2_pclose.example.basic"><!-- {{{ -->
|
|
<title>Closing a persistent connection</title>
|
|
<para>
|
|
The following example demonstrates a successful attempt to close a
|
|
connection to an IBM DB2 i5/OS database.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$conn = db2_pconnect('', '', '');
|
|
$rc = db2_pclose($conn);
|
|
if ($rc) {
|
|
echo "Connection was successfully closed.";
|
|
}
|
|
?>
|
|
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Connection was successfully closed.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>db2_close</function></member>
|
|
<member><function>db2_pconnect</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|
|
|