odbc-setoption.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 902c2b77f827e8d0ecccf4f62fb90065d2f6ef79 Maintainer: zors1 Status: ready -->
<!-- Reviewed: no -->

<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>
       Идентификатор соединения или идентификатор результата, для которого нужно
       изменить настройки. Для SQLSetConnectOption() это идентификатор
       соединения. Для SQLSetStmtOption() это идентификатор результата.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>which</parameter></term>
     <listitem>
      <para>
       Используемая функция ODBC. Значение должно быть равно
       1 для SQLSetConnectOption() и
       2 для SQLSetStmtOption().
      </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. Опция 102 SQLSetConnectOption() - SQL_AUTOCOMMIT.
//    Значение 1 SQL_AUTOCOMMIT - SQL_AUTOCOMMIT_ON.
//    Этот пример имеет тот же эффект, что и
//    odbc_autocommit($conn, true);

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

// 2. Опция 0 SQLSetStmtOption() - 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
-->