rename almost all oci-lob files to OCI-Lob

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@195284 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Wez Furlong 2005-09-06 19:59:37 +00:00
parent 752a28be22
commit 058699a7d4
17 changed files with 0 additions and 880 deletions

View file

@ -1,54 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<refentry id="function.oci-lob-append">
<refnamediv>
<refname>lob->append</refname>
<refpurpose>Appends data from the large object to another large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->append</methodname>
<methodparam><type>OCI-Lob</type><parameter>lob_from</parameter></methodparam>
</methodsynopsis>
<para>
Appends data from the large object to the end of another large object.
</para>
<para>
Writing to the large object with <function>lob->append</function> will
fail if buffering was previously enabled. You must disable buffering
before appending. You may need to flush buffers with
<function>oci_lob_flush</function> before disabling buffering.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_flush</function>,
<function>ocisetbufferinglob</function> and
<function>ocigetbufferinglob</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
-->

View file

@ -1,55 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-close">
<refnamediv>
<refname>lob->close</refname>
<refpurpose>Closes LOB descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->close</methodname>
<void />
</methodsynopsis>
<para>
<function>lob->close</function> closes descriptor of LOB or FILE. This
function should be used only with
<function>lob->writeTemporary</function>.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocicloselob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_close</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_write_temporary</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
-->

View file

@ -1,42 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-eof">
<refnamediv>
<refname>lob->eof</refname>
<refpurpose>Tests for end-of-file on a large object's descriptor</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->eof</methodname>
<void />
</methodsynopsis>
<para>
Returns &true; if internal pointer of large object is at the end of LOB.
Otherwise returns &false;.
</para>
<para>
See also <function>oci_lob_size</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
-->

View file

@ -1,52 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-erase">
<refnamediv>
<refname>lob->erase</refname>
<refpurpose>Erases a specified portion of the internal LOB data</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->erase</methodname>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Erases a specified portion of the internal LOB data starting at a
specified <parameter>offset</parameter>. Parameters
<parameter>length</parameter> and <parameter>offset</parameter> are optional.
<function>lob->erase</function> erases all LOB data by default.
</para>
<para>
For BLOBs, erasing means that the existing LOB value is overwritten with
zero-bytes. For CLOBs, the existing LOB value is overwritten with spaces.
</para>
<para>
<function>lob->erase</function> returns the actual number of
characters/bytes erased or &false; in case of error.
</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
-->

View file

@ -1,48 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-export">
<refnamediv>
<refname>lob->export</refname>
<refpurpose>Exports LOB's contents to a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->export</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>start</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Exports LOB's contents to a file, which name is given in parameter
<parameter>filename</parameter>. Optional parameter
<parameter>start</parameter> indicates from what position to start export
and parameter <parameter>length</parameter> - length of data to be
exported.
</para>
<para>
&return.success;
</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
-->

View file

@ -1,54 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-flush">
<refnamediv>
<refname>lob->flush</refname>
<refpurpose>Flushes/writes buffer of the LOB to the server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->flush</methodname>
<methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>
<function>lob->flush</function> actually writes data to the server.
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>
<para>
<function>lob->flush</function> returns &false; if buffering was not
enabled or an error occurred.
</para>
<para>
&return.success;
</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
-->

View file

@ -1,51 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-import">
<refnamediv>
<refname>lob->import</refname>
<refpurpose>Imports file data to the LOB</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->import</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Writes data from <parameter>filename</parameter> in to the current
position of large object.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocisavelobfile</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_import</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
</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
-->

View file

@ -1,51 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-load">
<refnamediv>
<refname>lob->load</refname>
<refpurpose>Returns large object's contents</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lob->load</methodname>
<void />
</methodsynopsis>
<para>
Returns large object's contents. As script execution is terminated
when the <link linkend="ini.memory-limit">memory_limit</link> is reached,
ensure that the LOB does not exceed this limit. In most cases it's
recommended to use <function>oci_lob_read</function> instead. In case of
error <function>lob->load</function> returns &false;.
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociloadlob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_load</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
</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
-->

View file

@ -1,52 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-read">
<refnamediv>
<refname>lob->read</refname>
<refpurpose>Reads part of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>lob->read</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Reads <parameter>length</parameter> bytes from the current position of
LOB's internal pointer. Reading stops when <parameter>length</parameter>
bytes have been read or end of large object is reached.
Internal pointer of large object will be shifted on the amount of bytes
read.
</para>
<para>
Returns &false; in case of error.
</para>
<para>
See also <function>oci_lob_eof</function>,
<function>oci_lob_seek</function>,
<function>oci_lob_tell</function> and
<function>oci_lob_write</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
-->

View file

