mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
84a65f572a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@181709 c90b9560-bf6c-de11-be94-00142212c4b1
151 lines
4.9 KiB
XML
151 lines
4.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<refentry id="function.maxdb-options">
|
|
<refnamediv>
|
|
<refname>maxdb_options</refname>
|
|
<refname>maxdb->options</refname>
|
|
<refpurpose>Set options</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>maxdb_options</methodname>
|
|
<methodparam><type>resource</type><parameter>link</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>Object oriented style (method)</para>
|
|
<classsynopsis>
|
|
<ooclass><classname>maxdb</classname></ooclass>
|
|
<methodsynopsis>
|
|
<type>bool</type>
|
|
<methodname>options</methodname>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
</classsynopsis>
|
|
<para>
|
|
<function>maxdb_options</function> can be used to set extra connect options
|
|
and affect behavior for a connection.
|
|
</para>
|
|
<para>
|
|
This function may be called multiple times to set several options.
|
|
</para>
|
|
<para>
|
|
<function>maxdb_options</function> should be called after <function>maxdb_init</function>
|
|
and before <function>maxdb_real_connect</function>.
|
|
</para>
|
|
<para>
|
|
The parameter <parameter>option</parameter> is the option that you want to set,
|
|
the <parameter>value</parameter> is the value for the option. For detailed
|
|
description of the options see <ulink url="&url.maxdb.doc;">&url.maxdb.doc;</ulink>
|
|
The parameter <parameter>option</parameter> can be one of the following values:
|
|
<table>
|
|
<title>Valid options</title>
|
|
<tgroup cols='2'>
|
|
<thead>
|
|
<row>
|
|
<entry>Name</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>MAXDB_COMPNAME</constant></entry>
|
|
<entry>The component name used to initialise the SQLDBC runtime environment.</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_APPLICATION</constant></entry>
|
|
<entry>The application to be connected to the database.</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_APPVERSION</constant></entry>
|
|
<entry>The version of the application.</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_SQLMODE</constant></entry>
|
|
<entry>
|
|
The SQL mode.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_UNICODE</constant></entry>
|
|
<entry>
|
|
TRUE, if the connection is an unicode (UCS2) client or FALSE, if not.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_TIMEOUT</constant></entry>
|
|
<entry>
|
|
The maximum allowed time of inactivity after which the connection to the
|
|
database is closed by the system.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_ISOLATIONLEVEL</constant></entry>
|
|
<entry>
|
|
Specifies whether and how shared locks and exclusive locks are implicitly
|
|
requested or released.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_PACKETCOUNT</constant></entry>
|
|
<entry>
|
|
The number of different request packets used for the connection.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_STATEMENTCACHESIZE</constant></entry>
|
|
<entry>
|
|
The number of prepared statements to be cached for the connection for re-use.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MAXDB_CURSORPREFIX</constant></entry>
|
|
<entry>
|
|
The prefix to use for result tables that are automatically named.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.returnvalues;
|
|
<para>&return.success;</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.seealso;
|
|
<para>
|
|
<function>maxdb_init</function>,
|
|
<function>maxdb_real_connect</function>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para>See <function>maxdb_real_connect</function>.</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:"../../../../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
|
|
-->
|