-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
Parallel.xml
308 lines (288 loc) · 20.2 KB
/
Parallel.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<Type Name="Parallel" FullName="System.Activities.Statements.Parallel">
<TypeSignature Language="C#" Value="public sealed class Parallel : System.Activities.NativeActivity" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Parallel extends System.Activities.NativeActivity" />
<TypeSignature Language="DocId" Value="T:System.Activities.Statements.Parallel" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Parallel
Inherits NativeActivity" />
<TypeSignature Language="F#" Value="type Parallel = class
 inherit NativeActivity" />
<TypeSignature Language="C++ CLI" Value="public ref class Parallel sealed : System::Activities::NativeActivity" />
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Activities.NativeActivity</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Windows.Markup.ContentProperty("Branches")]</AttributeName>
<AttributeName Language="F#">[<System.Windows.Markup.ContentProperty("Branches")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>An activity that executes all child activities simultaneously and asynchronously.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A <xref:System.Activities.Statements.Parallel> activity operates by simultaneously scheduling each <xref:System.Activities.Activity> in its <xref:System.Activities.Statements.Parallel.Branches%2A> collection at the start. It completes when all of its <xref:System.Activities.Statements.Parallel.Branches%2A> complete or when its <xref:System.Activities.Statements.Parallel.CompletionCondition%2A> property evaluates to `true`. While all the <xref:System.Activities.Activity> objects run asynchronously, they do not execute on separate threads, so each successive activity only executes when the previously scheduled activity completes or goes idle. If none of the child activities of this activity go idle, this activity execute in the same way that a <xref:System.Activities.Statements.Sequence> activity does.
## Examples
The following code sample demonstrates creating a <xref:System.Activities.Statements.Parallel> activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfs_compensationcancellation/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Parallel ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 Parallel();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Creates a new instance of the <see cref="T:System.Activities.Statements.Parallel" /> activity.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code sample demonstrates creating a <xref:System.Activities.Statements.Parallel> activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfs_compensationcancellation/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Branches">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<System.Activities.Activity> Branches { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class System.Activities.Activity> Branches" />
<MemberSignature Language="DocId" Value="P:System.Activities.Statements.Parallel.Branches" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Branches As Collection(Of Activity)" />
<MemberSignature Language="F#" Value="member this.Branches : System.Collections.ObjectModel.Collection<System.Activities.Activity>" Usage="System.Activities.Statements.Parallel.Branches" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<System::Activities::Activity ^> ^ Branches { System::Collections::ObjectModel::Collection<System::Activities::Activity ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Windows.Markup.DependsOn("CompletionCondition")]</AttributeName>
<AttributeName Language="F#">[<System.Windows.Markup.DependsOn("CompletionCondition")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.Activities.Activity></ReturnType>
</ReturnValue>
<Docs>
<summary>The child elements to be executed in parallel.</summary>
<value>The elements.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code sample demonstrates setting the Branches property of a <xref:System.Activities.Statements.Parallel> activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfs_compensationcancellation/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CacheMetadata">
<MemberSignature Language="C#" Value="protected override void CacheMetadata (System.Activities.NativeActivityMetadata metadata);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void CacheMetadata(valuetype System.Activities.NativeActivityMetadata metadata) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.CacheMetadata(System.Activities.NativeActivityMetadata)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub CacheMetadata (metadata As NativeActivityMetadata)" />
<MemberSignature Language="F#" Value="override this.CacheMetadata : System.Activities.NativeActivityMetadata -> unit" Usage="parallel.CacheMetadata metadata" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void CacheMetadata(System::Activities::NativeActivityMetadata metadata);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.NativeActivityMetadata" />
</Parameters>
<Docs>
<param name="metadata">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Cancel">
<MemberSignature Language="C#" Value="protected override void Cancel (System.Activities.NativeActivityContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Cancel(class System.Activities.NativeActivityContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.Cancel(System.Activities.NativeActivityContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Cancel (context As NativeActivityContext)" />
<MemberSignature Language="F#" Value="override this.Cancel : System.Activities.NativeActivityContext -> unit" Usage="parallel.Cancel context" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void Cancel(System::Activities::NativeActivityContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.NativeActivityContext" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CompletionCondition">
<MemberSignature Language="C#" Value="public System.Activities.Activity<bool> CompletionCondition { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Activities.Activity`1<bool> CompletionCondition" />
<MemberSignature Language="DocId" Value="P:System.Activities.Statements.Parallel.CompletionCondition" />
<MemberSignature Language="VB.NET" Value="Public Property CompletionCondition As Activity(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.CompletionCondition : System.Activities.Activity<bool> with get, set" Usage="System.Activities.Statements.Parallel.CompletionCondition" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Activities::Activity<bool> ^ CompletionCondition { System::Activities::Activity<bool> ^ get(); void set(System::Activities::Activity<bool> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(null)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Windows.Markup.DependsOn("Variables")]</AttributeName>
<AttributeName Language="F#">[<System.Windows.Markup.DependsOn("Variables")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Activities.Activity<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>Evaluates after any branch completes.</summary>
<value>The completion expression.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If this property evaluates to `true`, then the other scheduled elements in the <xref:System.Activities.Statements.Parallel.Branches%2A> collection are canceled. If this property is not set, all <xref:System.Activities.Activity> objects in the <xref:System.Activities.Statements.Parallel.Branches%2A> collection execute until completion.
## Examples
The following code sample demonstrates setting the CompletionCondition property of a <xref:System.Activities.Statements.Parallel> activity.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/wfs_compensationcancellation/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Execute">
<MemberSignature Language="C#" Value="protected override void Execute (System.Activities.NativeActivityContext context);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Execute(class System.Activities.NativeActivityContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.Execute(System.Activities.NativeActivityContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Execute (context As NativeActivityContext)" />
<MemberSignature Language="F#" Value="override this.Execute : System.Activities.NativeActivityContext -> unit" Usage="parallel.Execute context" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void Execute(System::Activities::NativeActivityContext ^ context);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Activities.NativeActivityContext" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnCreateDynamicUpdateMap">
<MemberSignature Language="C#" Value="protected override void OnCreateDynamicUpdateMap (System.Activities.DynamicUpdate.NativeActivityUpdateMapMetadata metadata, System.Activities.Activity originalActivity);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnCreateDynamicUpdateMap(class System.Activities.DynamicUpdate.NativeActivityUpdateMapMetadata metadata, class System.Activities.Activity originalActivity) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.OnCreateDynamicUpdateMap(System.Activities.DynamicUpdate.NativeActivityUpdateMapMetadata,System.Activities.Activity)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub OnCreateDynamicUpdateMap (metadata As NativeActivityUpdateMapMetadata, originalActivity As Activity)" />
<MemberSignature Language="F#" Value="override this.OnCreateDynamicUpdateMap : System.Activities.DynamicUpdate.NativeActivityUpdateMapMetadata * System.Activities.Activity -> unit" Usage="parallel.OnCreateDynamicUpdateMap (metadata, originalActivity)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void OnCreateDynamicUpdateMap(System::Activities::DynamicUpdate::NativeActivityUpdateMapMetadata ^ metadata, System::Activities::Activity ^ originalActivity);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="metadata" Type="System.Activities.DynamicUpdate.NativeActivityUpdateMapMetadata" Index="0" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<Parameter Name="originalActivity" Type="System.Activities.Activity" Index="1" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</Parameters>
<Docs>
<param name="metadata">To be added.</param>
<param name="originalActivity">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UpdateInstance">
<MemberSignature Language="C#" Value="protected override void UpdateInstance (System.Activities.DynamicUpdate.NativeActivityUpdateContext updateContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void UpdateInstance(class System.Activities.DynamicUpdate.NativeActivityUpdateContext updateContext) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Activities.Statements.Parallel.UpdateInstance(System.Activities.DynamicUpdate.NativeActivityUpdateContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub UpdateInstance (updateContext As NativeActivityUpdateContext)" />
<MemberSignature Language="F#" Value="override this.UpdateInstance : System.Activities.DynamicUpdate.NativeActivityUpdateContext -> unit" Usage="parallel.UpdateInstance updateContext" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void UpdateInstance(System::Activities::DynamicUpdate::NativeActivityUpdateContext ^ updateContext);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="updateContext" Type="System.Activities.DynamicUpdate.NativeActivityUpdateContext" Index="0" FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</Parameters>
<Docs>
<param name="updateContext">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Variables">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection<System.Activities.Variable> Variables { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1<class System.Activities.Variable> Variables" />
<MemberSignature Language="DocId" Value="P:System.Activities.Statements.Parallel.Variables" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Variables As Collection(Of Variable)" />
<MemberSignature Language="F#" Value="member this.Variables : System.Collections.ObjectModel.Collection<System.Activities.Variable>" Usage="System.Activities.Statements.Parallel.Variables" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::ObjectModel::Collection<System::Activities::Variable ^> ^ Variables { System::Collections::ObjectModel::Collection<System::Activities::Variable ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.Collection<System.Activities.Variable></ReturnType>
</ReturnValue>
<Docs>
<summary>The collection of contained variables.</summary>
<value>The contained variables.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>