Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
We recommend using Visual Studio 2017

EVENT_CUSTOM

 

Defines an event-map entry for a custom event.


EVENT_CUSTOM(
pszName
, 
pfnFire
, 
vtsParams )

pszName

The name of the event.

pfnFire

The name of the event firing function.

vtsParams

A space-separated list of one or more constants specifying the function's parameter list.

The vtsParams parameter 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:

VTS_COLOR VTS_FONT

specifies a list containing a 32-bit integer representing an RGB color value, followed by a pointer to the IFontDisp interface of an OLE font object.

The VTS_ constants and their meanings are as follows:

Symbol

Parameter type

VTS_I2

short

VTS_I4

long

VTS_R4

float

VTS_R8

double

VTS_COLOR

OLE_COLOR

VTS_CY

CURRENCY

VTS_DATE

DATE

VTS_BSTR

const char*

VTS_DISPATCH

LPDISPATCH

VTS_FONT

IFontDispatch*

VTS_HANDLE

HANDLE

VTS_SCODE

SCODE

VTS_BOOL

BOOL

VTS_VARIANT

const VARIANT*

VTS_PVARIANT

VARIANT*

VTS_UNKNOWN

LPUNKNOWN

VTS_OPTEXCLUSIVE

OLE_OPTEXCLUSIVE

VTS_PICTURE

IPictureDisp*

VTS_TRISTATE

OLE_TRISTATE

VTS_XPOS_PIXELS

OLE_XPOS_PIXELS

VTS_YPOS_PIXELS

OLE_YPOS_PIXELS

VTS_XSIZE_PIXELS

OLE_XSIZE_PIXELS

VTS_YSIZE_PIXELS

OLE_YSIZE_PIXELS

VTS_XPOS_HIMETRIC

OLE_XPOS_HIMETRIC

VTS_YPOS_HIMETRIC

OLE_YPOS_HIMETRIC

VTS_XSIZE_HIMETRIC

OLE_XSIZE_HIMETRIC

VTS_YSIZE_HIMETRIC

OLE_YSIZE_HIMETRIC

System_CAPS_noteNote

Additional variant constants have been defined for all variant types, with the exception of VTS_FONT and VTS_PICTURE, that provide a pointer to the variant data constant. These constants are named using the VTS_Pconstantname convention. For example, VTS_PCOLOR is a pointer to a VTS_COLOR constant.

Requirements

Header: afxctl.h

Show: