<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set the LOB retrieve mode for a FrontBase result set</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-set-characterset.html">fbsql_set_characterset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-set-password.html">fbsql_set_password</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fbsql-set-lob-mode" class="refentry">
<div class="refnamediv">
<h1 class="refname">fbsql_set_lob_mode</h1>
<p class="verinfo">(PHP 4 >= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">fbsql_set_lob_mode</span> — <span class="dc-title">Set the LOB retrieve mode for a FrontBase result set</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fbsql-set-lob-mode-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>fbsql_set_lob_mode</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$lob_mode</code></span>
)</div>
<p class="para rdfs-comment">
Sets the mode for retrieving LOB data from the database.
</p>
<p class="para">
When BLOB and CLOB data is retrieved in FrontBase it can be retrieved
direct or indirect. Direct retrieved LOB data will always be fetched no
matter the setting of the lob mode. If the LOB data is less than 512 bytes
it will always be retrieved directly.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fbsql-set-lob-mode-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
result</code></em></span><dd>
<p class="para">A result identifier
returned by <span class="function"><a href="function.fbsql-query.html" class="function">fbsql_query()</a></span> or
<span class="function"><a href="function.fbsql-db-query.html" class="function">fbsql_db_query()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">lob_mode</code></em></span>
<dd>
<p class="para">
Can be one of:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_LOB_DIRECT</code></strong> - LOB data is retrieved
directly. When data is fetched from the database with
<span class="function"><a href="function.fbsql-fetch-row.html" class="function">fbsql_fetch_row()</a></span>, and other fetch functions,
all CLOB and BLOB columns will be returned as ordinary columns.
This is the default value on a new FrontBase result.
</span>
</li>
<li class="listitem">
<span class="simpara">
<strong><code>FBSQL_LOB_HANDLE</code></strong> - LOB data is retrieved as
handles to the data. When data is fetched from the database with
<span class="function"><a href="function.fbsql-fetch-row.html" class="function">fbsql_fetch_row()</a></span>, and other fetch functions,
LOB data will be returned as a handle to the data if the data is
stored indirect or the data if it is stored direct. If a handle
is returned it will be a 27 byte string formatted as
<em>@'000000000000000000000000'</em>.
</span>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fbsql-set-lob-mode-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fbsql-set-lob-mode-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fbsql-create-blob.html" class="function" rel="rdfs-seeAlso">fbsql_create_blob()</a> - Create a BLOB</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-create-clob.html" class="function" rel="rdfs-seeAlso">fbsql_create_clob()</a> - Create a CLOB</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-read-blob.html" class="function" rel="rdfs-seeAlso">fbsql_read_blob()</a> - Read a BLOB from the database</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-read-clob.html" class="function" rel="rdfs-seeAlso">fbsql_read_clob()</a> - Read a CLOB from the database</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-set-characterset.html">fbsql_set_characterset</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-set-password.html">fbsql_set_password</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
