<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Substracts a portion of the buffer data</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.searcheol.html">EventBuffer::searchEol</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.unfreeze.html">EventBuffer::unfreeze</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span>
<span class="methodname"><strong>EventBuffer::substr</strong></span>
( <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$start</code>
</span>
[, <span class="methodparam">
<span class="type">int</span>
<code class="parameter">$length</code>
</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">Parameters</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">Return Values</h3>
<p class="para">
Returns the data substracted as a
<span class="type"><a href="language.types.string.html" class="type string">string</a></span>
on success, or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-eventbuffer.substr-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member">
<span class="methodname"><a href="eventbuffer.read.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::read()</a> - Read data from an evbuffer and drain the bytes read</span>
</li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.searcheol.html">EventBuffer::searchEol</a></div>
<div class="next" style="text-align: right; float: right;"><a href="eventbuffer.unfreeze.html">EventBuffer::unfreeze</a></div>
<div class="up"><a href="class.eventbuffer.html">EventBuffer</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
