php-doc-en/reference/mbstring/functions/mb-ereg-search-pos.xml
2012-07-02 01:31:49 +00:00

100 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-ereg-search-pos" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mb_ereg_search_pos</refname>
<refpurpose>Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mb_ereg_search_pos</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 position and length of a matched part of the multibyte regular expression
for a predefined multibyte string
</para>
<para>
The string for match is specified by
<function>mb_ereg_search_init</function>. If it is not specified,
the previous one will be used.
</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>
An <type>array</type> containing two elements. The first element is the
offset, in bytes, where the match begins relative to the start of the
search string, and the second element is the length in bytes of the match.
</simpara>
<simpara>
If an error occurs, &false; is returned.
</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
-->