CogJobManager.UserResult Method (Int32, Boolean)

CogJobManager UserResult Method (Int32, Boolean)

Cognex VisionPro 9.5

UserResult(int,bool) allows any result packet to be looked at and/or removed from the user queue.

Namespace: Cognex.VisionPro.QuickBuild
Assembly: Cognex.VisionPro.QuickBuild.Core (in Cognex.VisionPro.QuickBuild.Core.dll) Version: 69.0.0.0 (69.0.0.0)

Syntax

C++

Copy to Clipboard Print

public ICogRecord UserResult(
	int index,
	bool removeResult
)

public ICogRecord UserResult(
	int index,
	bool removeResult
)

Public Function UserResult ( 
	index As Integer,
	removeResult As Boolean
) As ICogRecord

Public Function UserResult ( 
	index As Integer,
	removeResult As Boolean
) As ICogRecord

public:
ICogRecord^ UserResult(
	int index, 
	bool removeResult
)

public:
ICogRecord^ UserResult(
	int index, 
	bool removeResult
)

Parameters

index: Type: System Int32
The index of the result packet to be retrieved from the user queue. The oldest packet is at index 0.

removeResult: Type: System Boolean
If this boolean is true, then the specified result packet is removed from the user queue. If false, then just a reference to the result packet is returned without removing it from the user queue.

Return Value

Type: ICogRecord
A reference to an ICogRecord which contains results.

Events

Event Type	Reason
CogJobIndependentUserResultRemoved	Fires when a result package is removed from the user queue.

Exceptions

Exception	Condition
CogQueueEmptyException	Thrown if the user queue is empty.

Remarks

Examples