<!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>Extracts a line from the front of the buffer</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eventbuffer.readfrom.html">EventBuffer::readFrom</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbuffer.search.html">EventBuffer::search</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.readline" class="refentry"> <div class="refnamediv"> <h1 class="refname">EventBuffer::readLine</h1> <p class="verinfo">(PECL event >= 1.2.6-beta)</p><p class="refpurpose"><span class="refname">EventBuffer::readLine</span> — <span class="dc-title">Extracts a line from the front of the buffer</span></p> </div> <div class="refsect1 description" id="refsect1-eventbuffer.readline-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>EventBuffer::readLine</strong></span> ( <span class="methodparam"> <span class="type">string</span> <code class="parameter">$eol_style</code> </span> )</div> <p class="para rdfs-comment"> Extracts a line from the front of the buffer and returns it in a newly allocated string. If there is not a whole line to read, the function returns <strong><code>NULL</code></strong>. The line terminator is not included in the copied string. </p> </div> <div class="refsect1 parameters" id="refsect1-eventbuffer.readline-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"> <em><code class="parameter">eol_style</code></em> </span> <dd> <p class="para"> One of <a href="class.eventbuffer.html#eventbuffer.constants" class="link">EventBuffer:EOL_* constants</a> . </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-eventbuffer.readline-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> On success returns the line read from the buffer, otherwise <strong><code>NULL</code></strong>. </p> </div> <div class="refsect1 seealso" id="refsect1-eventbuffer.readline-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="eventbuffer.copyout.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::copyout()</a> - Copies out specified number of bytes from the front of the buffer</span> </li> <li class="member"> <span class="methodname"><a href="eventbuffer.drain.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::drain()</a> - Removes specified number of bytes from the front of the buffer without copying it anywhere</span> </li> <li class="member"> <span class="methodname"><a href="eventbuffer.pullup.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::pullup()</a> - Linearizes data within buffer and returns it's contents as a string</span> </li> <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> <li class="member"> <span class="methodname"><a href="eventbuffer.appendfrom.html" class="methodname" rel="rdfs-seeAlso">EventBuffer::appendFrom()</a> - Moves the specified number of bytes from a source buffer to the end of the current buffer</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.readfrom.html">EventBuffer::readFrom</a></div> <div class="next" style="text-align: right; float: right;"><a href="eventbuffer.search.html">EventBuffer::search</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>