You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/atl/reference/idispeventimpl-class.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,26 +31,26 @@ class ATL_NO_VTABLE IDispEventImpl : public IDispEventSimpleImpl<nID, T, pdiid>
31
31
```
32
32
33
33
#### Parameters
34
-
`nID`
34
+
*nID*
35
35
A unique identifier for the source object. When `IDispEventImpl` is the base class for a composite control, use the resource ID of the desired contained control for this parameter. In other cases, use an arbitrary positive integer.
36
36
37
-
`T`
37
+
*T*
38
38
The user's class, which is derived from `IDispEventImpl`.
39
39
40
-
`pdiid`
41
-
The pointer to the IID of the event dispinterface implemented by this class. This interface must be defined in the type library denoted by `plibid`, `wMajor`, and `wMinor`.
40
+
*pdiid*
41
+
The pointer to the IID of the event dispinterface implemented by this class. This interface must be defined in the type library denoted by *plibid*, *wMajor*, and *wMinor*.
42
42
43
-
`plibid`
44
-
A pointer to the type library that defines the dispatch interface pointed to by `pdiid`. If **&GUID_NULL**, the type library will be loaded from the object sourcing the events.
43
+
*plibid*
44
+
A pointer to the type library that defines the dispatch interface pointed to by *pdiid*. If **&GUID_NULL**, the type library will be loaded from the object sourcing the events.
45
45
46
-
`wMajor`
46
+
*wMajor*
47
47
The major version of the type library. The default value is 0.
48
48
49
-
`wMinor`
49
+
*wMinor*
50
50
The minor version of the type library. The default value is 0.
51
51
52
-
`tihclass`
53
-
The class used to manage the type information for `T`. The default value is a class of type `CComTypeInfoHolder`; however, you can override this template parameter by providing a class of a type other than `CComTypeInfoHolder`.
52
+
*tihclass*
53
+
The class used to manage the type information for *T*. The default value is a class of type `CComTypeInfoHolder`; however, you can override this template parameter by providing a class of a type other than `CComTypeInfoHolder`.
54
54
55
55
## Members
56
56
@@ -85,12 +85,12 @@ class ATL_NO_VTABLE IDispEventImpl : public IDispEventSimpleImpl<nID, T, pdiid>
85
85
Add a [SINK_ENTRY](composite-control-macros.md#sink_entry) or [SINK_ENTRY_EX](composite-control-macros.md#sink_entry_ex) macro to the event sink map for each event on each object that you want to handle. When using `IDispEventImpl` as a base class of a composite control, you can call [AtlAdviseSinkMap](connection-point-global-functions.md#atladvisesinkmap) to establish and break the connection with the event sources for all entries in the event sink map. In other cases, or for greater control, call [DispEventAdvise](idispeventsimpleimpl-class.md#dispeventadvise) to establish the connection between the source object and the base class. Call [DispEventUnadvise](idispeventsimpleimpl-class.md#dispeventunadvise) to break the connection.
86
86
87
87
88
-
You must derive from `IDispEventImpl` (using a unique value for `nID`) for each object for which you need to handle events. You can reuse the base class by unadvising against one source object then advising against a different source object, but the maximum number of source objects that can be handled by a single object at one time is limited by the number of `IDispEventImpl` base classes.
88
+
You must derive from `IDispEventImpl` (using a unique value for *nID*) for each object for which you need to handle events. You can reuse the base class by unadvising against one source object then advising against a different source object, but the maximum number of source objects that can be handled by a single object at one time is limited by the number of `IDispEventImpl` base classes.
89
89
90
90
`IDispEventImpl` provides the same functionality as [IDispEventSimpleImpl](../../atl/reference/idispeventsimpleimpl-class.md), except it gets type information about the interface from a type library rather than having it supplied as a pointer to an [_ATL_FUNC_INFO](../../atl/reference/atl-func-info-structure.md) structure. Use `IDispEventSimpleImpl` when you do not have a type library describing the event interface or want to avoid the overhead associated with using the type library.
91
91
92
92
> [!NOTE]
93
-
> `IDispEventImpl` and `IDispEventSimpleImpl` provide their own implementation of **IUnknown::QueryInterface** enabling each `IDispEventImpl` and `IDispEventSimpleImpl` base class to act as a separate COM identity while still allowing direct access to class members in your main COM object.
93
+
> `IDispEventImpl` and `IDispEventSimpleImpl` provide their own implementation of `IUnknown::QueryInterface` enabling each `IDispEventImpl` and `IDispEventSimpleImpl` base class to act as a separate COM identity while still allowing direct access to class members in your main COM object.
94
94
95
95
CE ATL implementation of ActiveX event sinks only supports return values of type HRESULT or void from your event handler methods; any other return value is unsupported and its behavior is undefined.
96
96
@@ -120,20 +120,20 @@ HRESULT GetFuncInfoFromId(
120
120
```
121
121
122
122
### Parameters
123
-
`iid`
123
+
*iid*
124
124
[in] A reference to the ID of the function.
125
125
126
126
*dispidMember*
127
127
[in] The dispatch ID of the function.
128
128
129
-
`lcid`
129
+
*lcid*
130
130
[in] The locale context of the function ID.
131
131
132
-
`info`
132
+
*info*
133
133
[in] The structure indicating how the function is called.
Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs, which can be used on subsequent calls to [IDispatch::Invoke](http://msdn.microsoft.com/en-us/964ade8e-9d8a-4d32-bd47-aa678912a54d).
@@ -182,7 +182,7 @@ VARTYPE GetUserDefinedType(
182
182
```
183
183
184
184
### Parameters
185
-
`pTI`
185
+
*pTI*
186
186
[in] A pointer to the [ITypeInfo](http://msdn.microsoft.com/en-us/f3356463-3373-4279-bae1-953378aa2680) interface containing the user-defined type.
187
187
188
188
*hrt*
@@ -195,14 +195,14 @@ VARTYPE GetUserDefinedType(
195
195
See [ITypeInfo::GetRefTypeInfo](http://msdn.microsoft.com/en-us/61d3b31d-6591-4e55-9e82-5246a168be00).
Copy file name to clipboardExpand all lines: docs/atl/reference/idispeventsimpleimpl-class.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,13 +26,13 @@ class ATL_NO_VTABLE IDispEventSimpleImpl : public _IDispEventLocator<nID, pdiid>
26
26
```
27
27
28
28
#### Parameters
29
-
`nID`
29
+
*nID*
30
30
A unique identifier for the source object. When `IDispEventSimpleImpl` is the base class for a composite control, use the resource ID of the desired contained control for this parameter. In other cases, use an arbitrary positive integer.
31
31
32
-
`T`
32
+
*T*
33
33
The user's class, which is derived from `IDispEventSimpleImpl`.
34
34
35
-
`pdiid`
35
+
*pdiid*
36
36
The pointer to the IID of the event dispinterface implemented by this class.
37
37
38
38
## Members
@@ -44,9 +44,9 @@ class ATL_NO_VTABLE IDispEventSimpleImpl : public _IDispEventLocator<nID, pdiid>
44
44
|[IDispEventSimpleImpl::Advise](#advise)|Establishes a connection with the default event source.|
45
45
|[IDispEventSimpleImpl::DispEventAdvise](#dispeventadvise)|Establishes a connection with the event source.|
46
46
|[IDispEventSimpleImpl::DispEventUnadvise](#dispeventunadvise)|Breaks the connection with the event source.|
|[IDispEventSimpleImpl::Invoke](#invoke)|Calls the event handlers listed in the event sink map.|
51
51
|[IDispEventSimpleImpl::Unadvise](#unadvise)|Breaks the connection with the default event source.|
52
52
@@ -63,12 +63,12 @@ class ATL_NO_VTABLE IDispEventSimpleImpl : public _IDispEventLocator<nID, pdiid>
63
63
64
64
- Call [DispEventUnadvise](#dispeventunadvise) to break the connection.
65
65
66
-
You must derive from `IDispEventSimpleImpl` (using a unique value for `nID`) for each object for which you need to handle events. You can reuse the base class by unadvising against one source object then advising against a different source object, but the maximum number of source objects that can be handled by a single object at one time is limited by the number of `IDispEventSimpleImpl` base classes.
66
+
You must derive from `IDispEventSimpleImpl` (using a unique value for *nID*) for each object for which you need to handle events. You can reuse the base class by unadvising against one source object then advising against a different source object, but the maximum number of source objects that can be handled by a single object at one time is limited by the number of `IDispEventSimpleImpl` base classes.
67
67
68
-
**IDispEventSimplImpl** provides the same functionality as [IDispEventImpl](../../atl/reference/idispeventimpl-class.md), except it does not get type information about the interface from a type library. The wizards generate code based only on `IDispEventImpl`, but you can use `IDispEventSimpleImpl` by adding the code by hand. Use `IDispEventSimpleImpl` when you don't have a type library describing the event interface or want to avoid the overhead associated with using the type library.
68
+
`IDispEventSimplImpl` provides the same functionality as [IDispEventImpl](../../atl/reference/idispeventimpl-class.md), except it does not get type information about the interface from a type library. The wizards generate code based only on `IDispEventImpl`, but you can use `IDispEventSimpleImpl` by adding the code by hand. Use `IDispEventSimpleImpl` when you don't have a type library describing the event interface or want to avoid the overhead associated with using the type library.
69
69
70
70
> [!NOTE]
71
-
> `IDispEventImpl` and `IDispEventSimpleImpl` provide their own implementation of **IUnknown::QueryInterface** enabling each `IDispEventImpl` or `IDispEventSimpleImpl` base class to act as a separate COM identity while still allowing direct access to class members in your main COM object.
71
+
> `IDispEventImpl` and `IDispEventSimpleImpl` provide their own implementation of `IUnknown::QueryInterface` enabling each `IDispEventImpl` or `IDispEventSimpleImpl` base class to act as a separate COM identity while still allowing direct access to class members in your main COM object.
72
72
73
73
CE ATL implementation of ActiveX event sinks only supports return values of type HRESULT or void from your event handler methods; any other return value is unsupported and its behavior is undefined.
`Unadvise` breaks a connection that was established with the default event source specified in `pdiid`.
236
236
237
-
**Unavise** breaks a connection with the default event source, it gets the IID of the default event source of the object as determined by [AtlGetObjectSourceInterface](composite-control-global-functions.md#atlgetobjectsourceinterface).
237
+
`Unavise` breaks a connection with the default event source, it gets the IID of the default event source of the object as determined by [AtlGetObjectSourceInterface](composite-control-global-functions.md#atlgetobjectsourceinterface).
> The links in the following table are to the INet SDK reference topics for the members of the [IDocUIHostHandler](https://msdn.microsoft.com/library/aa753260.aspx) interface. `IDocHostUIHandlerDispatch` has the same functionality as **IDocUIHostHandler**, with the difference being that `IDocHostUIHandlerDispatch` is a dispinterface whereas **IDocUIHostHandler** is a custom interface.
32
+
> The links in the following table are to the INet SDK reference topics for the members of the [IDocUIHostHandler](https://msdn.microsoft.com/library/aa753260.aspx) interface. `IDocHostUIHandlerDispatch` has the same functionality as `IDocUIHostHandler`, with the difference being that `IDocHostUIHandlerDispatch` is a dispinterface whereas `IDocUIHostHandler` is a custom interface.
0 commit comments