cvs: phpdoc /en/reference/outcontrol/functions ob-end-clean.xml

helly Tue May 27 14:37:30 2003 EDT Modified files: /phpdoc/en/reference/outcontrol/functions ob-end-clean.xml Log: #23826 [NEW]: ob_end_clean() returns error notice when buffer is empty Index: phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml diff -u phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.2 phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.3 --- phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml:1.2 Wed Apr 17 02:42:33 2002 +++ phpdoc/en/reference/outcontrol/functions/ob-end-clean.xml Tue May 27 14:37:29 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 --> <refentry id="function.ob-end-clean"> <refnamediv> @@ -11,17 +11,43 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>ob_end_clean</methodname> + <type>bool</type><methodname>ob_end_clean</methodname> <void/> </methodsynopsis> <para> - This function discards the contents of the output buffer and - turns off output buffering. + This function discards the contents of the topmost output buffer and + turns off this output buffering. It returns true when it successfully + discarded one buffer and false otherwide. Reasons for failure are first + that you called the function without an active buffer or that for some + reason a buffer could not be deleted (possible for special buffer). </para> <para> See also <function>ob_start</function>, <function>ob_clean</function> and <function>ob_end_flush</function>. + </para> + <para> + The following example shows an easy way to get rid of all output buffers: + <example> + <title><function>ob_end_clean</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +while (@ob_end_clean()); +?> +]]> + </programlisting> + </example> + </para> + <para> + <note> + <simpara> + If the function fails it generates an E_NOTICE. + </simpara> + <simpara> + The boolean return value was added in PHP 4.2.0. + </simpara> + </note> </para> </refsect1> </refentry>