COM でのイベント処理

  • [アーティクル]

COM でのイベント処理では、event_source 属性と event_receiver 属性を使用して type=com を指定し、イベント ソースとイベント レシーバーをそれぞれ設定します。 これらの属性は、カスタム インターフェイス、ディスパッチ インターフェイス、デュアル インターフェイス用に適切なコードを挿入します。 挿入されたコードを使用すると、属性付きクラスでイベントを発生し、COM 接続ポイントを介してイベントを処理できます。

Note

ネイティブ C++ のイベント属性は、標準 C++ と互換性がありません。 この属性は、/permissive- 準拠モードを指定するとコンパイルされません。

イベントの宣言

イベント ソース クラスでは、インターフェイス宣言で __event キーワードを使用して、インターフェイスのメソッドをイベントとして宣言します。 このインターフェイスのイベントは、インターフェイス メソッドとして呼び出されたときに発生します。 イベント インターフェイス上のメソッドは、ゼロ個以上のパラメーターを持つことができます (すべて in パラメーターである必要があります)。 戻り値の型は void または任意の整数型です。

イベント ハンドラーの定義

イベント レシーバー クラスのイベント ハンドラーを定義します。 イベント ハンドラーは、処理するイベントに一致するシグネチャ (戻り値の型、呼び出し規則、引数) を持つメソッドです。 COM イベントの場合、呼び出し規約が一致する必要はありません。 詳細については、以下の「レイアウトに依存する COM イベント」を参照してください。

イベントへのイベント ハンドラーのフック

また、イベント レシーバー クラスでは、組み込み関数 __hook を使用してイベントをイベント ハンドラーと関連付け、__unhook を使用してイベント ハンドラーからイベントを分離します。 複数のイベントを 1 つのイベント ハンドラーにフックすることも、複数のイベント ハンドラーを 1 つのイベントにフックすることもできます。

Note

通常、COM イベント レシーバーからイベント ソース インターフェイス定義へのアクセスを許可するには、2 つの方法があります。 最初の方法は、次に示すように、共通のヘッダー ファイルを共有することです。 2 番目の方法は、属性が生成されたコードを保持したままイベント ソース タイプ ライブラリが .tlh ファイルに書き込まれるように、embedded_idl インポート修飾子と共に #import を使用することです。

イベントの発生

イベントを発生させるには、イベント ソース クラスで __event キーワードを使用して宣言されたインターフェイスのメソッドを呼び出します。 ハンドラーがイベントにフックされている場合は、ハンドラーが呼び出されます。

COM イベント コード

次の例に、COM クラスでイベントを発生させる方法を示します。 例をコンパイルして実行するには、コード内のコメントを参照してください。

// evh_server.h
#pragma once

[ dual, uuid("00000000-0000-0000-0000-000000000001") ]
__interface IEvents {
   [id(1)] HRESULT MyEvent([in] int value);
};

[ dual, uuid("00000000-0000-0000-0000-000000000002") ]
__interface IEventSource {
   [id(1)] HRESULT FireEvent();
};

class DECLSPEC_UUID("530DF3AD-6936-3214-A83B-27B63C7997C4") CSource;

次は、サーバーです。

// evh_server.cpp
// compile with: /LD
// post-build command: Regsvr32.exe /s evh_server.dll
#define _ATL_ATTRIBUTES 1
#include <atlbase.h>
#include <atlcom.h>
#include "evh_server.h"

[ module(dll, name="EventSource", uuid="6E46B59E-89C3-4c15-A6D8-B8A1CEC98830") ];

[coclass, event_source(com), uuid("530DF3AD-6936-3214-A83B-27B63C7997C4")]
class CSource : public IEventSource {
public:
   __event __interface IEvents;

   HRESULT FireEvent() {
      __raise MyEvent(123);
      return S_OK;
   }
};

次は、クライアントです。

