ODBC_BINMODE(3) 1 ODBC_BINMODE(3)
odbc_binmode - Handling of binary column data
SYNOPSIS
bool odbc_binmode (resource $result_id, int $mode)
DESCRIPTION
Enables handling of binary column data. ODBC SQL types affected are BINARY, VARBINARY, and LONGVARBINARY.
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
"01" and a binary 11111111 is converted to "FF".
LONGVARBINARY handling
+----------------------+----------------+---+
| binmode | | |
| | | |
| | longreadlen | |
| | | |
| | result | |
| | | |
+----------------------+----------------+---+
| | | |
|ODBC_BINMODE_PASSTHRU | | |
| | | |
| | 0 | |
| | | |
| | passthru | |
| | | |
| | | |
| ODBC_BINMODE_RETURN | | |
| | | |
| | 0 | |
| | | |
| | passthru | |
| | | |
| | | |
|ODBC_BINMODE_CONVERT | | |
| | | |
| | 0 | |
| | | |
| | passthru | |
| | | |
| | | |
|ODBC_BINMODE_PASSTHRU | | |
| | | |
| | 0 | |
| | | |
| | passthru | |
| | | |
| | | |
|ODBC_BINMODE_PASSTHRU | | |
| | | |
| | >0 | |
| | | |
| | passthru | |
| | | |
| | | |
| ODBC_BINMODE_RETURN | | |
| | | |
| | >0 | |
| | | |
| | return as is | |
| | | |
| | | |
|ODBC_BINMODE_CONVERT | | |
| | | |
| | >0 | |
| | | |
| | return as char | |
| | | |
+----------------------+----------------+---+
If odbc_fetch_into(3) is used, passthru means that an empty string is returned for these columns.
PARAMETERS
o $result_id
- The result identifier. If $result_id is 0, the settings apply as default for new results.
Note
Default for longreadlen is 4096 and $mode defaults to ODBC_BINMODE_RETURN. Handling of binary long columns is also affected
by odbc_longreadlen(3).
o $mode
- Possible values for $mode are:
o ODBC_BINMODE_PASSTHRU: Passthru BINARY data
o ODBC_BINMODE_RETURN: Return as is
o ODBC_BINMODE_CONVERT: Convert to char and return
RETURN VALUES
Returns TRUE on success or FALSE on failure.
PHP Documentation Group ODBC_BINMODE(3)