<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domcharacterdata.deletedata" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>DOMCharacterData::deleteData</refname>
  <refpurpose>
   Remove a range of characters from the node
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMCharacterData">
   <modifier>public</modifier> <type>bool</type><methodname>DOMCharacterData::deleteData</methodname>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>count</parameter></methodparam>
  </methodsynopsis>
  <para>
   Deletes <parameter>count</parameter> characters starting from position
   <parameter>offset</parameter>.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       The offset from which to start removing.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>count</parameter></term>
     <listitem>
      <para>
       The number of characters to delete. If the sum of
       <parameter>offset</parameter> and <parameter>count</parameter> exceeds
       the length, then all characters to the end of the data are deleted.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <variablelist>
    <varlistentry>
     <term><constant>DOM_INDEX_SIZE_ERR</constant></term>
     <listitem>
      <para>
       Raised if <parameter>offset</parameter> is negative or greater than the
       number of 16-bit units in data, or if <parameter>count</parameter> is
       negative.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMCharacterData::appendData</methodname></member>
    <member><methodname>DOMCharacterData::insertData</methodname></member>
    <member><methodname>DOMCharacterData::replaceData</methodname></member>
    <member><methodname>DOMCharacterData::substringData</methodname></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
-->