// evh_client.cpp
// compile with: /link /OPT:NOREF
#define _ATL_ATTRIBUTES 1
#include <atlbase.h>
#include <atlcom.h>
#include <stdio.h>
#include "evh_server.h"

[ module(name="EventReceiver") ];

[ event_receiver(com) ]
class CReceiver {
public:
   HRESULT MyHandler1(int nValue) {
      printf_s("MyHandler1 was called with value %d.\n", nValue);
      return S_OK;
   }

   HRESULT MyHandler2(int nValue) {
      printf_s("MyHandler2 was called with value %d.\n", nValue);
      return S_OK;
   }

   void HookEvent(IEventSource* pSource) {
      __hook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler1);
      __hook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler2);
   }

   void UnhookEvent(IEventSource* pSource) {
      __unhook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler1);
      __unhook(&IEvents::MyEvent, pSource, &CReceiver::MyHandler2);
   }
};

int main() {
   // Create COM object
   CoInitialize(NULL);
   {
      IEventSource* pSource = 0;
      HRESULT hr = CoCreateInstance(__uuidof(CSource), NULL,         CLSCTX_ALL, __uuidof(IEventSource), (void **) &pSource);
      if (FAILED(hr)) {
         return -1;
      }

      // Create receiver and fire event
      CReceiver receiver;
      receiver.HookEvent(pSource);
      pSource->FireEvent();
      receiver.UnhookEvent(pSource);
   }
   CoUninitialize();
   return 0;
}

出力

MyHandler1 was called with value 123.
MyHandler2 was called with value 123.

レイアウト依存の COM イベント

レイアウトの依存関係は、COM プログラミングにおいてのみ考慮する項目です。 ネイティブおよびマネージド イベント処理では、ハンドラーのシグネチャ (戻り値の型、呼び出し規則、引数) がイベントと一致する必要がありますが、ハンドラー名はイベントと一致する必要はありません。

ただし、COM のイベント処理では、event_receiver の layout_dependent パラメーターを true に設定すると、名前とシグネチャの一致が適用されます。 イベント レシーバーとフックされたイベント内のハンドラーの名前とシグネチャは、完全に一致する必要があります。

layout_dependent を false に設定すると、呼び出し規則とストレージ クラス (virtual、static など) を組み合わせて、イベント生成メソッドとフック メソッド (デリゲート) を一致させることができます。 layout_dependent=true を使用する方がやや効率的です。

たとえば、次のメソッドを持つ IEventSource が定義されているとします。

[id(1)] HRESULT MyEvent1([in] int value);
[id(2)] HRESULT MyEvent2([in] int value);

イベント ソースが次の形式になっているとします。

[coclass, event_source(com)]
class CSource : public IEventSource {
public:
   __event __interface IEvents;

   HRESULT FireEvent() {
      MyEvent1(123);
      MyEvent2(123);
      return S_OK;
   }
};

そこで、イベント レシーバーでは、次のように、IEventSource のメソッドにフックされるハンドラーは名前およびシグネチャを一致させる必要があります。

[coclass, event_receiver(com, true)]
class CReceiver {
public:
   HRESULT MyEvent1(int nValue) {  // name and signature matches MyEvent1
      ...
   }
   HRESULT MyEvent2(E c, char* pc) {  // signature doesn't match MyEvent2
      ...
   }
   HRESULT MyHandler1(int nValue) {  // name doesn't match MyEvent1 (or 2)
      ...
   }
   void HookEvent(IEventSource* pSource) {
      __hook(IFace, pSource);  // Hooks up all name-matched events
                               // under layout_dependent = true
      __hook(&IFace::MyEvent1, pSource, &CReceive::MyEvent1);   // valid
      __hook(&IFace::MyEvent2, pSource, &CSink::MyEvent2);   // not valid
      __hook(&IFace::MyEvent1, pSource, &CSink:: MyHandler1); // not valid
   }
};

関連項目

イベント処理