Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 2 rated this helpful - Rate this topic

ON_EVENT

Visual Studio 2010

Use the ON_EVENT macro to define an event handler function for an event fired by an OLE control.

Copy 
ON_EVENT(theClass, id, dispid, pfnHandler, vtsParams )
theClass

The class to which this event sink map belongs.

id

The control ID of the OLE control.

dispid

The dispatch ID of the event fired by the control.

pfnHandler

Pointer to a member function that handles the event. This function should have a BOOL return type, and parameter types that match the event's parameters (see vtsParams). The function should return TRUE to indicate the event was handled; otherwise FALSE.

vtsParams

A sequence of VTS_ constants that specifies the types of the parameters for the event. These are the same constants that are used in dispatch map entries such as DISP_FUNCTION.

The vtsParams argument is a space-separated list of values from the VTS_ constants. One or more of these values separated by spaces (not commas) specifies the function's parameter list. For example:

C++
Copy 

VTS_I2 VTS_BOOL

specifies a list containing a short integer followed by a BOOL.

For a list of the VTS_ constants, see EVENT_CUSTOM.

Header: afxdisp.h

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