mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-29 23:38:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
140 lines
4 KiB
XML
140 lines
4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.odbc-setoption" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>odbc_setoption</refname>
|
|
<refpurpose>Adjust ODBC settings</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>odbc_setoption</methodname>
|
|
<methodparam><type>resource</type><parameter>id</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>function</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>param</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function allows fiddling with the ODBC options for a
|
|
particular connection or query result. It was written to help
|
|
find work around to problems in quirky ODBC drivers. You should
|
|
probably only use this function if you are an ODBC programmer and
|
|
understand the effects the various options will have. You will
|
|
certainly need a good ODBC reference to explain all the different
|
|
options and values that can be used. Different driver versions
|
|
support different options.
|
|
</para>
|
|
<para>
|
|
Because the effects may vary depending on the ODBC driver, use of
|
|
this function in scripts to be made publicly available is
|
|
strongly discouraged. Also, some ODBC options are not available
|
|
to this function because they must be set before the connection
|
|
is established or the query is prepared. However, if on a
|
|
particular job it can make PHP work so your boss doesn't tell you
|
|
to use a commercial product, that's all that really
|
|
matters.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>id</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Is a connection id or result id on which to change the settings.
|
|
For SQLSetConnectOption(), this is a connection id.
|
|
For SQLSetStmtOption(), this is a result id.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Is the ODBC function to use. The value should be
|
|
1 for SQLSetConnectOption() and
|
|
2 for SQLSetStmtOption().
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>option</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The option to set.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>param</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value for the given <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> examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// 1. Option 102 of SQLSetConnectOption() is SQL_AUTOCOMMIT.
|
|
// Value 1 of SQL_AUTOCOMMIT is SQL_AUTOCOMMIT_ON.
|
|
// This example has the same effect as
|
|
// odbc_autocommit($conn, true);
|
|
|
|
odbc_setoption($conn, 1, 102, 1);
|
|
|
|
// 2. Option 0 of SQLSetStmtOption() is SQL_QUERY_TIMEOUT.
|
|
// This example sets the query to timeout after 30 seconds.
|
|
|
|
$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
|
|
-->
|