ICogToolGroupScript.GroupRun Method

ICogToolGroupScript GroupRun Method

Cognex VisionPro 9.20

Called when the tool group is run.

Namespace: Cognex.VisionPro.ToolGroup
Assembly: Cognex.VisionPro.ToolGroup (in Cognex.VisionPro.ToolGroup.dll) Version: 80.0.0.0 (80.0.0.0)

Syntax

bool GroupRun(
	ref string message,
	ref CogToolResultConstants result
)

bool GroupRun(
	ref string message,
	ref CogToolResultConstants result
)

Function GroupRun ( 
	ByRef message As String,
	ByRef result As CogToolResultConstants
) As Boolean

Function GroupRun ( 
	ByRef message As String,
	ByRef result As CogToolResultConstants
) As Boolean

bool GroupRun(
	String^% message, 
	CogToolResultConstants% result
)

bool GroupRun(
	String^% message, 
	CogToolResultConstants% result
)

message: Type: System String
Result message for the tool group. Should be used as an argument when calling RunTool in script. Can also be overwritten with a script specific result message.

result: Type: Cognex.VisionPro CogToolResultConstants
Result value for the tool group. Should be used as an argument when calling RunTool from script. Can also be overwritten if the script "calculates" the final result.

Type: Boolean
True if VisionPro should run the tool group, False if VisionPro should not run the tool group because the script is running the tools.