AtlEvnt.exe exemple montre comment crée des récepteurs d'ATL en utilisant les classes ATL IDispEventImpl et IDispEventSimpleImpl

Visual C++ 6.0

Réduire cette imageAgrandir cette image

Download Atlevnt.exe now (http://download.microsoft.com/download/vc60pro/sample7/1/win98/en-us/atlevnt.exe)

Visual C++ .NET

Réduire cette imageAgrandir cette image

Download Atlevntvcnet.exe now (http://download.microsoft.com/download/visualstudionet/sample/1.11/win98mexp/en-us/atlevntvcnet.exe)

Retour au début

Vue d'ensemble du projet

   dispinterface _EventSink
   {

      properties:
      methods:
      [id(1), helpstring("method Tick")] HRESULT Tick([in] long tckcnt);

   }

				

Retour au début

Étapes pour mettre en ?uvre de IDispEventImpl

1. Créer une nouvelle classe dérivée à partir de IDispEventImpl. Vous pouvez cliquer sur Nouvelle classe dans le menu Insertion pour générer une nouvelle classe. Pour chaque récepteur différent, ajouter une classe de IDispEventImpl à la liste d'héritage avec un ID unique en tant que premier paramètre. La classe de récepteur peut être un objet COM (comme dans un contrôle composite) ou une classe qui dérive simplement de IdispEventImpl :

   // Just a sink.
         class CSinkObj : public IDispEventImpl<IDC_OBJ, CSinkObj>
         {
            ...
         }

   - ou -

   // COM object that also implements a sink (as in a composite
         // control).
         class ATL_NO_VTABLE CSinkObj :
            public CComObjectRootEx<CComSingleThreadModel>,
            public CComCoClass<CSinkObj, &CLSID_SinkObj>,
            public IDispatchImpl<ISinkObj, &IID_ISinkObj, &LIBID_SINKPROJLib>,
            public IDispEventImpl<IDC_SRCOBJ, CSinkObj>
         {
            ...
         }

2. Vous pouvez spécifiez l'ID de l'interface source, les ID du type de bibliothèque, les numéros de version principale et secondaire de la bibliothèque de type contenant l'interface source explicitement en tant que paramètres de IdispEventImpl ou utilisez le AtlGetObjectSourceInterface() pour extraire ces informations à partir de la bibliothèque de type. Utilisation de AtlGetObjectSourceInterface() nécessite que l'objet COM déclenche l'événement implémente IProvideClassInfo2 ou IPersist *:

   class CSinkObj : public IDispEventImpl<IDC_OBJ, CSinkObj>
         {
            ...
         }

   - ou -

   class CSinkObj : public IDispEventImpl<IDC_OBJ, CSinkObj,
            &DIID__EventSink, // Source interface GUID.
            &LIBID_COMOBJLib, // typelib ID containing source interface.
            1,                // Major version # of LIBID_COMOBJLib.
            0>                // Minor version # of LIBID_COMOBJLib.
         {
            ...
         }

3. Ajouter une table de récepteur à la classe ci-dessus et une entrée de récepteur correspondant à chaque événement d'une interface de source que vous souhaitez gérer. Utilisez SINK_ENTRY_EX() lorsque l'interface source est spécifié comme un paramètre dans IDispEventImpl, dans le cas contraire, utilisez SINK_ENTRY() :

   class CSinkObj : public IDispEventImpl<IDC_SRCOBJ, CSinkObj>
         {
         public:
            BEGIN_SINK_MAP(CSinkObj)
               SINK_ENTRY(IDC_SRCOBJ, 1 /*DISPID*/, OnTick /*Event Handler*/)
            END_SINK_MAP()
            ...
         }

   - ou -

   class CSinkObj : public IDispEventImpl<IDC_OBJ, CSinkObj,
                                 &DIID__EventSink, &LIBID_COMOBJLib, 1, 0>
         {
         public:
            BEGIN_SINK_MAP(CSinkObj)
               SINK_ENTRY_EX(IDC_SRCOBJ, DIID__EventSink, 1, OnTick)
            END_SINK_MAP()
            ...
         }

4. Ajouter des méthodes de gestionnaire d'événements à votre classe. Vérifiez qu'ils disposent de la convention d'appel __stdcall :

   class CSinkObj : public IDispEventImpl<IDC_SRCOBJ, CSinkObj3>
         {
         public:
            BEGIN_SINK_MAP(CSinkObj)
               SINK_ENTRY(IDC_SRCOBJ, 1 , OnTick)
            END_SINK_MAP()
   
   
            // event handler for event defined in idl as
            // [id(1)] HRESULT Tick([in] long tckcnt);
            HRESULT __stdcall OnTick(long tickcnt)
            {
               ATLTRACE("CSinkObj::OnTick\n");
               return S_OK;
            }
            ...
         }

5. Connecter le récepteur à l'objet COM en appelant DispEventAdvise(). Si l'interface source est spécifiée en tant que paramètre à IDispEventImpl puis appeler :

   // pUnk is the IUnknown pointer of the COM object that fires events.
      // pSinkObj is an instance of the CSinkObj class.
         pSinkObj->DispEventAdvise(pUnk);

   ou autre appel :

   // Make sure the COM object corresponding to pUnk implements
         // IProvideClassInfo2 or IPersist*.
         // Call this method to extract info about source type library if you
         // specified only two parameters to IdispEventImpl.
         AtlGetObjectSourceInterface(pUnk, &pSinkObj->m_libid,
            &pSinkObj->m_iid, &pSinkObj->m_wMajorVerNum,
            &pSinkObj->m_wMinorVerNum);
   
         hr = pSinkObj->DispEventAdvise(pUnk, &pSinkObj->m_iid);

6. Déconnectez le récepteur en appelant DispEventUnadvise() :

   pSinkObj->DispEventUnadvise(pUnk);

Retour au début

Étapes pour mettre en ?uvre de IDispEventSimpleImpl

1. Créez une classe dérivée à partir de IDispEventSimpleImpl. L'interface source doit être spécifié.
2. Suivez étape 3 ci-dessus, à l'exception d'Ajouter SINK_ENTRY_INFO() pour chaque méthode d'une interface de source que vous souhaitez gérer. IDispEventSimpleImpl n'ayant pas accès à la bibliothèque de type, vous devez fournir des informations sur chaque gestionnaire d'événements à une structure _ATL_FUNC_INFO, un pour chaque gestionnaire d'événements.
   
   Au lieu de préciser une structure _ATL_FUNC_INFO dans SINK_ENTRY_INFO(), vous pouvez utiliser le SINK_ENTRY_EX() macro et override la fonction virtuelle GetFuncInfoFromId() pour renseigner la _ATL_FUNC_INFO strictement, comme indiqué dans le code suivant.
3. Suivez les étapes 4 à 6 ci-dessus :

   static _ATL_FUNC_INFO OnTickInfo = {
            CC_STDCALL,   // Calling convention.
            VT_I4,        // Return type.
            1,            // Number of arguments.
            {VT_I4}       // Argument types.
         };
   
         class CSinkObj :
            public IDispEventSimpleImpl<IDC_SRCOBJ, CSinkObj,
                   &DIID__EventSink>
         {
         public:
         BEGIN_SINK_MAP(CSinkObj)
            SINK_ENTRY_INFO(IDC_SRCOBJ, DIID__EventSink, 1, OnTick,
                            &OnTickInfo)
         END_SINK_MAP()
   
            HRESULT __stdcall OnTick(long tickcnt)
            {
               ATLTRACE("CSinkObj::OnTick\n");
               return S_OK;
            }
            ...
   
         }

   - ou -

   class CSinkObj :
            public IDispEventSimpleImpl<IDC_SRCOBJ, CSinkObj,
                   &DIID__EventSink>
         {
         public:
         BEGIN_SINK_MAP(CSinkObj4)
            SINK_ENTRY_EX(IDC_SRCOBJ, DIID__EventSink, 1, OnTick)
            // Equivalent to:
            // SINK_ENTRY_INFO(IDC_SRCOBJ, DIID__EventSink, 1, OnTick, NULL)
         END_SINK_MAP()
   
            HRESULT GetFuncInfoFromId(const IID& iid, DISPID dispidMember,
               LCID lcid, _ATL_FUNC_INFO& info)
            {
               if (InlineIsEqualGUID(iid, DIID__EventSink))
               {
                  info.cc = CC_STDCALL;
                  switch(dispidMember)
                  {
                     case 1:
                        info.vtReturn = VT_I4;
                        info.nParams = 1;
                        info.pVarTypes[0] =  VT_I4;
                        return S_OK;
   
                     default:
                        return E_FAIL;
                  }
               }
               return E_FAIL;
            }
   
            HRESULT __stdcall OnTick(long tickcnt)
            {
               ATLTRACE("CSinkObj::OnTick\n");
               return S_OK;
            }
            ...
         }

Retour au début