/
flush.xml
84 lines (77 loc) · 2.21 KB
/
flush.xml
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
81
82
83
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="oci-lob.flush" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>OCI-Lob::flush</refname>
<refpurpose>Flushes/writes buffer of the LOB to the server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<type>bool</type><methodname>OCI-Lob::flush</methodname>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>
<function>OCI-Lob::flush</function> actually writes data to the server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flag</parameter></term>
<listitem>
<para>
By default, resources are not freed, but using flag
<constant>OCI_LOB_BUFFER_FREE</constant> you can do it explicitly.
Be sure you know what you're doing - next read/write operation to the
same part of LOB will involve a round-trip to the server and initialize
new buffer resources. It is recommended to use
<constant>OCI_LOB_BUFFER_FREE</constant> flag only when you are not
going to work with the LOB anymore.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<para>
Returns &false; if buffering was not enabled or an error occurred.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="oci-lob.getbuffering" /></member>
<member><xref linkend="oci-lob.setbuffering" /></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
-->