preg-last-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.preg-last-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>preg_last_error</refname>
  <refpurpose>Returns the error code of the last PCRE regex execution</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>preg_last_error</methodname>
   <void />
  </methodsynopsis>
  <para>
   Returns the error code of the last PCRE regex execution.
  </para>
  <para>
   <example>
    <title><function>preg_last_error</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

preg_match('/(?:\D+|<\d+>)*[!?]/', 'foobar foobar foobar');

if (preg_last_error() == PREG_BACKTRACK_LIMIT_ERROR) {
    echo 'Backtrack limit was exhausted!';
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Backtrack limit was exhausted!
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
  
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns one of the following constants (<link
   linkend="pcre.constants">explained on their own page</link>):
   <simplelist>
    <member><constant>PREG_NO_ERROR</constant></member>
    <member><constant>PREG_INTERNAL_ERROR</constant></member>
    <member><constant>PREG_BACKTRACK_LIMIT_ERROR</constant> (see also <link
    linkend="ini.pcre.backtrack-limit">pcre.backtrack_limit</link>)</member>
    <member><constant>PREG_RECURSION_LIMIT_ERROR</constant> (see also <link
    linkend="ini.pcre.recursion-limit">pcre.recursion_limit</link>)</member>
    <member><constant>PREG_BAD_UTF8_ERROR</constant></member>
    <member><constant>PREG_BAD_UTF8_OFFSET_ERROR</constant></member>
    <member><constant>PREG_JIT_STACKLIMIT_ERROR</constant></member>
   </simplelist>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>preg_last_error_msg</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
-->