php-doc-en/reference/dom/functions/dom-domcharacterdata-substringdata.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id='function.dom-domcharacterdata-substringdata'>
 <refnamediv>
  <refname>DOMCharacterData->substringData()</refname>
  <refpurpose>
   Extracts a range of data from the node
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>DOMCharacterData</classname></ooclass>
   <methodsynopsis>
    <type>string</type>
    <methodname>substringData</methodname>
    <methodparam><type>int</type><parameter>offset</parameter></methodparam>
    <methodparam><type>int</type><parameter>count</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   Returns the specified substring. 
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Start offset of substring to extract.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>count</parameter></term>
     <listitem>
      <para>
       The number of characters to extract.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The specified substring. If the sum of <parameter>offset</parameter> 
   and <parameter>count</parameter> exceeds the length, then all 16-bit units 
   to the end of the data are returned.
  </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-deletedata" /></member>
    <member><xref linkend="function.dom-domcharacterdata-insertdata" /></member>
    <member><xref linkend="function.dom-domcharacterdata-replacedata" /></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
-->