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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-binmode" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_binmode</refname>
<refpurpose>Handling of binary column data</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>true</type><methodname>odbc_binmode</methodname>
<methodparam><type>Odbc\Result</type><parameter>statement</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
Controls handling of binary column data. ODBC SQL types affected are
<literal>BINARY</literal>, <literal>VARBINARY</literal>, and
<literal>LONGVARBINARY</literal>.
The default mode can be set using the
<link linkend="ini.uodbc.defaultbinmode">uodbc.defaultbinmode</link> &php.ini; directive.
</para>
<para>
When binary SQL data is converted to character C data (<constant>ODBC_BINMODE_CONVERT</constant>), each byte
(8 bits) of source data is represented as two ASCII characters.
These characters are the ASCII character representation of the
number in its hexadecimal form. For example, a binary
<literal>00000001</literal> is converted to
<literal>"01"</literal> and a binary <literal>11111111</literal>
is converted to <literal>"FF"</literal>.
</para>
<para>
While the handling of <literal>BINARY</literal> and <literal>VARBINARY</literal>
columns only depend on the binmode, the handling of <literal>LONGVARBINARY</literal>
columns also depends on the longreadlen as well:
<table>
<title>LONGVARBINARY handling</title>
<tgroup cols="3">
<thead>
<row>
<entry>binmode</entry>
<entry>longreadlen</entry>
<entry>result</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>ODBC_BINMODE_PASSTHRU</constant></entry>
<entry>0</entry>
<entry>passthru</entry>
</row>
<row>
<entry><constant>ODBC_BINMODE_RETURN</constant></entry>
<entry>0</entry>
<entry>passthru</entry>
</row>
<row>
<entry><constant>ODBC_BINMODE_CONVERT</constant></entry>
<entry>0</entry>
<entry>passthru</entry>
</row>
<row>
<entry><constant>ODBC_BINMODE_PASSTHRU</constant></entry>
<entry>>0</entry>
<entry>passthru</entry>
</row>
<row>
<entry><constant>ODBC_BINMODE_RETURN</constant></entry>
<entry>>0</entry>
<entry>return as is</entry>
</row>
<row>
<entry><constant>ODBC_BINMODE_CONVERT</constant></entry>
<entry>>0</entry>
<entry>return as char</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
If <function>odbc_fetch_into</function> is used, passthru means that an
empty string is returned for these columns.
If <function>odbc_result</function> is used, passthru means that the data are
sent directly to the client (i.e. printed).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>statement</parameter></term>
<listitem>
<para>
&odbc.result.object;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Possible values for <parameter>mode</parameter> are:
<itemizedlist>
<listitem>
<simpara>
<constant>ODBC_BINMODE_PASSTHRU</constant>: Passthru BINARY data
</simpara>
</listitem>
<listitem>
<simpara>
<constant>ODBC_BINMODE_RETURN</constant>: Return as is
</simpara>
</listitem>
<listitem>
<simpara>
<constant>ODBC_BINMODE_CONVERT</constant>: Convert to char and return
</simpara>
</listitem>
</itemizedlist>
<note>
<simpara>
Handling of binary long
columns is also affected by <function>odbc_longreadlen</function>.
</simpara>
</note>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.result-param;
</tbody>
</tgroup>
</informaltable>
</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
-->
|
