<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Flush current buffer</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.xmlwriter-end-pi.html">XMLWriter::endPI</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.xmlwriter-full-end-element.html">XMLWriter::fullEndElement</a></div> <div class="up"><a href="ref.xmlwriter.html">XMLWriter Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.xmlwriter-flush" class="refentry"> <div class="refnamediv"> <h1 class="refname">XMLWriter::flush</h1> <h1 class="refname">xmlwriter_flush</h1> <p class="verinfo">(PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0)</p><p class="refpurpose"><span class="refname">XMLWriter::flush</span> -- <span class="refname">xmlwriter_flush</span> — <span class="dc-title">Flush current buffer</span></p> </div> <div class="refsect1 description" id="refsect1-function.xmlwriter-flush-description"> <h3 class="title">Description</h3> <p class="para">Object oriented style</p> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>XMLWriter::flush</strong></span> ([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$empty</code><span class="initializer"> = true</span></span> ] )</div> <p class="para rdfs-comment">Procedural style</p> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>xmlwriter_flush</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$xmlwriter</code></span> [, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$empty</code><span class="initializer"> = true</span></span> ] )</div> <p class="para rdfs-comment"> Flushes the current buffer. </p> </div> <div class="refsect1 parameters" id="refsect1-function.xmlwriter-flush-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter"> xmlwriter</code></em></span><dd> <p class="para">Only for procedural calls. The XMLWriter <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> that is being modified. This resource comes from a call to <span class="function"><a href="function.xmlwriter-open-uri.html" class="function">xmlwriter_open_uri()</a></span> or <span class="function"><a href="function.xmlwriter-open-memory.html" class="function">xmlwriter_open_memory()</a></span>.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">empty</code></em></span> <dd> <p class="para"> Whether to empty the buffer or not. Default is <strong><code>TRUE</code></strong>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.xmlwriter-flush-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> If you opened the writer in memory, this function returns the generated XML buffer, Else, if using URI, this function will write the buffer and return the number of written bytes. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.xmlwriter-end-pi.html">XMLWriter::endPI</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.xmlwriter-full-end-element.html">XMLWriter::fullEndElement</a></div> <div class="up"><a href="ref.xmlwriter.html">XMLWriter Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>