ob-clean.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ob-clean" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ob_clean</refname>
  <refpurpose>Clean (erase) the contents of the active output buffer</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ob_clean</methodname>
   <void/>
  </methodsynopsis>
  <para>
   This function calls the output handler
   (with the <constant>PHP_OUTPUT_HANDLER_CLEAN</constant> flag),
   discards it's return value
   and cleans (erases) the contents of the active output buffer.
  </para>
  <para>
   This function does not turn off the active output buffer like
   <function>ob_end_clean</function> or <function>ob_get_clean</function> does.
  </para>
  <para>
   <function>ob_clean</function> will fail
   without an active output buffer started with the
   <constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant> flag.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   If the function fails it generates an <constant>E_NOTICE</constant>.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ob_start</function></member>
    <member><function>ob_get_contents</function></member>
    <member><function>ob_end_clean</function></member>
    <member><function>ob_get_clean</function></member>
    <member><function>ob_flush</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
-->