<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysqli.options" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mysqli::options</refname>
  <refname>mysqli_options</refname>
  <refpurpose>Set options</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="mysqli">
   <modifier>public</modifier> <type>bool</type><methodname>mysqli::options</methodname>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>int</type></type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type>bool</type><methodname>mysqli_options</methodname>
   <methodparam><type>mysqli</type><parameter>mysql</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>int</type></type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &mysqli.link.description;
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       The option that you want to set. It can be one of the following values:
       <table xml:id="mysqli.options.parameters">
        <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_READ_TIMEOUT</constant></entry>
           <entry>Command execution result timeout in seconds. Available as of PHP 7.2.0.</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_COMMAND</constant></entry>
           <entry>Command to execute after when connecting to MySQL server</entry>
          </row>
          <row>
           <entry><constant>MYSQLI_SET_CHARSET_NAME</constant></entry>
           <entry>The charset to be set as default.</entry>
          </row>
          <row>
           <entry><constant>MYSQLI_READ_DEFAULT_FILE</constant></entry>
           <entry>
            Read options from named option file instead of <filename>my.cnf</filename>
            Not supported by mysqlnd.
           </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>.
            Not supported by mysqlnd.
           </entry>
          </row>
          <row>
           <entry><constant>MYSQLI_SERVER_PUBLIC_KEY</constant></entry>
           <entry>
             RSA public key file used with the SHA-256 based authentication.
           </entry>
          </row>
          <row>
           <entry><constant>MYSQLI_OPT_NET_CMD_BUFFER_SIZE</constant></entry>
           <entry>
             The size of the internal command/network buffer. Only valid for
             mysqlnd.
           </entry>
          </row>
          <row>
           <entry><constant>MYSQLI_OPT_NET_READ_BUFFER_SIZE</constant></entry>
           <entry>
             Maximum read chunk size in bytes when reading the body of a MySQL
             command packet. Only valid for mysqlnd.
           </entry>
          </row>
          <row>
           <entry><constant>MYSQLI_OPT_INT_AND_FLOAT_NATIVE</constant></entry>
           <entry>
             Convert integer and float columns back to PHP numbers. Only valid
             for mysqlnd.
           </entry>
          </row>
          <row>
           <entry><constant>MYSQLI_OPT_SSL_VERIFY_SERVER_CERT</constant></entry>
           <entry>
            Whether to verify server certificate or not.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The value for the option.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &mysqli.conditionalexception;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   See <function>mysqli_real_connect</function>.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &mysqli.charset.note;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mysqli_init</function></member>
    <member><function>mysqli_real_connect</function></member>
   </simplelist>
  </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
-->
