mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
100 lines
2.8 KiB
XML
100 lines
2.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="domcharacterdata.substringdata" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>DOMCharacterData::substringData</refname>
|
|
<refpurpose>
|
|
Extracts a range of data from the node
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<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>
|
|
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="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::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
|
|
-->
|