<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.eventbuffer.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'de',
),
'this' =>
array (
0 => 'eventbuffer.substr.php',
1 => 'EventBuffer::substr',
2 => 'Substracts a portion of the buffer data',
),
'up' =>
array (
0 => 'class.eventbuffer.php',
1 => 'EventBuffer',
),
'prev' =>
array (
0 => 'eventbuffer.searcheol.php',
1 => 'EventBuffer::searchEol',
),
'next' =>
array (
0 => 'eventbuffer.unfreeze.php',
1 => 'EventBuffer::unfreeze',
),
'alternatives' =>
array (
),
'source' =>
array (
'lang' => 'en',
'path' => 'reference/event/eventbuffer/substr.xml',
),
'history' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);
contributors($setup);
?>
<div id="eventbuffer.substr" class="refentry">
<div class="refnamediv">
<h1 class="refname">EventBuffer::substr</h1>
<p class="verinfo">(PECL event >= 1.6.0)</p><p class="refpurpose"><span class="refname">EventBuffer::substr</span> — <span class="dc-title">Substracts a portion of the buffer data</span></p>
</div>
<div class="refsect1 description" id="refsect1-eventbuffer.substr-description">
<h3 class="title">Beschreibung</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="methodname"><strong>EventBuffer::substr</strong></span>(<span class="methodparam">
<span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$start</code>
</span>, <span class="methodparam">
<span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code>
<span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<p class="para rdfs-comment">
Substracts up to
<code class="parameter">length</code>
bytes of the buffer data beginning at
<code class="parameter">start</code>
position.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-eventbuffer.substr-parameters">
<h3 class="title">Parameter-Liste</h3>
<dl>
<dt>
<code class="parameter">start</code>
</dt>
<dd>
<p class="para">
The start position of data to be substracted.
</p>
</dd>
<dt>
<code class="parameter">length</code>
</dt>
<dd>
<p class="para">
Maximum number of bytes to substract.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-eventbuffer.substr-returnvalues">
<h3 class="title">Rückgabewerte</h3>
<p class="para">
Returns the data substracted as a
<span class="type"><a href="language.types.string.php" class="type string">string</a></span>
on success, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-eventbuffer.substr-seealso">
<h3 class="title">Siehe auch</h3>
<ul class="simplelist">
<li>
<span class="methodname"><a href="eventbuffer.read.php" class="methodname" rel="rdfs-seeAlso">EventBuffer::read()</a> - Read data from an evbuffer and drain the bytes read</span>
</li>
</ul>
</div>
</div><?php manual_footer($setup); ?>