__event
声明事件。
__event method-declarator;
__event __interface interface-specifier;
__event member-declarator;
备注
关键字 __event 可应用于方法声明、接口声明或数据成员声明。 但是,不能使用 __event 关键字来限定嵌套类的成员。
根据您的事件源和接收器是否是本机 C++, COM,或者被管理的 (.NET Framework),可使用以下结构作为事件:
本机 C++ |
COM |
托管(.NET Framework) |
---|---|---|
方法 |
— |
方法 |
— |
interface |
— |
— |
— |
数据成员 |
请在事件接收器中使用“__挂钩”来关联处理程序方法和事件方法。 请注意,在创建一个带 __event 关键字的事件后,当调用事件时,所有事件处理程序随后挂钩到该将被调用的事件。
__event 方法声明不能具有定义;因为定义隐式生成,因此可以调用事件方法,就好像它是任一普通的方法一样。
备注
模板类或结构不能包含事件。
本机事件
本机事件是方法。 返回类型通常是 HRESULT 或 void,但可以是任何整型(包括某个 enum)。 当事件使用整数返回类型时,在事件处理程序返回非零值的情况下定义错误状态,在这种情况下,要引发的事件将调用其他委托。
// Examples of native C++ events:
__event void OnDblClick();
__event HRESULT OnClick(int* b, char* s);
有关示例代码,请参见 Event Handling in Native C++(Native C++ 中的事件处理)。
COM 事件
COM 事件是接口。 由于多播时 out 无用,事件源接口中的方法的参数应是 in 参数(但这不是严格强制的)。 如果使用 out 参数,将发布 1 级警告。
返回类型通常是 HRESULT 或 void,但可以是任何整型(包括 enum)。 当事件使用整数返回类型和事件处理程序返回非零值时,这是错误状态,在这种情况下,要引发的事件将中止对其他委托的调用。 注意该编译器会自动标记一个事件源接口为源在生成的 IDL。
__interface 关键字要求始终在 __event 后以适应 COM 事件源。
// Example of a COM event:
__event __interface IEvent1;
有代码示例,请参见 Event Handling in COM(COM 中的事件处理)。
托管事件
有关新语法中编码事件的更多信息,请参见 事件 (Visual C++)。
托管事件是数据成员或方法。 当与事件一起使用时,委托的返回类型必须符合“公共语言规范”。 事件处理程序的返回类型必须与委托的返回类型相匹配。 有关代理的更多信息,请参见 __delegate。 如果托管事件是数据成员,它必须是指向委托的指针类型。
在.NET Framework,可以将数据成员本身就当做方法(即,其对应的委托的 Invoke 方法)。 必须预定义用于声明托管事件数据成员的委托类型。 相反,如果尚未定义,则托管事件方法隐式定义对应的托管委托。 例如,可以按如下方式声明事件值(如作为事件的 OnClick):
// Examples of managed events:
__event ClickEventHandler* OnClick; // data member as event
__event void OnClick(String* s); // method as event
当隐式声明托管事件时,您可以在事件处理程序添加或移除时指定将调用的添加和移动访问器。 您还可以定义从类外部调用(引发)事件的方法。
示例:本机事件
// EventHandling_Native_Event.cpp
// compile with: /c
[event_source(native)]
class CSource {
public:
__event void MyEvent(int nValue);
};
示例:COM 事件
// EventHandling_COM_Event.cpp
// compile with: /c
#define _ATL_ATTRIBUTES 1
#include <atlbase.h>
#include <atlcom.h>
[ module(dll, name="EventSource", uuid="6E46B59E-89C3-4c15-A6D8-B8A1CEC98830") ];
[ dual, uuid("00000000-0000-0000-0000-000000000002") ]
__interface IEventSource {
[id(1)] HRESULT MyEvent();
};
[ coclass, uuid("00000000-0000-0000-0000-000000000003"), event_source(com) ]
class CSource : public IEventSource {
public:
__event __interface IEventSource;
HRESULT FireEvent() {
__raise MyEvent();
return S_OK;
}
};
示例:托管事件
// EventHandling_Managed_Event.cpp
// compile with: /clr:oldSyntax /c
using namespace System;
[event_source(managed)]
public __gc class CPSource {
public:
__event void MyEvent(Int16 nValue);
};
当将特性应用到事件时,您可以指定该属性是应用于生成的方法还是生成的委托的“调用”方法。 该默认 (event:) 需适用于事件特性。
// EventHandling_Managed_Event_2.cpp
// compile with: /clr:oldSyntax /c
using namespace System;
[attribute(All, AllowMultiple=true)]
public __gc class Attr {};
public __delegate void D();
public __gc class X {
public:
[method:Attr] __event D* E;
[returnvalue:Attr] __event void noE();
};