<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!-- splitted from ./en/functions/misc.xml, last change in rev 1.2 -->
  <refentry id="function.exit">
   <refnamediv>
    <refname>exit</refname>
    <refpurpose>Output a message and terminate the current script</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>exit</methodname>
      <methodparam choice="opt"><type>string</type><parameter>status</parameter></methodparam>
     </methodsynopsis>
     <methodsynopsis>
      <type>void</type><methodname>exit</methodname>
      <methodparam><type>int</type><parameter>status</parameter></methodparam>
     </methodsynopsis>
    <note>
     <simpara>
      This is not a real function, but a language construct.
     </simpara>
    </note>
    <note>
     <simpara>
      PHP &gt;= 4.2.0 does NOT print the <parameter>status</parameter>
      if it is an <type>integer</type>.
     </simpara>
    </note>
    <simpara>
     The <function>exit</function> function terminates execution of
     the script. It prints <parameter>status</parameter> just before exiting.
    </simpara>
    <simpara>
     If <parameter>status</parameter> is an <type>integer</type>, that value
     will also be used as the exit status. Exit statuses should be in the
     range 0 to 254, the exit status 255 is reserved by PHP and shall not be
     used. The status 0 is used to terminate the program successfully.
    </simpara>
    <para>
     <example>
      <title><function>exit</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php

$filename = '/path/to/data-file';
$file = fopen($filename, 'r')
    or exit("unable to open file ($filename)");

?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <example>
      <title><function>exit</function> status example</title>
      <programlisting role="php">
<![CDATA[
<?php

//exit program normally
exit;
exit();
exit(0);

//exit with an error code
exit(1);
exit(0376); //octal

?>
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <simpara>
      The <function>die</function> function is an alias for
      <function>exit</function>.
     </simpara>
    </note>
    <para>
     See also: <function>register_shutdown_function</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
-->