<?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 => 'en',
  ),
  'this' => 
  array (
    0 => 'eventbuffer.searcheol.php',
    1 => 'EventBuffer::searchEol',
    2 => 'Scans the buffer for an occurrence of an end of line',
  ),
  'up' => 
  array (
    0 => 'class.eventbuffer.php',
    1 => 'EventBuffer',
  ),
  'prev' => 
  array (
    0 => 'eventbuffer.search.php',
    1 => 'EventBuffer::search',
  ),
  'next' => 
  array (
    0 => 'eventbuffer.substr.php',
    1 => 'EventBuffer::substr',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/event/eventbuffer/searcheol.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="eventbuffer.searcheol" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">EventBuffer::searchEol</h1>
  <p class="verinfo">(PECL event &gt;= 1.5.0)</p><p class="refpurpose"><span class="refname">EventBuffer::searchEol</span> &mdash; <span class="dc-title">Scans the buffer for an occurrence of an end of line</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-eventbuffer.searcheol-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span>
   <span class="methodname"><strong>EventBuffer::searchEol</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 class="initializer"> = -1</span>
   </span>, <span class="methodparam">
    
    <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$eol_style</code>
    <span class="initializer"> = 
     <strong><code><a href="class.eventbuffer.php#eventbuffer.constants.eol-any">EventBuffer::EOL_ANY</a></code></strong>
    </span>
   </span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="para rdfs-comment">
   Scans the buffer for an occurrence of an end of line specified by
   <code class="parameter">eol_style</code>
   parameter . It returns numeric position of the string, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> if the
   string was not found.
  </p>
  <p class="para">
   If the
   <code class="parameter">start</code>
   argument is provided, it represents the position at which the search should
   begin; otherwise, the search is performed from the start of the string. If
   <code class="parameter">end</code>
   argument provided, the search is performed between start and end buffer
   positions.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-eventbuffer.searcheol-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt>
     <code class="parameter">start</code>
    </dt>
    <dd>
     <p class="para">
      Start search position.
     </p>
    </dd>
   
   
    <dt>
     <code class="parameter">eol_style</code>
    </dt>
    <dd>
     <p class="para">
      One of
      <a href="class.eventbuffer.php#eventbuffer.constants" class="link">EventBuffer:EOL_* constants</a>.
     </p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-eventbuffer.searcheol-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns numeric position of the first occurrence of end-of-line symbol in
   the buffer, or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> if not found.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.php" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.php" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>
 </div>

 <div class="refsect1 seealso" id="refsect1-eventbuffer.searcheol-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li>
    <span class="methodname"><a href="eventbuffer.search.php" class="methodname" rel="rdfs-seeAlso">EventBuffer::search()</a> - Scans the buffer for an occurrence of a string</span>
   </li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>