php-doc-en/reference/mbstring/functions/mb-ereg-search-regs.xml
2009-11-25 14:49:47 +00:00

94 lines
2.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-ereg-search-regs" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_ereg_search_regs</refname>
<refpurpose>Returns the matched part of a multibyte regular expression</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_regs</methodname>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>option</parameter><initializer>"ms"</initializer></methodparam>
</methodsynopsis>
<para>
Returns the matched part of a multibyte regular expression.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
The search pattern.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The search option.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
<function>mb_ereg_search_regs</function> executes the multibyte
regular expression match, and if there are some matched part, it
returns an <type>array</type> including substring of matched part as first
element, the first grouped part with brackets as second element,
the second grouped part as third element, and so on.
It returns &false; on error.
</simpara>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.mbstring.encoding.internal;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mb_regex_encoding</function></member>
<member><function>mb_ereg_search_init</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->