File: ob-end-flush.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (88 lines) | stat: -rw-r--r-- 2,655 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?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
-->