From cf92e336abcd84593275c5d8317c415b4ba236a8 Mon Sep 17 00:00:00 2001
From: Christoph Michael Becker <cmb@php.net>
Date: Thu, 1 Oct 2020 11:30:01 +0000
Subject: [PATCH] Document PDO_ODBC driver specific options

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350737 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pdo_odbc/constants.xml | 77 ++++++++++++++++++++++++++++++++
 reference/pdo_odbc/reference.xml |  4 +-
 2 files changed, 80 insertions(+), 1 deletion(-)
 create mode 100644 reference/pdo_odbc/constants.xml

diff --git a/reference/pdo_odbc/constants.xml b/reference/pdo_odbc/constants.xml
new file mode 100644
index 0000000000..06e4b1b751
--- /dev/null
+++ b/reference/pdo_odbc/constants.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<section xml:id="pdo-odbc.constants" xmlns="http://docbook.org/ns/docbook">
+ &reftitle.constants;
+ &pdo.driver-constants;
+ <variablelist>
+  <varlistentry xml:id="pdo.constants.odbc-attr-use-cursor-library">
+   <term>
+    <constant>PDO::ODBC_ATTR_USE_CURSOR_LIBRARY</constant>
+     (<type>integer</type>)
+   </term>
+   <listitem>
+    <para>
+     This option controls whether the ODBC cursor library is used. The ODBC cursor library
+     supports some advanced ODBC features (e.g. block scrollable cursors), which may not
+     be implemented by the driver. The following values are supported:
+     <itemizedlist>
+      <listitem>
+       <para>
+        <constant>PDO::ODBC_SQL_USE_IF_NEEDED</constant> (the default):
+        use the ODBC cursor library when needed.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <constant>PDO::ODBC_SQL_USE_DRIVER</constant>:
+        never use the ODBC cursor library.
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        <constant>PDO::ODBC_SQL_USE_ODBC</constant>:
+        always use the ODBC cursor library.
+       </para>
+      </listitem>
+     </itemizedlist>
+    </para>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="pdo.constants.odbc-attr-assume-utf8">
+   <term>
+    <constant>PDO::ODBC_ATTR_ASSUME_UTF8</constant>
+     (<type>boolean</type>)
+   </term>
+   <listitem>
+    <para>
+     Windows only. If &true;, UTF-16 encoded character data (<literal>CHAR</literal>,
+     <literal>VARCHAR</literal> and <literal>LONGVARCHAR</literal>) is converted to
+     UTF-8 when reading from or writing data to the database.
+     If &false; (the default), no character encoding conversion is done.
+    </para>
+   </listitem>
+  </varlistentry>
+ </variablelist>
+</section>
+
+<!-- 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
+-->
diff --git a/reference/pdo_odbc/reference.xml b/reference/pdo_odbc/reference.xml
index 4a22059683..739165a242 100644
--- a/reference/pdo_odbc/reference.xml
+++ b/reference/pdo_odbc/reference.xml
@@ -56,7 +56,9 @@
 
    <!-- Information found in configure.xml -->
    &reference.pdo-odbc.configure;
-  <!-- Information found in ini.xml -->
+   <!-- Information found in constants.xml -->
+   &reference.pdo-odbc.constants;
+   <!-- Information found in ini.xml -->
    &reference.pdo-odbc.ini;
   </partintro>