odbc-binmode.xml

<?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>resource</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>&gt;0</entry>
       <entry>passthru</entry>
      </row>
      <row>
       <entry><constant>ODBC_BINMODE_RETURN</constant></entry>
       <entry>&gt;0</entry>
       <entry>return as is</entry>
      </row>
      <row>
       <entry><constant>ODBC_BINMODE_CONVERT</constant></entry>
       <entry>&gt;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>
       The result identifier.
      </para>
      <para>
       If <parameter>statement</parameter> is <literal>0</literal>, the
       settings apply as default for new results.
      </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>
</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
-->