CogUserTool.DefineScriptTerminal Method (Object, String, Boolean)

CogUserTool DefineScriptTerminal Method (Object, String, Boolean)

Cognex VisionPro 9.21

Called from a script's initialize() funciton to define a tool group terminal associated with the script.

Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.ToolGroup (in Cognex.VisionPro.ToolGroup.dll) Version: 83.0.0.0 (83.0.0.0)

Syntax

C++

Copy to Clipboard Print

public virtual bool DefineScriptTerminal(
	Object obj,
	string key,
	bool isInput
)

public virtual bool DefineScriptTerminal(
	Object obj,
	string key,
	bool isInput
)

Public Overridable Function DefineScriptTerminal ( 
	obj As Object,
	key As String,
	isInput As Boolean
) As Boolean

Public Overridable Function DefineScriptTerminal ( 
	obj As Object,
	key As String,
	isInput As Boolean
) As Boolean

public:
virtual bool DefineScriptTerminal(
	Object^ obj, 
	String^ key, 
	bool isInput
)

public:
virtual bool DefineScriptTerminal(
	Object^ obj, 
	String^ key, 
	bool isInput
)

Parameters

obj: Type: System Object
An object which provides the initial contents of the terminal, and is also used to determine the type of data which is stored in the terminal.

key: Type: System String
A key value used to identify the terminal when setting or getting terminal data, also used as the name of the teriminal in the GUI.

isInput: Type: System Boolean
True to define an input terminal, False to define an output terminal.

Return Value

Type: Boolean
True if the terminal was successfully created.