@ -1,45 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-rewind">
<refnamediv>
<refname>lob->rewind</refname>
<refpurpose>Moves the internal pointer to the beginning of the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->rewind</methodname>
<void />
</methodsynopsis>
<para>
Sets the internal pointer to the beginning of the large object.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_seek</function> and
<function>oci_lob_tell</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
-->

View file

@ -1,57 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-save">
<refnamediv>
<refname>lob->save</refname>
<refpurpose>Saves data to the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->save</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
</methodsynopsis>
<para>
Saves <parameter>data</parameter> to the large object.
Parameter <parameter>offset</parameter> can be used to indicate offset
from the beginning of the large object.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ocisavelob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_save</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_write</function> and
<function>oci_lob_import</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
-->

View file

@ -1,63 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-seek">
<refnamediv>
<refname>lob->seek</refname>
<refpurpose>Sets the internal pointer of the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->seek</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>whence</parameter></methodparam>
</methodsynopsis>
<para>
Sets the internal pointer of the large object. Parameter
<parameter>offset</parameter> indicates the amount of
bytes, on which internal pointer should be moved from the position,
pointed by <parameter>whence</parameter>:
<simplelist>
<member>
<constant>OCI_SEEK_SET</constant> - sets the position equal to
<parameter>offset</parameter>
</member>
<member>
<constant>OCI_SEEK_CUR</constant> - adds <parameter>offset</parameter>
bytes to the current position
</member>
<member>
<constant>OCI_SEEK_END</constant> - adds <parameter>offset</parameter>
bytes to the end of large object (use negative value to move to a position
before the end of large object)
</member>
</simplelist>
</para>
<para>
See also <function>oci_lob_rewind</function> and
<function>oci_lob_tell</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
-->

View file

@ -1,41 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-size">
<refnamediv>
<refname>lob->size</refname>
<refpurpose>Returns size of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->size</methodname>
<void />
</methodsynopsis>
<para>
Returns length of large object value or &false; in case of error.
Empty objects have zero length.
</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
-->

View file

@ -1,43 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-tell">
<refnamediv>
<refname>lob->tell</refname>
<refpurpose>Returns current position of internal pointer of large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->tell</methodname>
<void />
</methodsynopsis>
<para>
Returns current position of a LOB's internal pointer or &false; if an
error occurred.
</para>
<para>
See also <function>oci_lob_size</function> and
<function>oci_lob_eof</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
-->

View file

@ -1,49 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.oci-lob-truncate">
<refnamediv>
<refname>lob->truncate</refname>
<refpurpose>Truncates large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->truncate</methodname>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
If parameter <parameter>length</parameter> is given,
<function>lob->truncate</function> truncates large object to
<parameter>length</parameter> bytes. Otherwise,
<function>lob->truncate</function> will purge the LOB completely.
</para>
<para>
&return.success;
</para>
<para>
See also <function>oci_lob_erase</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
-->

View file

@ -1,73 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.oci-lob-write-temporary">
<refnamediv>
<refname>lob->writeTemporary</refname>
<refpurpose>Writes temporary large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>lob->writeTemporary</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>lob_type</parameter></methodparam>
</methodsynopsis>
<para>
Creates a temporary large object and writes <parameter>data</parameter>
to it.
</para>
<para>
Parameter <parameter>lob_type</parameter> can be one of the following:
<simplelist>
<member>
<constant>OCI_TEMP_BLOB</constant> is used to create temporary BLOBs
</member>
<member>
<constant>OCI_TEMP_CLOB</constant> is used to create temporary CLOBs
</member>
</simplelist>
</para>
<para>
<function>lob->writeTemporary</function> creates a CLOB by default.
</para>
<para>
You should use <function>oci_lob_close</function> when the work with the
object is over.
</para>
<para>
&return.success;
</para>
<note>
<para>
In PHP versions before 5.0.0 you must use <function>ociwritetemporarylob</function> instead.
This name still can be used, it was left as alias of
<function>oci_lob_write_temporary</function> for downwards compatability.
This, however, is deprecated and not recommended.
</para>
</note>
<para>
See also <function>oci_lob_close</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
-->

View file

@ -1,50 +0,0 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.oci-lob-write">
<refnamediv>
<refname>lob->write</refname>
<refpurpose>Writes data to the large object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>lob->write</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Writes data from the parameter <parameter>data</parameter> into the
current position of LOB's internal pointer.
If the parameter <parameter>length</parameter> is given, writing will
stop after <parameter>length</parameter> bytes have been written or the
end of <parameter>data</parameter> is reached, whichever comes first.
</para>
<para>
<function>lob->write</function> returns the number of bytes written or
&false; in case of error.
</para>
<para>
See also <function>oci_lob_read</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
-->