ibase-connect.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-connect">
 <refnamediv>
  <refname>ibase_connect</refname>
  <refpurpose>データベースへの接続をオープンする</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ibase_connect</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>
   Firebird/InterBase サーバーへの接続を確立します。
  </para>
  <para>
   同じ引数で <function>ibase_connect</function> が再度コールされた場合、
   新規のリンクは作成されず、代わりに既にオープンされているリンクの
   リンク ID が返されます。
   <function>ibase_close</function> を明示的にコールしない限り、
   サーバーへのリンクはスクリプトの実行終了時に閉じられます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database</parameter></term>
     <listitem>
      <para>
       <parameter>database</parameter>は接続するサーバー上のデータベース
       ファイルへの正しいパスである必要があります。ローカルなサーバーへの
       接続でない場合、使用する接続プロトコルに応じてこの引数の前に
       'hostname:' (TCP/IP)、'hostname/port:' (カスタム TCP ポート上での interbase サーバーでの TCP/IP)、'//hostname/' (NetBEUI)
       のどれかをつける必要があります。
      </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 方言のデフォルト値を選択し、デフォルトではクライアント
       ライブラリでサポートされる方言のうち、最高位のものになります。
      </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>
   成功した場合に Firebird/InterBase リンク ID、エラー時に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   この関数を使用して <function>ibase_query</function> をコールした後に
   "arithmetic exception, numeric overflow,
   or string truncation. Cannot transliterate character between character
   sets" のようなエラーが発生した場合
   (たとえばアクセント記号つきの文字を使用した場合などに発生します)、
   文字セットを指定する必要があります
   (例: ISO8859_1 あるいは現在の文字セット)。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_connect</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$host = 'localhost:/path/to/your.gdb';

$dbh = ibase_connect($host, $username, $password);
$stmt = 'SELECT * FROM tblname';
$sth = ibase_query($dbh, $stmt);
while ($row = ibase_fetch_object($sth)) {
    echo $row->email, "\n";
}
ibase_free_result($sth);
ibase_close($dbh);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ibase_pconnect</function></member>
    <member><function>ibase_close</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
-->