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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.maxdb-options">
<refnamediv>
<refname>maxdb_options</refname>
<refname>maxdb->options</refname>
<refpurpose>Set options</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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 <link xlink:href="&url.maxdb.doc;">&url.maxdb.doc;</link>
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 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
See <function>maxdb_real_connect</function>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>maxdb_init</function></member>
<member><function>maxdb_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
-->
|
