cvs: phpdoc /en/functions uodbc.xml

betz Mon Apr 1 16:09:19 2002 EDT Modified files: /phpdoc/en/functions uodbc.xml Log: added ini-settings from config.xml to Runtime Config Index: phpdoc/en/functions/uodbc.xml diff -u phpdoc/en/functions/uodbc.xml:1.38 phpdoc/en/functions/uodbc.xml:1.39 --- phpdoc/en/functions/uodbc.xml:1.38 Fri Mar 29 10:25:47 2002 +++ phpdoc/en/functions/uodbc.xml Mon Apr 1 16:09:19 2002 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.38 $ --> +<!-- $Revision: 1.39 $ --> <reference id="ref.odbc"> <title>Unified ODBC functions</title> <titleabbrev>ODBC</titleabbrev> @@ -52,9 +52,9 @@ <title>Runtime Configuration</title> <para> The behaviour of the ODBC functions is affected by settings in the - global <link linkend="configuration">configuration</link> file. + global <link linkend="configuration.file">configuration file</link> &php.ini;. <table> - <title><link linkend="ini.sect.uodbc">Unified ODBC Configuration</link> Options</title> + <title>Unified ODBC Configuration Options</title> <tgroup cols="3"> <thead> <row> @@ -119,6 +119,128 @@ </note> For further details and definition of the PHP_INI_* constants see <function>ini_set</function>. + </para> + <para> + Here is a short explanation of the configuration directives. + <variablelist> + + <varlistentry id="ini.uodbc.default-db"> + <term> + <parameter>odbc.default_db</parameter> + <type>string</type> + </term> + <listitem> + <para> + ODBC data source to use if none is specified in + <function>odbc_connect</function> or + <function>odbc_pconnect</function>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.default-user"> + <term> + <parameter>odbc.default_user</parameter> + <type>string</type> + </term> + <listitem> + <para> + User name to use if none is specified in + <function>odbc_connect</function> or + <function>odbc_pconnect</function>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.default-pw"> + <term> + <parameter>odbc.default_pw</parameter> + <type>string</type> + </term> + <listitem> + <para> + Password to use if none is specified in + <function>odbc_connect</function> or + <function>odbc_pconnect</function>. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.allow-persistent"> + <term> + <parameter>odbc.allow_persistent</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + Whether to allow persistent ODBC connections. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.check-persistent"> + <term> + <parameter>odbc.check_persistent</parameter> + <type>boolean</type> + </term> + <listitem> + <para> + Check that a connection is still valid before reuse. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.max-persistent"> + <term> + <parameter>odbc.max_persistent</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The maximum number of persistent ODBC connections per process. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.max-links"> + <term> + <parameter>odbc.max_links</parameter> + <type>integer</type> + </term> + <listitem> + <para> + The maximum number of ODBC connections per process, including + persistent connections. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.defaultlrl"> + <term> + <parameter>odbc.defaultlrl</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Handling of LONG fields. Specifies the number of bytes returned to + variables. + </para> + </listitem> + </varlistentry> + + <varlistentry id="ini.uodbc.defaultbinmode"> + <term> + <parameter>odbc.defaultbinmode</parameter> + <type>integer</type> + </term> + <listitem> + <para> + Handling of binary data. + </para> + </listitem> + </varlistentry> + + </variablelist> </para> </section>