<?xml version="1.0" encoding="utf-8"?>

<!-- EN-Revision: ed1aff13602c94f86344bdd7c4fbc31f5a71bf84 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-соединения или объекта ODBC с результатом запроса</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>bool</type><methodname>odbc_setoption</methodname>

<methodparam><type class="union"><type>Odbc\Connection</type><type>Odbc\Result</type></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, поскольку их требуется настроить до установки

соединения или подготовки запроса. Функцией лучше пользоваться,

только если она выполняет задачи, для решения которых приходится покупать коммерческий продукт.

</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-функция, которую требуется вызывать.

Для функции 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="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.4.0</entry>

<entry>

Параметр <parameter>odbc</parameter> теперь ожидает экземпляр класса <classname>Odbc\Connection</classname>

или <classname>Odbc\Result</classname>; раньше ожидалось значение

с типом <type>resource</type>.

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</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

-->