1
0
mirror of https://github.com/php/doc-ru.git synced 2026-03-26 08:42:13 +01:00
Files
archived-doc-ru/reference/event/eventbuffer/copyout.xml
Sergey Panteleev 6d43fd64d7 Исправление форматирования
[skip-spellcheck]
[skip-lint]
2022-12-27 03:42:36 +03:00

95 lines
2.8 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 551313fd8a8f5fc8fab86b1689a96c0e9a437363 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="eventbuffer.copyout" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBuffer::copyout</refname>
<refpurpose>Копирует указанное количество байтов с начала буфера</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>int</type>
<methodname>EventBuffer::copyout</methodname>
<methodparam>
<type>string</type>
<parameter role="reference">data</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>max_bytes</parameter>
</methodparam>
</methodsynopsis>
<para>
Ведёт себя так же, как <methodname>EventBuffer::read</methodname>,
но не выводит данные из буфера. То есть он копирует первые байты <parameter>max_bytes</parameter>
с начала буфера в <parameter>data</parameter>.
Если доступно меньше <parameter>max_bytes</parameter>, функция копирует все имеющиеся байты.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>data</parameter>
</term>
<listitem>
<para>
Выходная строка.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>max_bytes</parameter>
</term>
<listitem>
<para>
Количество байтов для копирования.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает количество скопированных байтов
или <constant>-1</constant> в случае возникновения ошибки.
</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
-->