AtlEvnt.exe exemplo mostra como cria ATL coletores usando as classes ATL IDispEventImpl e IDispEventSimpleImpl

O Visual C++ 6.0

Recolher esta imagemExpandir esta imagem

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

O Visual C++ .NET

Recolher esta imagemExpandir esta imagem

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

Voltar para o início

Visão geral do projeto

   dispinterface _EventSink
   {

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

   }

				

Voltar para o início

Etapas para implementar IDispEventImpl

1. Crie uma nova classe derivada de IDispEventImpl. Você pode clicar em Nova classe no menu Inserir para gerar uma nova classe. Para cada coletor diferente, adicione uma classe IDispEventImpl à lista de herança com uma identificação exclusiva, como o primeiro parâmetro. A classe de coletor pode ser um objeto COM (como em um controle composto) ou uma classe que deriva apenas 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. Você pode especificar a identificação de interface de origem, a identificação do tipo de biblioteca, números de versão primária e secundária da biblioteca de tipo que contém a interface de origem explicitamente como parâmetros de IdispEventImpl ou usar o AtlGetObjectSourceInterface() para extrair essas informações de biblioteca de tipos. O uso de AtlGetObjectSourceInterface() requer que o objeto COM disparando o evento implementar IProvideClassInfo2 ou IPersist 1:

   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. Adicione um mapa coletor a classe acima e uma entrada de coletor correspondente a cada evento de uma interface de origem que você deseja manipular. Use SINK_ENTRY_EX() quando a interface de origem é especificada como um parâmetro em IDispEventImpl, caso contrário, use 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. Adicione métodos manipuladores de eventos à sua classe. Verifique se eles tem __stdcall convenção de chamada:

   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. Conectar-se o coletor ao objeto COM por chamada DispEventAdvise(). Se a interface de origem é especificada como um parâmetro para IDispEventImpl, em seguida, ligue para:

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

   ou outra chamada:

   // 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. Desconectar-se o coletor chamando DispEventUnadvise():

   pSinkObj->DispEventUnadvise(pUnk);

Voltar para o início

Etapas para implementar IDispEventSimpleImpl

1. Crie uma classe derivada de IDispEventSimpleImpl. Interface de origem deve ser especificado.
2. Siga etapa 3 acima, exceto adicionar SINK_ENTRY_INFO() para cada método de uma interface de origem que você deseja manipular. Como IDispEventSimpleImpl não tem acesso à biblioteca de tipos que você precise fornecer informações sobre cada manipulador de eventos por meio de uma estrutura _ATL_FUNC_INFO, um para cada manipulador de eventos.
   
   Em vez de especificar uma estrutura _ATL_FUNC_INFO no SINK_ENTRY_INFO(), você pode usar o SINK_ENTRY_EX() macro e substituição a função virtual GetFuncInfoFromId() para preencher o _ATL_FUNC_INFO estrutura, como mostra o código a seguir.
3. Execute as etapas 4 a 6 acima:

   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;
            }
            ...
         }

Voltar para o início