php-doc-en/reference/mbstring/functions/mb-ereg-search-init.xml
2004-08-28 13:34:36 +00:00

64 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.23 -->
<refentry id="function.mb-ereg-search-init">
<refnamediv>
<refname>mb_ereg_search_init</refname>
<refpurpose>
Setup string and regular expression for multibyte regular
expression match
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_init</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
<methodparam choice="opt">
<type>string</type><parameter>pattern</parameter>
</methodparam>
<methodparam choice="opt">
<type>string</type><parameter>option</parameter>
</methodparam>
</methodsynopsis>
<simpara>
<function>mb_ereg_search_init</function> sets
<parameter>string</parameter> and <parameter>pattern</parameter>
for multibyte regular expression. These values are used for
<function>mb_ereg_search</function>,
<function>mb_ereg_search_pos</function>,
<function>mb_ereg_search_regs</function>. It returns &true; for
success, &false; for error.
</simpara>
<para>
The internal encoding or the character encoding specified in
<function>mb_regex_encoding</function> will be used as character
encoding.
</para>
<para>
See also: <function>mb_regex_encoding</function>,
<function>mb_ereg_search_regs</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->