mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
106 lines
3.2 KiB
XML
106 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.fbsql-set-lob-mode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>fbsql_set_lob_mode</refname>
|
|
<refpurpose>Set the LOB retrieve mode for a FrontBase result set</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>fbsql_set_lob_mode</methodname>
|
|
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>lob_mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the mode for retrieving LOB data from the database.
|
|
</para>
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
&fbsql.result.description;
|
|
<varlistentry>
|
|
<term><parameter>lob_mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Can be one of:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>FBSQL_LOB_DIRECT</constant> - LOB data is retrieved
|
|
directly. When data is fetched from the database with
|
|
<function>fbsql_fetch_row</function>, 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.
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>FBSQL_LOB_HANDLE</constant> - LOB data is retrieved as
|
|
handles to the data. When data is fetched from the database with
|
|
<function>fbsql_fetch_row</function>, 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
|
|
<literal>@'000000000000000000000000'</literal>.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>fbsql_create_blob</function></member>
|
|
<member><function>fbsql_create_clob</function></member>
|
|
<member><function>fbsql_read_blob</function></member>
|
|
<member><function>fbsql_read_clob</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|