InstanceManager.Get Method

 

Retrieves information about workflow instances.

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

Overload List

	Name	Description
	Get()	Retrieves information about all workflow instances in the current scope.
	Get(Int32, Int32)	Retrieves information about workflow instances in the current scope through paging.
	Get(Int32, Int32, String)	Retrieves through paging information about workflow instances of a specific worklow.
	Get(Int32, Int32, String, WorkflowInstanceStatus)	Retrieves through paging information about workflow instances of specified workflow and in specified state.
	Get(Int32, Int32, String, WorkflowInstanceStatus, IDictionary<String, String>)	Retrieves through paging information about workflow instances that meet specifed criteria.
	Get(Int32, Int32, WorkflowInstanceStatus, IDictionary<String, String>)	Retrieves through paging information about workflow instances that meet specifed criteria.
	Get(String, String)	Retrieves information about a specific workflow instance.

See Also

InstanceManager Class
Microsoft.Workflow.Client Namespace

Return to top

InstanceManager.Get Method ()

Retrieves information about all workflow instances in the current scope.

Syntax

public Collection<WorkflowInstanceInfo> Get()

public:
Collection<WorkflowInstanceInfo^>^ Get()

member Get : unit -> Collection<WorkflowInstanceInfo>

Public Function Get As Collection(Of WorkflowInstanceInfo)

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Return to top

InstanceManager.Get Method (Int32, Int32)

Retrieves information about workflow instances in the current scope through paging.

Syntax

public Collection<WorkflowInstanceInfo> Get(
    int skip,
    int count
)

public:
Collection<WorkflowInstanceInfo^>^ Get(
    int skip,
    int count
)

member Get : 
        skip:int *
        count:int -> Collection<WorkflowInstanceInfo>

Public Function Get (
    skip As Integer,
    count As Integer
) As Collection(Of WorkflowInstanceInfo)

Parameters

• skip
  Type: System.Int32

  Number of workflow instances to skip.

• count
  Type: System.Int32

  Number of workflow instances to retrieve.

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Return to top

InstanceManager.Get Method (Int32, Int32, String)

Retrieves through paging information about workflow instances of a specific worklow.

Syntax

public Collection<WorkflowInstanceInfo> Get(
    int skip,
    int count,
    string workflowName
)

public:
Collection<WorkflowInstanceInfo^>^ Get(
    int skip,
    int count,
    String^ workflowName
)

member Get : 
        skip:int *
        count:int *
        workflowName:string -> Collection<WorkflowInstanceInfo>

Public Function Get (
    skip As Integer,
    count As Integer,
    workflowName As String
) As Collection(Of WorkflowInstanceInfo)

Parameters

• skip
  Type: System.Int32

  Number of workflow instances to skip.

• count
  Type: System.Int32

  Number of workflow instances to retrieve.

• workflowName
  Type: System.String

  The name of the workflow to which the instances belongs.

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Return to top

InstanceManager.Get Method (Int32, Int32, String, WorkflowInstanceStatus)

Retrieves through paging information about workflow instances of specified workflow and in specified state.

Syntax

public Collection<WorkflowInstanceInfo> Get(
    int skip,
    int count,
    string workflowName,
    WorkflowInstanceStatus workflowStatus
)

public:
Collection<WorkflowInstanceInfo^>^ Get(
    int skip,
    int count,
    String^ workflowName,
    WorkflowInstanceStatus workflowStatus
)

member Get : 
        skip:int *
        count:int *
        workflowName:string *
        workflowStatus:WorkflowInstanceStatus -> Collection<WorkflowInstanceInfo>

Public Function Get (
    skip As Integer,
    count As Integer,
    workflowName As String,
    workflowStatus As WorkflowInstanceStatus
) As Collection(Of WorkflowInstanceInfo)

Parameters

• skip
  Type: System.Int32

  Number of workflow instances to skip.

• count
  Type: System.Int32

  Number of workflow instances to retrieve.

• workflowName
  Type: System.String

  The name of the workflow to which the instances belongs.

• workflowStatus
  Type: Microsoft.Activities.WorkflowInstanceStatus

  The status of workflow instances to retrieve.

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Return to top

