Files
doc-fr/reference/event/eventbuffer/drain.xml
2021-07-27 19:08:22 +03:00

83 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: da9d81816187b87c03a6cd92a3c3b833f039485c Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="eventbuffer.drain" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBuffer::drain</refname>
<refpurpose>Supprime un nombre spécifié d'octets depuis le début du tampon
sans copier les données</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>bool</type>
<methodname>EventBuffer::drain</methodname>
<methodparam>
<type>int</type>
<parameter>len</parameter>
</methodparam>
</methodsynopsis>
<para>
Fonctionne de la même manière que la méthode
<methodname>EventBuffer::read</methodname> excepté le fait que
les données supprimées ne sont pas copiées : elles sont seulement
supprimer du début du tampon.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>len</parameter>
</term>
<listitem>
<para>
Le nombre d'octets à supprimer depuis le tampon.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBuffer::read</methodname>
</member>
<member>
<methodname>EventBuffer::appendFrom</methodname>
</member>
</simplelist>
</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
-->