php-doc-en/reference/oci8/functions/OCI-Lob-erase.xml
Mehdi Achour 0ac403fe47 new docs, written by Antony Dovgal
# need an english reviewer


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153134 c90b9560-bf6c-de11-be94-00142212c4b1
2004-03-08 14:12:17 +00:00

52 lines
1.7 KiB
XML

<?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
-->