-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
WorkflowApplicationUnhandledExceptionEventArgs.xml
159 lines (135 loc) · 11.2 KB
/
WorkflowApplicationUnhandledExceptionEventArgs.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
<Type Name="WorkflowApplicationUnhandledExceptionEventArgs" FullName="System.Activities.WorkflowApplicationUnhandledExceptionEventArgs">
<TypeSignature Language="C#" Value="public class WorkflowApplicationUnhandledExceptionEventArgs : System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WorkflowApplicationUnhandledExceptionEventArgs extends System.Activities.WorkflowApplicationEventArgs" />
<TypeSignature Language="DocId" Value="T:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class WorkflowApplicationUnhandledExceptionEventArgs
Inherits WorkflowApplicationEventArgs" />
<TypeSignature Language="F#" Value="type WorkflowApplicationUnhandledExceptionEventArgs = class
 inherit WorkflowApplicationEventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class WorkflowApplicationUnhandledExceptionEventArgs : System::Activities::WorkflowApplicationEventArgs" />
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Activities.WorkflowApplicationEventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides information about an unhandled exception that occurred in a workflow instance.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If an exception is thrown by an activity and is unhandled, the default behavior is to terminate the workflow instance. If an <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is present, it can override this default behavior. This handler gives the workflow host author an opportunity to provide the appropriate handling, such as custom logging, aborting the workflow, canceling the workflow, or terminating the workflow.
## Examples
The following example invokes a workflow that throws an exception. The exception is unhandled by the workflow and the <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is invoked. The <xref:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs> are inspected to provide information about the exception, and the workflow is terminated.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="ExceptionSource">
<MemberSignature Language="C#" Value="public System.Activities.Activity ExceptionSource { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Activities.Activity ExceptionSource" />
<MemberSignature Language="DocId" Value="P:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.ExceptionSource" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExceptionSource As Activity" />
<MemberSignature Language="F#" Value="member this.ExceptionSource : System.Activities.Activity" Usage="System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.ExceptionSource" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Activities::Activity ^ ExceptionSource { System::Activities::Activity ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.Activities.Activity</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the activity that is the source of the unhandled exception.</summary>
<value>An activity.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If an exception is thrown by an activity and is unhandled, the default behavior is to terminate the workflow instance. If an <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is present, it can override this default behavior. This handler gives the workflow host author an opportunity to provide the appropriate handling, such as custom logging, aborting the workflow, canceling the workflow, or terminating the workflow.
## Examples
The following example invokes a workflow that throws an exception. The exception is unhandled by the workflow and the <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is invoked. The <xref:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs> are inspected to provide information about the exception, and the workflow is terminated.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ExceptionSourceInstanceId">
<MemberSignature Language="C#" Value="public string ExceptionSourceInstanceId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ExceptionSourceInstanceId" />
<MemberSignature Language="DocId" Value="P:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.ExceptionSourceInstanceId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ExceptionSourceInstanceId As String" />
<MemberSignature Language="F#" Value="member this.ExceptionSourceInstanceId : string" Usage="System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.ExceptionSourceInstanceId" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ExceptionSourceInstanceId { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the unique identifier of the activity instance that is the source of the unhandled exception.</summary>
<value>An identifier of the activity instance that is the source of the unhandled exception.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If an exception is thrown by an activity and is unhandled, the default behavior is to terminate the workflow instance. If an <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is present, it can override this default behavior. This handler gives the workflow host author an opportunity to provide the appropriate handling, such as custom logging, aborting the workflow, canceling the workflow, or terminating the workflow.
## Examples
The following example invokes a workflow that throws an exception. The exception is unhandled by the workflow and the <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is invoked. The <xref:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs> are inspected to provide information about the exception, and the workflow is terminated.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="UnhandledException">
<MemberSignature Language="C#" Value="public Exception UnhandledException { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Exception UnhandledException" />
<MemberSignature Language="DocId" Value="P:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.UnhandledException" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UnhandledException As Exception" />
<MemberSignature Language="F#" Value="member this.UnhandledException : Exception" Usage="System.Activities.WorkflowApplicationUnhandledExceptionEventArgs.UnhandledException" />
<MemberSignature Language="C++ CLI" Value="public:
 property Exception ^ UnhandledException { Exception ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Activities</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.Exception</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Exception" /> that was unhandled by the workflow instance.</summary>
<value>The <see cref="T:System.Exception" /> that was unhandled by the workflow instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If an exception is thrown by an activity and is unhandled, the default behavior is to terminate the workflow instance. If an <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is present, it can override this default behavior. This handler gives the workflow host author an opportunity to provide the appropriate handling, such as custom logging, aborting the workflow, canceling the workflow, or terminating the workflow.
## Examples
The following example invokes a workflow that throws an exception. The exception is unhandled by the workflow and the <xref:System.Activities.WorkflowApplication.OnUnhandledException%2A> handler is invoked. The <xref:System.Activities.WorkflowApplicationUnhandledExceptionEventArgs> are inspected to provide information about the exception, and the workflow is terminated.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/cfx_workflowapplicationexample/cs/program.cs" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>