WorkflowControlClient.SuspendAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Begins an asynchronous suspend operation.
Overloads
| SuspendAsync(Guid, String, Object) |
Begins an asynchronous suspend operation with the specified workflow instance ID, reason, and user-defined state data. |
| SuspendAsync(Guid, String) |
Begins an asynchronous suspend operation with the specified workflow instance ID and reason. |
| SuspendAsync(Guid) |
Begins an asynchronous suspend operation. |
| SuspendAsync(Guid, Object) |
Begins an asynchronous suspend operation with the specified workflow instance ID and user-defined state data. |
SuspendAsync(Guid, String, Object)
Begins an asynchronous suspend operation with the specified workflow instance ID, reason, and user-defined state data.
public:
void SuspendAsync(Guid instanceId, System::String ^ reason, System::Object ^ userState);public void SuspendAsync (Guid instanceId, string reason, object userState);member this.SuspendAsync : Guid * string * obj -> unitPublic Sub SuspendAsync (instanceId As Guid, reason As String, userState As Object)Parameters
- instanceId
- Guid
The workflow instance to suspend.
- reason
- String
The reason to suspend the workflow instance.
- userState
- Object
The user-defined state data.
Applies to
SuspendAsync(Guid, String)
Begins an asynchronous suspend operation with the specified workflow instance ID and reason.
public:
void SuspendAsync(Guid instanceId, System::String ^ reason);public void SuspendAsync (Guid instanceId, string reason);member this.SuspendAsync : Guid * string -> unitPublic Sub SuspendAsync (instanceId As Guid, reason As String)Parameters
- instanceId
- Guid
The workflow instance to suspend.
- reason
- String
The reason to suspend the workflow instance.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Suspend(Guid, String).
Applies to
SuspendAsync(Guid)
Begins an asynchronous suspend operation.
public:
void SuspendAsync(Guid instanceId);public void SuspendAsync (Guid instanceId);member this.SuspendAsync : Guid -> unitPublic Sub SuspendAsync (instanceId As Guid)Parameters
- instanceId
- Guid
The workflow instance to suspend.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Suspend(Guid).
Applies to
SuspendAsync(Guid, Object)
Begins an asynchronous suspend operation with the specified workflow instance ID and user-defined state data.
public:
void SuspendAsync(Guid instanceId, System::Object ^ userState);public void SuspendAsync (Guid instanceId, object userState);member this.SuspendAsync : Guid * obj -> unitPublic Sub SuspendAsync (instanceId As Guid, userState As Object)Parameters
- instanceId
- Guid
The workflow instance to suspend.
- userState
- Object
The user-defined state data.
