mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
4ca571b8c9
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@164340 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.9 KiB
XML
119 lines
3.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.5 $ -->
|
|
<refentry id="function.mysqli-options">
|
|
<refnamediv>
|
|
<refname>mysqli_options</refname>
|
|
<refname>mysqli->options</refname>
|
|
<refpurpose>set options</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>Procedural style:</para>
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>mysqli_options</methodname>
|
|
<methodparam><type>object</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>mysqli</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>mysqli_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>mysqli_options</function> should be called after <function>mysqli_init</function>
|
|
and before <function>mysqli_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.
|
|
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>MYSQLI_OPT_CONNECT_TIMEOUT</constant></entry>
|
|
<entry>connection timeout in seconds</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MYSQLI_OPT_LOCAL_INFILE</constant></entry>
|
|
<entry>enable/disable use of <literal>LOAD LOCAL INFILE</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MYSQLI_INIT_CMD</constant></entry>
|
|
<entry>command to execute after when connecting to MySQL server</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MYSQLI_READ_DEFAULT_FILE</constant></entry>
|
|
<entry>
|
|
Read options from named option file instead of <filename>my.cnf</filename>
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>MYSQLI_READ_DEFAULT_GROUP</constant></entry>
|
|
<entry>
|
|
Read options from the named group from <filename>my.cnf</filename>
|
|
or the file specified with <constant>MYSQL_READ_DEFAULT_FILE</constant>.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.returnvalues;
|
|
<para>&return.success;</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
&reftitle.seealso;
|
|
<para>
|
|
<function>mysqli_init</function>,
|
|
<function>mysqli_real_connect</function>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Example</title>
|
|
<para>See <function>mysqli_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
|
|
-->
|