ibase-pconnect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: hirokawa Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-pconnect">
 <refnamediv>
  <refname>ibase_pconnect</refname>
  <refpurpose>InterBase データベースへの持続的接続をオープンする</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>
   InterBase データベースへの持続的な接続をオープンします。
  </para>
  <para>
   <function>ibase_pconnect</function> の動作は
   <function>ibase_connect</function> と非常に似ていますが、
   大きな違いが二つあります。
  </para>
  <para>
   まず、この関数は接続時に同じパラメータで既にオープンされている
   (持続的)リンクを探します。見つかった場合、新規接続をオープンする
   代わりにそのリンクの ID が返されます。
  </para>
  <para>
   2 番目の違いとしては、InterBase サーバーへの接続は
   スクリプト終了時にも閉じられないということです。
   代わりに、そのリンクは今後使用するためにオープンされたままとなります
   (<function>ibase_close</function> は <function>ibase_pconnect</function>
   によりオープンされたリンクを閉じません)。
   このため、この型のリンクは'持続的(persistent)'と呼ばれます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       <parameter>database</parameter>は接続するサーバー上のデータベース
       ファイルへの正しいパスである必要があります。ローカルなサーバーへの
       接続でない場合、使用する接続プロトコルに応じてこの引数の前に'
       hostname:' (TCP/IP)、'//hostname/' (NetBEUI)、'hostname@'
       (IPX/SPX)のどれかをつける必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       ユーザー名。&php.ini; ディレクティブ
       <literal>ibase.default_user</literal>
       で設定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       <parameter>username</parameter> のパスワード。
       &php.ini; ディレクティブ
       <literal>ibase.default_password</literal>
       で設定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       <parameter>charset</parameter>
       はデータベースに関するデフォルトの文字セットです。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>buffers</parameter></term>
     <listitem>
      <para>
       <parameter>buffers</parameter>
       はサーバー側のキャッシュに確保されるデータベースバッファの数です。0
       または省略された場合、サーバーはデフォルト値を用います。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dialect</parameter></term>
     <listitem>
      <para>
       <parameter>dialect</parameter> は、接続時に実行される全ての命令に
       関する SQL 方言のデフォルト値を選択し、デフォルトではクライアント
       ライブラリでサポートされる方言のうち、最高位のものになります。
       InterBase 6 以降でのみ有効です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>role</parameter></term>
     <listitem>
      <para>
       InterBase 5 以降でのみ有効です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sync</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に InterBase リンク ID、エラー時に &false; を返します。
  </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
-->