InstanceManager.Get Method (Int32, Int32, String, WorkflowInstanceStatus, IDictionary<String, String>)

Retrieves through paging information about workflow instances that meet specifed criteria.

Syntax

public Collection<WorkflowInstanceInfo> Get(
    int skip,
    int count,
    string workflowName,
    WorkflowInstanceStatus workflowStatus,
    IDictionary<string, string> activationMetadataFilter
)

public:
Collection<WorkflowInstanceInfo^>^ Get(
    int skip,
    int count,
    String^ workflowName,
    WorkflowInstanceStatus workflowStatus,
    IDictionary<String^, String^>^ activationMetadataFilter
)

member Get : 
        skip:int *
        count:int *
        workflowName:string *
        workflowStatus:WorkflowInstanceStatus *
        activationMetadataFilter:IDictionary<string, string> -> Collection<WorkflowInstanceInfo>

Public Function Get (
    skip As Integer,
    count As Integer,
    workflowName As String,
    workflowStatus As WorkflowInstanceStatus,
    activationMetadataFilter As IDictionary(Of String, String)
) As Collection(Of WorkflowInstanceInfo)

Parameters

• skip
  Type: System.Int32

  Number of workflow instances to skip.

• count
  Type: System.Int32

  Number of workflow instances to retrieve.

• workflowName
  Type: System.String

  The name of the workflow to which the instances belongs.

• workflowStatus
  Type: Microsoft.Activities.WorkflowInstanceStatus

  The status of workflow instances to retrieve.

• activationMetadataFilter
  Type: System.Collections.Generic.IDictionary<String, String>

  Collection of metadata that filters the workflow instances to be retrieved.

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Remarks

If activationMetadataFilter is not null and not empty then only workflow instances that has all matching activation metada will be retrieved.

Return to top

InstanceManager.Get Method (Int32, Int32, WorkflowInstanceStatus, IDictionary<String, String>)

Retrieves through paging information about workflow instances that meet specifed criteria.

Syntax

public Collection<WorkflowInstanceInfo> Get(
    int skip,
    int count,
    WorkflowInstanceStatus workflowStatus,
    IDictionary<string, string> activationMetadataFilter
)

public:
Collection<WorkflowInstanceInfo^>^ Get(
    int skip,
    int count,
    WorkflowInstanceStatus workflowStatus,
    IDictionary<String^, String^>^ activationMetadataFilter
)

member Get : 
        skip:int *
        count:int *
        workflowStatus:WorkflowInstanceStatus *
        activationMetadataFilter:IDictionary<string, string> -> Collection<WorkflowInstanceInfo>

Public Function Get (
    skip As Integer,
    count As Integer,
    workflowStatus As WorkflowInstanceStatus,
    activationMetadataFilter As IDictionary(Of String, String)
) As Collection(Of WorkflowInstanceInfo)

Parameters

• skip
  Type: System.Int32

  Number of workflow instances to skip.

• count
  Type: System.Int32

  Number of workflow instances to retrieve.

• workflowStatus
  Type: Microsoft.Activities.WorkflowInstanceStatus

  The status of workflow instances to retrieve.

• activationMetadataFilter
  Type: System.Collections.Generic.IDictionary<String, String>

  Collection of metadata that filters the workflow instances to be retrieved.

Return Value

Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Remarks

If activationMetadataFilter is not null and not empty then only workflow instances that has all matching activation metada will be retrieved.

Return to top

InstanceManager.Get Method (String, String)

Retrieves information about a specific workflow instance.

Syntax

public WorkflowInstanceInfo Get(
    string workflowName,
    string instanceName
)

public:
WorkflowInstanceInfo^ Get(
    String^ workflowName,
    String^ instanceName
)

member Get : 
        workflowName:string *
        instanceName:string -> WorkflowInstanceInfo

Public Function Get (
    workflowName As String,
    instanceName As String
) As WorkflowInstanceInfo

Parameters

• workflowName
  Type: System.String

  The name of the workflow to which the instance belongs.

• instanceName
  Type: System.String

  The name of the workflow instance to be retrieved.

Return Value

Type: Microsoft.Workflow.Client.WorkflowInstanceInfo

A collection of WorkflowInstanceInfo objects representing the retrieved workflow instances.

Return to top