WorkflowInstanceManager.GetInstances Method (Int32, Int32, String, WorkflowInstanceStatus, array<String[])
Returns the collection of workflow instances with specified skip value, count, workflow status, workflow name and activation metadata filter.
Namespace: Microsoft.Workflow.Client
Assembly: Microsoft.Workflow.Client (in Microsoft.Workflow.Client.dll)
Syntax
'Declaration
Public Function GetInstances ( _
skip As Integer, _
count As Integer, _
workflowName As String, _
workflowStatus As WorkflowInstanceStatus, _
ParamArray activationMetadataFilter As String() _
) As Collection(Of WorkflowInstanceInfo)
'Usage
Dim instance As WorkflowInstanceManager
Dim skip As Integer
Dim count As Integer
Dim workflowName As String
Dim workflowStatus As WorkflowInstanceStatus
Dim activationMetadataFilter As String()
Dim returnValue As Collection(Of WorkflowInstanceInfo)
returnValue = instance.GetInstances(skip, _
count, workflowName, workflowStatus, _
activationMetadataFilter)
public Collection<WorkflowInstanceInfo> GetInstances(
int skip,
int count,
string workflowName,
WorkflowInstanceStatus workflowStatus,
params string[] activationMetadataFilter
)
public:
Collection<WorkflowInstanceInfo^>^ GetInstances(
int skip,
int count,
String^ workflowName,
WorkflowInstanceStatus workflowStatus,
... array<String^>^ activationMetadataFilter
)
member GetInstances :
skip:int *
count:int *
workflowName:string *
workflowStatus:WorkflowInstanceStatus *
activationMetadataFilter:string[] -> Collection<WorkflowInstanceInfo>
public function GetInstances(
skip : int,
count : int,
workflowName : String,
workflowStatus : WorkflowInstanceStatus,
... activationMetadataFilter : String[]
) : Collection<WorkflowInstanceInfo>
Parameters
- skip
Type: System.Int32
The number of workflow instances to skip.
- count
Type: System.Int32
The 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: array<System.String[]
The collection of metadata that filters the workflow instances to be retrieved.
Return Value
Type: System.Collections.ObjectModel.Collection<WorkflowInstanceInfo>
The collection of workflow instances.