Source of: /manual/en/function.odbc-binmode.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.uodbc.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.odbc-binmode.php',
1 => 'odbc_binmode',
),
'up' =>
array (
0 => 'ref.uodbc.php',
1 => 'ODBC Functions',
),
'prev' =>
array (
0 => 'function.odbc-autocommit.php',
1 => 'odbc_autocommit',
),
'next' =>
array (
0 => 'function.odbc-close-all.php',
1 => 'odbc_close_all',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.odbc-binmode" class="refentry">
<div class="refnamediv">
<h1 class="refname">odbc_binmode</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">odbc_binmode</span> — <span class="dc-title">Handling of binary column data</span></p>
</div>
<a name="function.odbc-binmode.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>odbc_binmode</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$result_id</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$mode</tt></span>
)</div>
<p class="para rdfs-comment">
Enables handling of binary column data. ODBC SQL types affected are
<i>BINARY</i>, <i>VARBINARY</i>, and
<i>LONGVARBINARY</i>.
</p>
<p class="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
<i>00000001</i> is converted to
<i>"01"</i> and a binary <i>11111111</i>
is converted to <i>"FF"</i>.
</p><table class="doctable table">
<caption><b>LONGVARBINARY handling</b></caption>
<thead valign="middle">
<tr valign="middle">
<th>binmode</th>
<th>longreadlen</th>
<th>result</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_PASSTHRU</tt></b></td>
<td align="left">0</td>
<td align="left">passthru</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_RETURN</tt></b></td>
<td align="left">0</td>
<td align="left">passthru</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_CONVERT</tt></b></td>
<td align="left">0</td>
<td align="left">passthru</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_PASSTHRU</tt></b></td>
<td align="left">0</td>
<td align="left">passthru</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_PASSTHRU</tt></b></td>
<td align="left">>0</td>
<td align="left">passthru</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_RETURN</tt></b></td>
<td align="left">>0</td>
<td align="left">return as is</td>
</tr>
<tr valign="middle">
<td align="left"><b><tt class="constant">ODBC_BINMODE_CONVERT</tt></b></td>
<td align="left">>0</td>
<td align="left">return as char</td>
</tr>
</tbody>
</table>
<p>
</p>
<p class="para">
If <a href="function.odbc-fetch-into.php" class="function">odbc_fetch_into()</a> is used, passthru means that an
empty string is returned for these columns.
</p>
</div>
<a name="function.odbc-binmode.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">result_id</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The result identifier.
</p>
<p class="para">
If <i><tt class="parameter">result_id</tt></i>
is <i>0</i>, the
settings apply as default for new results.
</p><blockquote><p><b class="note">Note</b>:
<span class="simpara">
Default for <i>longreadlen</i> is <i>4096</i> and
<i><tt class="parameter">mode</tt></i>
defaults to
<i>ODBC_BINMODE_RETURN</i>. Handling of binary long
columns is also affected by <a href="function.odbc-longreadlen.php" class="function">odbc_longreadlen()</a>.
</span>
</p></blockquote><p>
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">mode</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Possible values for <i><tt class="parameter">mode</tt></i>
are:
</p><ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<b><tt class="constant">ODBC_BINMODE_PASSTHRU</tt></b>: Passthru BINARY data
</span>
</li>
<li class="listitem">
<span class="simpara">
<b><tt class="constant">ODBC_BINMODE_RETURN</tt></b>: Return as is
</span>
</li>
<li class="listitem">
<span class="simpara">
<b><tt class="constant">ODBC_BINMODE_CONVERT</tt></b>: Convert to char and return
</span>
</li>
</ul><p>
</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.odbc-binmode.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
</div><?php manual_footer(); ?>
