Source of: /manual/en/function.mb-ereg-search-init.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.mbstring.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.mb-ereg-search-init.php',

    1 => 'mb_ereg_search_init',

  ),

  'up' => 

  array (

    0 => 'ref.mbstring.php',

    1 => 'Multibyte String Functions',

  ),

  'prev' => 

  array (

    0 => 'function.mb-ereg-search-getregs.php',

    1 => 'mb_ereg_search_getregs',

  ),

  'next' => 

  array (

    0 => 'function.mb-ereg-search-pos.php',

    1 => 'mb_ereg_search_pos',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.mb-ereg-search-init" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">mb_ereg_search_init</h1>

  <p class="verinfo">(PHP 4 &gt;= 4.2.0, PHP 5)</p><p class="refpurpose"><span class="refname">mb_ereg_search_init</span> &mdash; <span class="dc-title">Setup string and regular expression for a multibyte regular expression match</span></p>



 </div>

   

 <a name="function.mb-ereg-search-init.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="methodsynopsis dc-description">

   <span class="type">bool</span> <span class="methodname"><b>mb_ereg_search_init</b></span>

    ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$string</tt></span>

   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$pattern</tt></span>

   [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$option</tt><span class="initializer"> = &quot;msr&quot;</span></span>

  ]] )</div>



  <p class="para rdfs-comment">

   <b>mb_ereg_search_init()</b> sets

   <i><tt class="parameter">string</tt></i>

 and <i><tt class="parameter">pattern</tt></i>



   for a multibyte regular expression. These values are used for

   <a href="function.mb-ereg-search.php" class="function">mb_ereg_search()</a>,

   <a href="function.mb-ereg-search-pos.php" class="function">mb_ereg_search_pos()</a>, and

   <a href="function.mb-ereg-search-regs.php" class="function">mb_ereg_search_regs()</a>. 

  </p>

 </div>





 <a name="function.mb-ereg-search-init.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">string</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The search string.

      </p>

     </dd>



    

    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">pattern</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The search pattern.

      </p>

     </dd>



    

    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">option</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The search option. Defaults to &#039;ms&#039;.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>



 

 <a name="function.mb-ereg-search-init.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="simpara">

   Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.

  </p>

 </div>





 <a name="function.mb-ereg-search-init.notes"></a><div class="refsect1 notes">

  <h3 class="title">Notes</h3>

  

  <blockquote><p><b class="note">Note</b>: The internal encoding or the

character encoding specified by <a href="function.mb-regex-encoding.php" class="function">mb_regex_encoding()</a>

will be used as the character encoding for this function.<br /></p></blockquote>

 </div>





 <a name="function.mb-ereg-search-init.seealso"></a><div class="refsect1 seealso">

  <h3 class="title">See Also</h3>

  <p class="para">

   </p><ul class="simplelist">

    <li class="member"><a href="function.mb-regex-encoding.php" class="function" rel="rdfs-seeAlso">mb_regex_encoding()</a> - Returns current encoding for multibyte regex as string</li>

    <li class="member"><a href="function.mb-ereg-search-regs.php" class="function" rel="rdfs-seeAlso">mb_ereg_search_regs()</a> - Returns the matched part of a multibyte regular expression</li>

   </ul><p>

  </p>

 </div>





</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.mb-ereg-search-init.php
