odbc-setoption.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.odbc-setoption" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>odbc_setoption</refname>
  <refpurpose>ODBC の設定を変更する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>odbc_setoption</methodname>
   <methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
   <methodparam><type>int</type><parameter>which</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type>int</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数により特定の接続またはクエリー結果に関する ODBC
   オプションを変更することが可能となります。この関数は、気まぐれな ODBC
   ドライバの問題に対処する際の道具として作成されたものです。自分が ODBC
   プログラマであり、様々なオプションが有する効果を理解している場合にのみこの関数を使用するべきでしょう。
   使用可能な全てのオプションおよび値を理解するためには、良い ODBC
   リファレンスが必要です。ドライバーのバージョンが違うと、
   サポートされるオプションも異なります。
  </para>
  <para>
   この関数の効果は ODBC ドライバに依存する可能性があるので、
   一般に公開するスクリプトでは、この関数の使用は避けましょう。
   また、いくつかの ODBC オプションはこの関数では利用できません。
   それは、これらを接続の確立またはクエリの準備の前に設定する必要があるからです。
   しかし、特定の業務において自分の上司が商用製品の使用を指示しなかったために
   PHP を使用する場合、このことは実際的な問題となります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>odbc</parameter></term>
     <listitem>
      <para>
       設定を変更する接続 ID または
       結果 ID。SQLSetConnectOption() の場合、これは接続 ID です。
       SQLSetStmtOption() の場合、これは結果 ID です。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>which</parameter></term>
     <listitem>
      <para>
       使用する ODBC 関数。
       値は SQLSetConnectOption() の場合 1、
       SQLSetStmtOption() の場合 2 である必要があります。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       設定するオプション。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       指定した <parameter>option</parameter> の値。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>odbc_setoption</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// 1. SQLSetConnectOption() のオプション 102 は SQL_AUTOCOMMIT です。
//    SQL_AUTOCOMMIT の値 1 は SQL_AUTOCOMMIT_ON です。
//    この例は odbc_autocommit($conn, true); と同じ結果
//    となります。

odbc_setoption($conn, 1, 102, 1);

// 2. SQLSetStmtOption() のオプション 0 は SQL_QUERY_TIMEOUT です。
//    この例は 30 秒後に時間切れとなるクエリーを設定します。

$result = odbc_prepare($conn, $sql);
odbc_setoption($result, 2, 0, 30);
odbc_execute($result);
?>
]]>
    </programlisting>
   </example>
  </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
-->