File: fbsql-set-lob-mode.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (80 lines) | stat: -rw-r--r-- 2,809 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/fbsql.xml, last change in rev 1.28 -->
  <refentry id="function.fbsql-set-lob-mode">
   <refnamediv>
    <refname>fbsql_set_lob_mode</refname>
    <refpurpose>
     Set the LOB retrieve mode for a FrontBase result set
    </refpurpose>
   </refnamediv>
   <refsect1>
    &reftitle.description;
     <methodsynopsis>
      <type>bool</type><methodname>fbsql_set_lob_mode</methodname>
      <methodparam><type>resource</type><parameter>result</parameter></methodparam>
      <methodparam><type>string</type><parameter>database_name</parameter></methodparam>
     </methodsynopsis>
    <para> 
     Returns: &true; on success, &false; on error.
    </para>
    <para> 
     <function>fbsql_set_lob_mode</function> sets the mode for
     retrieving LOB data from the database. When BLOB and CLOB data is
     stored in FrontBase it can be stored direct or indirect.  Direct
     stored 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 stored directly.
     <itemizedlist>
      <listitem>
       <simpara>
        FBSQL_LOB_DIRECT - 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>
        FBSQL_LOB_HANDLE - 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 "@'000000000000000000000000'".
       </simpara>
      </listitem>
     </itemizedlist>     
    </para>
    <para> See also:
     <function>fbsql_create_blob</function>, 
     <function>fbsql_create_clob</function>, 
     <function>fbsql_read_blob</function>, and
     <function>fbsql_read_clob</function>.
    </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:"../../../../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
-->