php-doc-en/reference/mysqli/functions/mysqli-options.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

149 lines
4.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.13 $ -->
<refentry xml:id="function.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>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>mysqli_options</methodname>
<methodparam><type>mysqli</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>
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>
<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_COMMAND</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>
</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="examples">
&reftitle.examples;
<para>
See <function>mysqli_real_connect</function>.
</para>
</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:"../../../../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
-->