File: odbc-binmode.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 (131 lines) | stat: -rw-r--r-- 3,819 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/uodbc.xml, last change in rev 1.2 -->
  <refentry id="function.odbc-binmode">
   <refnamediv>
    <refname>odbc_binmode</refname>
   <refpurpose>Handling of binary column data</refpurpose>
  </refnamediv>
  <refsect1>
   <title>Description</title>
     <methodsynopsis>
     <type>bool</type><methodname>odbc_binmode</methodname>
     <methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY)
    </para>
    <itemizedlist>
      <listitem>
      <simpara>
       ODBC_BINMODE_PASSTHRU: Passthru BINARY data
      </simpara>
     </listitem> 
     <listitem>
      <simpara>
       ODBC_BINMODE_RETURN: Return as is
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       ODBC_BINMODE_CONVERT: Convert to char and return
      </simpara>
     </listitem>
    </itemizedlist>
    <para>
     When binary SQL data is converted to character C data, 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 00000001 is
     converted to <literal>"01"</literal> and a binary 11111111 is
     converted to <literal>"FF"</literal>.
     <table>
      <title>LONGVARBINARY handling</title>
      <tgroup cols="3">
       <thead>
        <row>
         <entry>binmode</entry>
         <entry>longreadlen</entry>
         <entry>result</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry>ODBC_BINMODE_PASSTHRU</entry>
         <entry>0</entry>
         <entry>passthru</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_RETURN</entry>
         <entry>0</entry>
         <entry>passthru</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_CONVERT</entry>
         <entry>0</entry>
         <entry>passthru</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_PASSTHRU</entry>
         <entry>0</entry>
         <entry>passthru</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_PASSTHRU</entry>
         <entry>>0</entry>
         <entry>passthru</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_RETURN</entry>
         <entry>>0</entry>
         <entry>return as is</entry>
        </row>
        <row>
         <entry>ODBC_BINMODE_CONVERT</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.
    </para>
    <para>
     If <parameter>result_id</parameter> is <literal>0</literal>, the
     settings apply as default for new results.
     <note>
      <simpara> 
       Default for longreadlen is <literal>4096</literal> and binmode
       defaults to <literal>ODBC_BINMODE_RETURN</literal>.  Handling
       of binary long columns is also affected by
       <function>odbc_longreadlen</function>
      </simpara>
     </note>
    </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
-->