Share via


WorkflowManager.Delete Method

 

Deletes workflows in the current scope.

Namespace:   Microsoft.Workflow.Client
Assembly:  Microsoft.Workflow.Client (in Microsoft.Workflow.Client.dll)

Overload List

Name Description
System_CAPS_pubmethod Delete()

Deletes all workflows in the current scope wihout terminating existing instances.

System_CAPS_pubmethod Delete(IDictionary<String, String>)

Deletes all workflows in a scope with matching metadataFilter wihout terminating existing instances.

System_CAPS_pubmethod Delete(IDictionary<String, String>, Boolean)

Deletes all workflows in a scope with matching metadataFilter.

System_CAPS_pubmethod Delete(String)

Deletes specified workflow wihout terminating existing instances.

System_CAPS_pubmethod Delete(String, Boolean)

Deletes specified workflow.

See Also

WorkflowManager Class
Microsoft.Workflow.Client Namespace

Return to top

WorkflowManager.Delete Method ()

Deletes all workflows in the current scope wihout terminating existing instances.

Syntax

public int Delete()
public:
int Delete()
member Delete : unit -> int
Public Function Delete As Integer

Return Value

Type: System.Int32

Number of deleted workflows.

Return to top

WorkflowManager.Delete Method (IDictionary<String, String>)

Deletes all workflows in a scope with matching metadataFilter wihout terminating existing instances.

Syntax

public int Delete(
    IDictionary<string, string> metadataFilter
)
public:
int Delete(
    IDictionary<String^, String^>^ metadataFilter
)
member Delete : 
        metadataFilter:IDictionary<string, string> -> int
Public Function Delete (
    metadataFilter As IDictionary(Of String, String)
) As Integer

Parameters

Return Value

Type: System.Int32

Number of deleted workflows.

Return to top

WorkflowManager.Delete Method (IDictionary<String, String>, Boolean)

Deletes all workflows in a scope with matching metadataFilter.

Syntax

public int Delete(
    IDictionary<string, string> metadataFilter,
    bool terminateActiveInstances
)
public:
int Delete(
    IDictionary<String^, String^>^ metadataFilter,
    bool terminateActiveInstances
)
member Delete : 
        metadataFilter:IDictionary<string, string> *
        terminateActiveInstances:bool -> int
Public Function Delete (
    metadataFilter As IDictionary(Of String, String),
    terminateActiveInstances As Boolean
) As Integer

Parameters

  • terminateActiveInstances
    Type: System.Boolean

    true if all existing instances of deleted workflows should be terminated; false if existing instances of deleted workflows should continue execution.

Return Value

Type: System.Int32

Number of deleted workflows.

Return to top

WorkflowManager.Delete Method (String)

Deletes specified workflow wihout terminating existing instances.

Syntax

public void Delete(
    string workflowName
)
public:
void Delete(
    String^ workflowName
)
member Delete : 
        workflowName:string -> unit
Public Sub Delete (
    workflowName As String
)

Parameters

  • workflowName
    Type: System.String

    Name of the workflow to be deleted.

Return to top

WorkflowManager.Delete Method (String, Boolean)

Deletes specified workflow.

Syntax

public void Delete(
    string workflowName,
    bool terminateActiveInstances
)
public:
void Delete(
    String^ workflowName,
    bool terminateActiveInstances
)
member Delete : 
        workflowName:string *
        terminateActiveInstances:bool -> unit
Public Sub Delete (
    workflowName As String,
    terminateActiveInstances As Boolean
)

Parameters

  • workflowName
    Type: System.String

    Name of the workflow to be deleted.

  • terminateActiveInstances
    Type: System.Boolean

    true if all existing instances of deleted workflows should be terminated; false if existing instances of deleted workflows should continue execution.

Return to top