Source of: /manual/en/function.ob-end-flush.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.outcontrol.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.ob-end-flush.php',
1 => 'ob_end_flush',
),
'up' =>
array (
0 => 'ref.outcontrol.php',
1 => 'Output Control Functions',
),
'prev' =>
array (
0 => 'function.ob-end-clean.php',
1 => 'ob_end_clean',
),
'next' =>
array (
0 => 'function.ob-flush.php',
1 => 'ob_flush',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.ob-end-flush" class="refentry">
<div class="refnamediv">
<h1 class="refname">ob_end_flush</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ob_end_flush</span> — <span class="dc-title">Flush (send) the output buffer and turn off output buffering</span></p>
</div>
<a name="function.ob-end-flush.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>ob_end_flush</b></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
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
<a href="function.ob-get-contents.php" class="function">ob_get_contents()</a> before
<b>ob_end_flush()</b> as the buffer contents are
discarded after <b>ob_end_flush()</b> is called.
</p>
<blockquote><p><b class="note">Note</b>:
<span class="simpara">
This function is similar to <a href="function.ob-get-flush.php" class="function">ob_get_flush()</a>, except
that <a href="function.ob-get-flush.php" class="function">ob_get_flush()</a> returns the buffer as a string.
</span>
</p></blockquote>
</div>
<a name="function.ob-end-flush.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure. 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).
</p>
</div>
<a name="function.ob-end-flush.errors"></a><div class="refsect1 errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
If the function fails it generates an <b><tt class="constant">E_NOTICE</tt></b>.
</p>
</div>
<a name="function.ob-end-flush.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">4.2.0</td>
<td align="left">
The boolean return value was added.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.ob-end-flush.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>ob_end_flush()</b> example</b></p>
<div class="example-contents para"><p>
The following example shows an easy way to flush and end all output
buffers:
</p></div>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #007700">while (@</span><span style="color: #0000BB">ob_end_flush</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
<a name="function.ob-end-flush.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.ob-start.php" class="function" rel="rdfs-seeAlso">ob_start()</a> - Turn on output buffering</li>
<li class="member"><a href="function.ob-get-contents.php" class="function" rel="rdfs-seeAlso">ob_get_contents()</a> - Return the contents of the output buffer</li>
<li class="member"><a href="function.ob-get-flush.php" class="function" rel="rdfs-seeAlso">ob_get_flush()</a> - Flush the output buffer, return it as a string and turn off output buffering</li>
<li class="member"><a href="function.ob-flush.php" class="function" rel="rdfs-seeAlso">ob_flush()</a> - Flush (send) the output buffer</li>
<li class="member"><a href="function.ob-end-clean.php" class="function" rel="rdfs-seeAlso">ob_end_clean()</a> - Clean (erase) the output buffer and turn off output buffering</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
