Singer Instruments PIXL Client
RunRandomColonyPickingWorkflow(String,String,String,Int32,RunRandomColonyPickingWorkflowResponseCallback) Method
Example 



SI.PIXL.Client Namespace > PIXLClient Class > RunRandomColonyPickingWorkflow Method : RunRandomColonyPickingWorkflow(String,String,String,Int32,RunRandomColonyPickingWorkflowResponseCallback) Method
The workflow's ID.
The name of the project template to use. If this is empty the last used settings will be used.
The name of the pinning profile to use. If this is not specified the profile from the workflow will be used.
A limit to apply to the number of source colonies that are picked. If no limit is desired specify PIXLClient.NoColonyLimit.
A callback to invoke when the command has finished execution.
Run the Random Colony Picking workflow using a specified project template, pinning profile and target layout start position.
Syntax
'Declaration
 
Public Overloads Function RunRandomColonyPickingWorkflow( _
   ByVal id As String, _
   ByVal projectTemplateName As String, _
   ByVal pinningProfileName As String, _
   ByVal sourceColonyLimit As Integer, _
   ByVal callback As RunRandomColonyPickingWorkflowResponseCallback _
) As Task
'Usage
 
Dim instance As PIXLClient
Dim id As String
Dim projectTemplateName As String
Dim pinningProfileName As String
Dim sourceColonyLimit As Integer
Dim callback As RunRandomColonyPickingWorkflowResponseCallback
Dim value As Task
 
value = instance.RunRandomColonyPickingWorkflow(id, projectTemplateName, pinningProfileName, sourceColonyLimit, callback)

Parameters

id
The workflow's ID.
projectTemplateName
The name of the project template to use. If this is empty the last used settings will be used.
pinningProfileName
The name of the pinning profile to use. If this is not specified the profile from the workflow will be used.
sourceColonyLimit
A limit to apply to the number of source colonies that are picked. If no limit is desired specify PIXLClient.NoColonyLimit.
callback
A callback to invoke when the command has finished execution.

Return Value

The result of the action.
Example
This sample shows how to use the RunRandomColonyPickingWorkflow(String,String,String,Int32,RunRandomColonyPickingWorkflowResponseCallback) method.
// Run the Random Colony Picking workflow with the last used project template and pinning profile, limiting to 5 source colonies and display the result on the Console.
pixl.RunRandomColonyPickingWorkflow("1234", string.Empty, string.Empty, 5, x => Console.WriteLine(x.Result.Message));
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

PIXLClient Class
PIXLClient Members
Overload List