Skip to content

connection-point-macros.md

Latest commit

 

History

History
96 lines (60 loc) · 3.63 KB

connection-point-macros.md

File metadata and controls

96 lines (60 loc) · 3.63 KB
Raw
title Connection Point Macros
ms.date 11/04/2016
f1_keywords
atlcom/ATL::BEGIN_CONNECTION_POINT_MAP
atlcom/ATL::END_CONNECTION_POINT_MAP
helpviewer_keywords
connection points [C++], macros
ms.assetid cc3a6dd3-5538-45df-b027-1f34963c31e5

Connection Point Macros

These macros define connection point maps and entries.

Macro Description
BEGIN_CONNECTION_POINT_MAP Marks the beginning of the connection point map entries.
CONNECTION_POINT_ENTRY Enters connection points into the map.
CONNECTION_POINT_ENTRY_P (Visual Studio 2017) Similar to CONNECTION_POINT_ENTRY but takes a pointer to iid.
END_CONNECTION_POINT_MAP Marks the end of the connection point map entries.

Requirements

Header: atlcom.h

BEGIN_CONNECTION_POINT_MAP

Marks the beginning of the connection point map entries.

BEGIN_CONNECTION_POINT_MAP(x)

Parameters

x
[in] The name of the class containing the connection points.

Remarks

Start your connection point map with the BEGIN_CONNECTION_POINT_MAP macro, add entries for each of your connection points with the CONNECTION_POINT_ENTRY macro, and complete the map with the END_CONNECTION_POINT_MAP macro.

For more information about connection points in ATL, see the article Connection Points.

Example

[!code-cppNVC_ATL_Windowing#101]

CONNECTION_POINT_ENTRY and CONNECTION_POINT_ENTRY_P

Enters a connection point for the specified interface into the connection point map so that it can be accessed.

CONNECTION_POINT_ENTRY(iid)
CONNECTION_POINT_ENTRY_P(piid) // (Visual Studio 2017)

Parameters

iid
[in] The GUID of the interface being added to the connection point map.

piid
[in] Pointer to the GUID of the interface being adde.

Remarks

Connection point entries in the map are used by IConnectionPointContainerImpl. The class containing the connection point map must inherit from IConnectionPointContainerImpl.

Start your connection point map with the BEGIN_CONNECTION_POINT_MAP macro, add entries for each of your connection points with the CONNECTION_POINT_ENTRY macro, and complete the map with the END_CONNECTION_POINT_MAP macro.

For more information about connection points in ATL, see the article Connection Points.

Example

[!code-cppNVC_ATL_Windowing#120]

END_CONNECTION_POINT_MAP

Marks the end of the connection point map entries.

END_CONNECTION_POINT_MAP()

Remarks

Start your connection point map with the BEGIN_CONNECTION_POINT_MAP macro, add entries for each of your connection points with the CONNECTION_POINT_ENTRY macro, and complete the map with the END_CONNECTION_POINT_MAP macro.

For more information about connection points in ATL, see the article Connection Points.

Example

[!code-cppNVC_ATL_Windowing#128]

See also

Macros
Connection Point Global Functions