php-doc-en/reference/outcontrol/functions/ob-end-flush.xml
Nuno Lopes c2e98ff831 removed redundancy
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@147776 c90b9560-bf6c-de11-be94-00142212c4b1
2004-01-03 17:47:23 +00:00

88 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/outcontrol.xml, last change in rev 1.1 -->
<refentry id="function.ob-end-flush">
<refnamediv>
<refname>ob_end_flush</refname>
<refpurpose>
Flush (send) the output buffer and turn off output buffering
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ob_end_flush</methodname>
<void/>
</methodsynopsis>
<para>
This function will send the contents of the topmost output buffer (if
any) and turn this output buffer off. If you want to further
process the buffer's contents you have to call
<function>ob_get_contents</function> before
<function>ob_end_flush</function> as the buffer contents are
discarded after <function>ob_end_flush</function> is called.
The function returns &true; when it successfully
discarded one buffer and &false; otherwise. 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>
<note>
<simpara>
This function is similar to <function>ob_get_flush</function>, except
that <function>ob_get_flush</function> returns the buffer as a string.
</simpara>
</note>
<para>
The following example shows an easy way to flush and end all output
buffers:
</para>
<para>
<example>
<title><function>ob_end_flush</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
while (@ob_end_flush());
?>
]]>
</programlisting>
</example>
</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>
See also <function>ob_start</function>,
<function>ob_get_contents</function>,
<function>ob_get_flush</function>,
<function>ob_flush</function> and
<function>ob_end_clean</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
-->