php-doc-en/reference/libevent/functions/event-buffer-disable.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.event-buffer-disable" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>event_buffer_disable</refname>
  <refpurpose>Disable a buffered event</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>event_buffer_disable</methodname>
   <methodparam><type>resource</type><parameter>bevent</parameter></methodparam>
   <methodparam><type>int</type><parameter>events</parameter></methodparam>
  </methodsynopsis>
  <para>
   Disables the specified buffered event.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>bevent</parameter></term>
     <listitem>
      <para>
       Valid buffered event resource.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>events</parameter></term>
     <listitem>
      <para>
       Any combination of <constant>EV_READ</constant> and
       <constant>EV_WRITE</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>event_buffer_disable</function> returns &true; on success or &false; on error.
  </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
-->