mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 09:22:07 +01:00
84 lines
2.9 KiB
XML
84 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 20216b916ed583938672cd09c2c2f430351430d1 Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
|
|
<refentry xml:id="function.com-message-pump" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>com_message_pump</refname>
|
|
<refpurpose>Traite un message COM dans un délai donné</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>com_message_pump</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>timeout_milliseconds</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Traite un message COM en attendant jusqu'à <parameter>timeout_milliseconds</parameter>
|
|
millisecondes, ou bien en attendant qu'un message arrive dans la file
|
|
d'attente.
|
|
</para>
|
|
<para>
|
|
Le but de cette fonction est d'acheminer les appels COM entre les éléments et de
|
|
gérer les différentes synchronisations. Cela permet à votre script
|
|
d'attendre efficacement les événements à déclencher, tout en gérant
|
|
d'autres événements ou bien d'exécuter d'autres scripts en arrière-plan.
|
|
Vous devriez l'utiliser dan une boucle, comme dans l'exemple de la fonction
|
|
<function>com_event_sink</function>, jusqu'à ce que vous ayez fini
|
|
d'utiliser les objets COM liés à des événements.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>timeout_milliseconds</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le délai, en millisecondes.
|
|
</para>
|
|
<para>
|
|
Si vous ne spécifiez pas de valeur pour le paramètre
|
|
<parameter>timeout_milliseconds</parameter>, alors il voudra 0.
|
|
Une valeur à 0 signifie que les messages seront traités immédiatement ;
|
|
s'il y a des messages dans la file d'attente, ils seront distribués aussitôt ;
|
|
s'il n'y a aucun message dans la file d'attente, la fonction retournera &false;
|
|
immédiatement sans attendre.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Si un ou plusieurs messages arrivent avant le délai d'expiration,
|
|
ils seront distribués et la fonction retournera &true;. Si le délai d'expiration
|
|
survient et qu'aucun message n'est traité, la valeur retournée sera &false;.
|
|
</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
|
|
-->
|