php-doc-en/reference/uodbc/functions/odbc-pconnect.xml
Christoph Michael Becker 902c2b77f8 Generate odbc methodsynopses based on stubs
Closes GH-286.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352189 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-26 14:11:36 +00:00

88 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-pconnect" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_pconnect</refname>
<refpurpose>Open a persistent database connection</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_pconnect</methodname>
<methodparam><type>string</type><parameter>dsn</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>cursor_option</parameter><initializer><constant>SQL_CUR_USE_DRIVER</constant></initializer></methodparam>
</methodsynopsis>
<para>
Opens a persistent database connection.
</para>
<para>
This function is much like
<function>odbc_connect</function>, except that the connection is
not really closed when the script has finished. Future requests
for a connection with the same <parameter>dsn</parameter>,
<parameter>user</parameter>, <parameter>password</parameter>
combination (via <function>odbc_connect</function> and
<function>odbc_pconnect</function>) can reuse the persistent
connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See <function>odbc_connect</function> for details.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ODBC connection, &return.falseforfailure;.
error.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Persistent connections have no effect if PHP is used as a CGI
program.
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_connect</function></member>
<member><link linkend="features.persistent-connections">Persistent Database Connections</link></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:"~/.phpdoc/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
-->