CogToolBlockAdvancedScriptBase.GroupRun Method

CogToolBlockAdvancedScriptBase GroupRun Method

Cognex VisionPro 9.10

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

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

Syntax

C++

Copy to Clipboard Print

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
)

Parameters

message: Type: System String
Result message for the tool block.

result: Type: Cognex.VisionPro CogToolResultConstants
Result value for the tool block.

Return Value

Type: Boolean
True if VisionPro should run the tool block as it normally would, False if VisionPro should not run the tool block because the script is running the tools.

Implements

ICogToolGroupScript GroupRun(String , CogToolResultConstants )