Files
doc-fr/reference/event/eventbuffer/pullup.xml
Samuel NELA ab29eee1aa Fix typos in magic methods documentation and change translation of serialization (#611)
Stop using "linéarisation" and instead use "sérialisation"
2023-09-20 22:11:41 +01:00

101 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="eventbuffer.pullup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBuffer::pullup</refname>
<refpurpose>Sérialise les données du buffer et retourne le contenu du
buffer sous la forme d'une chaîne</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>string</type>
<methodname>EventBuffer::pullup</methodname>
<methodparam>
<type>int</type>
<parameter>size</parameter>
</methodparam>
</methodsynopsis>
<para>
Sérialise les premiers <parameter>size</parameter> octets du buffer,
les copie ou les bouge comme nécessaire pour assurer qu'ils soient contigus
et le fait d'occuper la même partie de la mémoire. Si la taille
est négative, la fonction linéatise la totalité du buffer.
</para>
<warning>
<para>
L'appel à la méthode <methodname>EventBuffer::pullup</methodname>
avec une taille très grande ralentie l'exécution, sachant qu'elle
peut potentiellement avoir besoin de copier le contenu entier du buffer.
</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>size</parameter>
</term>
<listitem>
<para>
Le nombre d'octets qui doivent être contigus dans le buffer.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Si <parameter>size</parameter> est supérieur au nombre d'octets du buffer,
la fonction retournera &null;. Sinon, <methodname>EventBuffer::pullup</methodname>
retournera une chaîne de caractères.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBuffer::copyout</methodname>
</member>
<member>
<methodname>EventBuffer::drain</methodname>
</member>
<member>
<methodname>EventBuffer::read</methodname>
</member>
<member>
<methodname>EventBuffer::readLine</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
-->