CogToolGroupBaseScript.GroupRun Method

CogToolGroupBaseScript GroupRun Method

Cognex VisionPro 9.21 SR1

Called when the tool group is run. This function should be overridden to provide custom tool group behavior in script.

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

Syntax

public virtual bool GroupRun(
	ref string message,
	ref CogToolResultConstants result
)

public virtual bool GroupRun(
	ref string message,
	ref CogToolResultConstants result
)

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

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

public:
virtual bool GroupRun(
	String^% message, 
	CogToolResultConstants% result
)

public:
virtual 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.