Edit

Share via


TerminateActivity.Error Property

Definition

Gets or sets an error message to report to administrators, providing the reason for termination.

public:
 property System::String ^ Error { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.Browsable(true)]
public string Error { get; set; }
[<System.ComponentModel.Browsable(true)>]
member this.Error : string with get, set
Public Property Error As String

Property Value

An error message that provides the reason for the workflow instance termination. The default value is null.

Attributes

Examples

The following example demonstrates setting the Error property. This example is from the Suspend and Terminate SDK sample. For more information, see Suspend and Terminate Sample.

this.terminate.Error = null;
Me.terminate.Error = Nothing

Remarks

If this property is set when the activity is in runtime mode (the DesignMode property is set to false) a ReadOnlyException is thrown.

Propagation of this error message is determined by the host (the instance manager or the persistence provider).

Applies to