php-doc-en/reference/xmlwriter/functions/xmlwriter-flush.xml
Jakub Vrana 0d604bbc9d Remove <classsynopsis> from methods and fields definitions
PhD uses this context for decisions about links and similar.
It also simplifies the XML

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322205 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-13 14:20:43 +00:00

75 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xmlwriter-flush" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>XMLWriter::flush</refname>
<refname>xmlwriter_flush</refname>
<refpurpose>Flush current buffer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<type>mixed</type><methodname>XMLWriter::flush</methodname>
<methodparam choice="opt"><type>bool</type><parameter>empty</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>mixed</type><methodname>xmlwriter_flush</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>empty</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
Flushes the current buffer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>empty</parameter></term>
<listitem>
<para>
Whether to empty the buffer or not. Default is &true;.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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.
</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:"~/.phpdoc/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
-->