Skip to content

Commit e384f99

Browse files
DennisLee-DennisLeeDennisLee-DennisLee
committed
Consolidated the InvokeHelper structure.
1 parent e20e109 commit e384f99

File tree

4 files changed

+123
-205
lines changed

4 files changed

+123
-205
lines changed

‎docs/windows/invokehelper-callback-data-member.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎docs/windows/invokehelper-invoke-method.md

Lines changed: 0 additions & 100 deletions
This file was deleted.

‎docs/windows/invokehelper-invokehelper-constructor.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎docs/windows/invokehelper-structure.md

Lines changed: 123 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "InvokeHelper Structure | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "11/04/2016"
4+
ms.date: "09/21/2018"
55
ms.technology: ["cpp-windows"]
66
ms.topic: "reference"
7-
f1_keywords: ["event/Microsoft::WRL::Details::InvokeHelper"]
7+
f1_keywords: ["event/Microsoft::WRL::Details::InvokeHelper", "event/Microsoft::WRL::Details::InvokeHelper::callback_", "event/Microsoft::WRL::Details::InvokeHelper::Invoke", "event/Microsoft::WRL::Details::InvokeHelper::InvokeHelper"]
88
dev_langs: ["C++"]
9-
helpviewer_keywords: ["InvokeHelper structure"]
9+
helpviewer_keywords: ["Microsoft::WRL::Details::InvokeHelper structure", "Microsoft::WRL::Details::callback_ data member", "Microsoft::WRL::Details::Invoke method", "Microsoft::WRL::Details::InvokeHelper, constructor"]
1010
ms.assetid: 555ad2bc-4dd6-4e65-a2e2-1242c395f0e5
1111
author: "mikeblome"
1212
ms.author: "mblome"
@@ -84,7 +84,7 @@ struct InvokeHelper<TDelegateInterface, TCallback, 9> : Microsoft::WRL::RuntimeC
8484
The type of the event handler function.
8585
8686
*argCount*<br/>
87-
The number of arguments in an **InvokeHelper** specialization.
87+
The number of arguments in an `InvokeHelper` specialization.
8888
8989
## Remarks
9090
@@ -94,27 +94,27 @@ Provides an implementation of the `Invoke()` method based on the specified numbe
9494
9595
### Public Typedefs
9696
97-
|Name|Description|
98-
|----------|-----------------|
99-
|`Traits`|A synonym for the class that defines the type of each event handler argument.|
97+
Name | Description
98+
-------- | -----------------------------------------------------------------------------
99+
`Traits` | A synonym for the class that defines the type of each event handler argument.
100100
101101
### Public Constructors
102102
103-
|Name|Description|
104-
|----------|-----------------|
105-
|[InvokeHelper::InvokeHelper Constructor](../windows/invokehelper-invokehelper-constructor.md)|Initializes a new instance of the **InvokeHelper** class.|
103+
Name | Description
104+
------------------------------------------- | -------------------------------------------------------
105+
[InvokeHelper::InvokeHelper](#invokehelper) | Initializes a new instance of the `InvokeHelper` class.
106106
107107
### Public Methods
108108
109-
|Name|Description|
110-
|----------|-----------------|
111-
|[InvokeHelper::Invoke Method](../windows/invokehelper-invoke-method.md)|Calls the event handler whose signature contains the specified number of arguments.|
109+
Name | Description
110+
------------------------------- | -----------------------------------------------------------------------------------
111+
[InvokeHelper::Invoke](#invoke) | Calls the event handler whose signature contains the specified number of arguments.
112112
113113
### Public Data Members
114114
115-
|Name|Description|
116-
|----------|-----------------|
117-
|[InvokeHelper::callback_ Data Member](../windows/invokehelper-callback-data-member.md)|Represents the event handler to call when an event occurs.|
115+
Name | Description
116+
------------------------------------ | ----------------------------------------------------------
117+
[InvokeHelper::callback_](#callback) | Represents the event handler to call when an event occurs.
118118
119119
## Inheritance Hierarchy
120120
@@ -126,6 +126,111 @@ Provides an implementation of the `Invoke()` method based on the specified numbe
126126
127127
**Namespace:** Microsoft::WRL::Details
128128
129-
## See Also
129+
## <a name="callback"></a>InvokeHelper::callback_
130130
131-
[Microsoft::WRL::Details Namespace](../windows/microsoft-wrl-details-namespace.md)
131+
Supports the WRL infrastructure and is not intended to be used directly from your code.
132+
133+
```cpp
134+
TCallback callback_;
135+
```
136+
137+
### Remarks
138+
139+
Represents the event handler to call when an event occurs.
140+
141+
The `TCallback` template parameter specifies the type of the event handler.
142+
143+
## <a name="invoke"></a>InvokeHelper::Invoke
144+
145+
Supports the WRL infrastructure and is not intended to be used directly from your code.
146+
147+
```cpp
148+
STDMETHOD(
149+
Invoke
150+
)();
151+
STDMETHOD(
152+
Invoke
153+
)(typename Traits;
154+
STDMETHOD(
155+
Invoke
156+
)( typename Traits;
157+
STDMETHOD(
158+
Invoke
159+
)( typename Traits;
160+
STDMETHOD(
161+
Invoke
162+
)( typename Traits;
163+
STDMETHOD(
164+
Invoke
165+
)( typename Traits;
166+
STDMETHOD(
167+
Invoke
168+
)( typename Traits;
169+
STDMETHOD(
170+
Invoke
171+
)( typename Traits;
172+
STDMETHOD(
173+
Invoke
174+
)( typename Traits;
175+
STDMETHOD(
176+
Invoke
177+
)( typename Traits;
178+
```
179+
180+
### Parameters
181+
182+
*arg1*<br/>
183+
Argument 1.
184+
185+
*arg2*<br/>
186+
Argument 2.
187+
188+
*arg3*<br/>
189+
Argument 3.
190+
191+
*arg4*<br/>
192+
Argument 4.
193+
194+
*arg5*<br/>
195+
Argument 5.
196+
197+
*arg6*<br/>
198+
Argument 6.
199+
200+
*arg7*<br/>
201+
Argument 7.
202+
203+
*arg8*<br/>
204+
Argument 8.
205+
206+
*arg9*<br/>
207+
Argument 9.
208+
209+
### Return Value
210+
211+
S_OK if successful; otherwise, an HRESULT that describes the error.
212+
213+
### Remarks
214+
215+
Calls the event handler whose signature contains the specified number of arguments.
216+
217+
## <a name="invokehelper"></a>InvokeHelper::InvokeHelper
218+
219+
Supports the WRL infrastructure and is not intended to be used directly from your code.
220+
221+
```cpp
222+
explicit InvokeHelper(
223+
TCallback callback
224+
);
225+
```
226+
227+
### Parameters
228+
229+
*callback*<br/>
230+
An event handler.
231+
232+
### Remarks
233+
234+
Initializes a new instance of the `InvokeHelper` class.
235+
236+
The `TCallback` template parameter specifies the type of the event handler.

0 commit comments

Comments
 (0)