<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.com.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.com-event-sink.php',
    1 => 'com_event_sink',
    2 => 'Connecte des &eacute;v&eacute;nements d\'un objet COM sur un objet PHP',
  ),
  'up' => 
  array (
    0 => 'ref.com.php',
    1 => 'Fonctions COM et .Net (Windows)',
  ),
  'prev' => 
  array (
    0 => 'function.com-create-guid.php',
    1 => 'com_create_guid',
  ),
  'next' => 
  array (
    0 => 'function.com-get-active-object.php',
    1 => 'com_get_active_object',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/com/functions/com-event-sink.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.com-event-sink" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">com_event_sink</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.2.0, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">com_event_sink</span> &mdash; <span class="dc-title">Connecte des événements d&#039;un objet COM sur un objet PHP</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.com-event-sink-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>com_event_sink</strong></span>(<span class="methodparam"><span class="type"><a href="class.variant.php" class="type variant">variant</a></span> <code class="parameter">$variant</code></span>, <span class="methodparam"><span class="type"><a href="language.types.object.php" class="type object">object</a></span> <code class="parameter">$sink_object</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter">$sink_interface</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Connecte des événements de l&#039;objet COM
   <code class="parameter">variant</code> sur l&#039;objet PHP
   <code class="parameter">sink_object</code>.
  </p>
  <p class="para">
   Il convient d&#039;être prudent lors de l&#039;utilisation de cette fonctionnalité ;
   si l&#039;on fait quelque chose de similaire à l&#039;exemple
   ci-dessous, cela n&#039;a pas de sens de lancer sur un serveur Web.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.com-event-sink-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">variant</code></dt>
     <dd>
      <p class="para">
      </p>
     </dd>
    
    
     <dt><code class="parameter">sink_object</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">sink_object</code> doit être une instance de la classe
       avec des noms de méthodes suivant le dispinterface désiré ; il est recommandé
       d&#039;utiliser <span class="function"><a href="function.com-print-typeinfo.php" class="function">com_print_typeinfo()</a></span> pour l&#039;aide à la
       génération d&#039;un gabarit de classe pour cela.
      </p>
     </dd>
    
    
     <dt><code class="parameter">sink_interface</code></dt>
     <dd>
      <p class="para">
       PHP devrait être capable d&#039;utiliser le type par défaut de dispinterface
       spécifié par la Typelib associée avec l&#039;objet <code class="parameter">variant</code>,
       mais il est possible de changer cela en spécifiant dans le paramètre
       <code class="parameter">sink_interface</code> le dispinterface que l&#039;on
       souhaite utiliser.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.com-event-sink-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Cette fonction retourne <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> en cas de succès ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.com-event-sink-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">sink_interface</code> est désormais nullable.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.com-event-sink-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Exemple de connexions d&#039;événements COM</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">IEEventSinker </span><span style="color: #007700">{<br />    var </span><span style="color: #0000BB">$terminated </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /><br />   function </span><span style="color: #0000BB">ProgressChange</span><span style="color: #007700">(</span><span style="color: #0000BB">$progress</span><span style="color: #007700">, </span><span style="color: #0000BB">$progressmax</span><span style="color: #007700">) {<br />      echo </span><span style="color: #DD0000">"Progression du téléchargement : </span><span style="color: #0000BB">$progress</span><span style="color: #DD0000"> / </span><span style="color: #0000BB">$progressmax</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />    }<br /><br />    function </span><span style="color: #0000BB">DocumentComplete</span><span style="color: #007700">(&amp;</span><span style="color: #0000BB">$dom</span><span style="color: #007700">, </span><span style="color: #0000BB">$url</span><span style="color: #007700">) {<br />      echo </span><span style="color: #DD0000">"Document </span><span style="color: #0000BB">$url</span><span style="color: #DD0000"> terminé\n"</span><span style="color: #007700">;<br />    }<br /><br />    function </span><span style="color: #0000BB">OnQuit</span><span style="color: #007700">() {<br />      echo </span><span style="color: #DD0000">"Quit!\n"</span><span style="color: #007700">;<br />      </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">terminated </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />    }<br />}<br /></span><span style="color: #0000BB">$ie </span><span style="color: #007700">= new </span><span style="color: #0000BB">COM</span><span style="color: #007700">(</span><span style="color: #DD0000">"InternetExplorer.Application"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$sink </span><span style="color: #007700">= new </span><span style="color: #0000BB">IEEventSinker</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">com_event_sink</span><span style="color: #007700">(</span><span style="color: #0000BB">$ie</span><span style="color: #007700">, </span><span style="color: #0000BB">$sink</span><span style="color: #007700">, </span><span style="color: #DD0000">"DWebBrowserEvents2"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$ie</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">Visible </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$ie</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">Navigate</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://www.example.org"</span><span style="color: #007700">);<br />while(!</span><span style="color: #0000BB">$sink</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">terminated</span><span style="color: #007700">) {<br />  </span><span style="color: #0000BB">com_message_pump</span><span style="color: #007700">(</span><span style="color: #0000BB">4000</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">$ie </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.com-event-sink-notes">
  <h3 class="title">Notes</h3>
  <div class="caution"><strong class="caution">Attention</strong>
   <p class="para">
    Antérieur à PHP 8.0.0, appeler <span class="function"><a href="function.exit.php" class="function">exit()</a></span> depuis n&#039;importe
    quel gestionnaire d&#039;événement n&#039;est pas supporté et peut faire planter PHP.
    Ceci peut être contourné en lançant une exception depuis un
    gestionnaire d&#039;événement, en attrapant l&#039;exception dans le code principal,
    et en appelant <span class="function"><a href="function.exit.php" class="function">exit()</a></span> depuis celui-ci.
   </p>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.com-event-sink-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.com-print-typeinfo.php" class="function" rel="rdfs-seeAlso">com_print_typeinfo()</a> - Affiche une d&eacute;finition de classe PHP pour une interface r&eacute;partissable</span></li>
    <li><span class="function"><a href="function.com-message-pump.php" class="function" rel="rdfs-seeAlso">com_message_pump()</a> - Traite un message COM dans un d&eacute;lai donn&eacute;</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>