erase.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ocilob.erase" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>OCILob::erase</refname>
  <refpurpose>Erases a specified portion of the internal LOB data</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="OCILob">
   <modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>OCILob::erase</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>offset</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Erases a specified portion of the internal LOB data starting at a
   specified <parameter>offset</parameter>. If called without parameters, it
   erases all LOB data.
  </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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the actual number of characters/bytes erased &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0, PECL OCI8 3.0.0</entry>
      <entry>
       <parameter>offset</parameter> and <parameter>length</parameter> are now nullable.
      </entry>
     </row>
     <row>
      <entry>8.0.0, PECL OCI8 3.0.0</entry>
      <entry>
       The <classname>OCI-Lob</classname> class was renamed to
       <classname>OCILob</classname> to align with PHP naming standards.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="ocilob.truncate"/></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
-->