mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
164 lines
5.2 KiB
XML
164 lines
5.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-pconnect">
|
|
<refnamediv>
|
|
<refname>ibase_pconnect</refname>
|
|
<refpurpose>Open a persistent connection to an InterBase database</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>ibase_pconnect</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>buffers</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>dialect</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>role</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>sync</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Opens a persistent connection to an InterBase database.
|
|
</para>
|
|
<para>
|
|
<function>ibase_pconnect</function> acts very much like
|
|
<function>ibase_connect</function> with two major differences.
|
|
</para>
|
|
<para>
|
|
First, when connecting, the function will first try to find a (persistent)
|
|
link that's already opened with the same parameters. If one is found, an
|
|
identifier for it will be returned instead of opening a new connection.
|
|
</para>
|
|
<para>
|
|
Second, the connection to the InterBase server will not be closed when the
|
|
execution of the script ends. Instead, the link will remain open for
|
|
future use (<function>ibase_close</function> will not close links
|
|
established by <function>ibase_pconnect</function>). This type of link is
|
|
therefore called 'persistent'.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>database</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>database</parameter> argument has to be a valid path to
|
|
database file on the server it resides on. If the server is not local,
|
|
it must be prefixed with either 'hostname:' (TCP/IP), '//hostname/'
|
|
(NetBEUI) or 'hostname@' (IPX/SPX), depending on the connection
|
|
protocol used.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>username</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The user name. Can be set with the
|
|
<literal>ibase.default_user</literal> &php.ini; directive.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The password for <parameter>username</parameter>. Can be set with the
|
|
<literal>ibase.default_password</literal> &php.ini; directive.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>charset</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>charset</parameter> is the default character set for a
|
|
database.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>buffers</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>buffers</parameter> is the number of database buffers to
|
|
allocate for the server-side cache. If 0 or omitted, server chooses
|
|
its own default.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>dialect</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>dialect</parameter> selects the default SQL dialect for any
|
|
statement executed within a connection, and it defaults to the highest
|
|
one supported by client libraries. Functional only with InterBase 6
|
|
and up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>role</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Functional only with InterBase 5 and up.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>sync</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an InterBase link identifier on success, or &false; on error.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ibase_close</function></member>
|
|
<member><function>ibase_connect</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:"~/.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
|
|
-->
|