php-doc-en/reference/dom/functions/dom-domcharacterdata-deletedata.xml
Jakub Vrana 9b87277553 Fix void return type
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@184127 c90b9560-bf6c-de11-be94-00142212c4b1
2005-04-11 08:27:32 +00:00

105 lines
2.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id='function.dom-domcharacterdata-deletedata'>
<refnamediv>
<refname>DOMCharacterData->deleteData()</refname>
<refpurpose>
Remove a range of characters from the node
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DOMCharacterData</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>deleteData</methodname>
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<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.void;
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<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><xref linkend="function.dom-domcharacterdata-appenddata" /></member>
<member><xref linkend="function.dom-domcharacterdata-insertdata" /></member>
<member><xref linkend="function.dom-domcharacterdata-replacedata" /></member>
<member><xref linkend="function.dom-domcharacterdata-substringdata" /></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:"../../../../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
-->