Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

DISP_PROPERTY_PARAM

Visual Studio 2010

Defines a property accessed with separate Get and Set member functions.

Copy 
DISP_PROPERTY_PARAM(theClass, pszExternalName, pfnGet, pfnSet, vtPropType, vtsParams )
theClass

Name of the class.

pszExternalName

External name of the property.

pfnGet

Name of the member function used to get the property.

pfnSet

Name of the member function used to set the property.

vtPropType

A value specifying the property's type.

vtsParams

A string of space-separated VTS_ variant parameter types, one for each parameter.

Unlike the DISP_PROPERTY_EX macro, this macro allows you to specify a parameter list for the property. This is useful for implementing properties that are indexed or parameterized.

Consider the following declaration of get and set member functions that allow the user to request a specific row and column when accessing the property:

C++
Copy 

SHORT GetArray(SHORT row, SHORT column);
void SetArray(SHORT row, SHORT column, SHORT newVal);

These correspond to the following DISP_PROPERTY_PARAM macro in the control dispatch map:

C++
Copy 

DISP_PROPERTY_PARAM(CMFCActiveXControlCtrl, "Array", GetArray, SetArray, VT_I2, VTS_I2 VTS_I2 )

As another example, consider the following get and set member functions:

C++
Copy 

IDispatch* GetItem(SHORT index1, SHORT index2, SHORT index3);
void SetItem(SHORT index1, SHORT index2, SHORT index3, IDispatch* pVal);

These correspond to the following DISP_PROPERTY_PARAM macro in the control dispatch map:

C++
Copy 

DISP_PROPERTY_PARAM(CMFCActiveXControlCtrl, "Item", GetItem, SetItem, VT_DISPATCH, VTS_I2 VTS_I2 VTS_I2)

Header: afxdisp.h

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