archived-doc-ja/reference/dom/domcharacterdata/substringdata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 7d5c74c9a561dc63be999694ee65195bef1550a0 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="domcharacterdata.substringdata" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>DOMCharacterData::substringData</refname>
  <refpurpose>
   文字データから指定した範囲のデータを抽出する
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="DOMCharacterData">
   <modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>DOMCharacterData::substringData</methodname>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>count</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定した部分文字列を返します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       部分文字列の抽出開始位置のオフセット。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>count</parameter></term>
     <listitem>
      <para>
       抽出する文字数。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定された部分文字列を返します。
   <parameter>offset</parameter> と <parameter>count</parameter>
   の和が文字列の長さをこえている場合、データの末尾までのすべての
   UTF-8 コードポイントが返されます。
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <simpara>
   以下のエラーコードで <exceptionname>DOMException</exceptionname>
   をスローします:
  </simpara>
  <para>
   <variablelist>
    <varlistentry>
     <term><constant>DOM_INDEX_SIZE_ERR</constant></term>
     <listitem>
      <para>
       <parameter>offset</parameter> が負、
       あるいはデータ中の UTF-8 コードポイントの数より大きい場合、
       または <parameter>count</parameter> が負の場合に発生します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DOMCharacterData::appendData</methodname></member>
    <member><methodname>DOMCharacterData::deleteData</methodname></member>
    <member><methodname>DOMCharacterData::insertData</methodname></member>
    <member><methodname>DOMCharacterData::replaceData</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
-->