File: mysqli-options.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (118 lines) | stat: -rw-r--r-- 3,772 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<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>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>
    <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_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>
 </refsect1>
 <refsect1>
  &reftitle.returnvalues;
  <para>&return.success;</para>
 </refsect1>
 <refsect1>
  &reftitle.seealso;
  <para>
   <function>mysqli_init</function>&listendand;
   <function>mysqli_real_connect</function>.
  </para>
 </refsect1>
 <refsect1>
  &reftitle.examples;
  <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
-->