copyout.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<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>Copies out specified number of bytes from the front of the buffer</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>
   Behaves just like
   <methodname>EventBuffer::read</methodname>,
   but does not drain any data from the buffer. I.e. it copies the first
   <parameter>max_bytes</parameter>
   bytes from the front of the buffer into
   <parameter>data</parameter>.
   If there are fewer than
   <parameter>max_bytes</parameter>
   bytes available, the function copies all the bytes there are.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>data</parameter>
    </term>
    <listitem>
     <para>
      Output string.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>max_bytes</parameter>
    </term>
    <listitem>
     <para>
      The number of bytes to copy.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the number of bytes copied, or
   <constant>-1</constant>
   on failure.
  </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
-->