CogJobManager.FailureItem Method (Int32, Boolean)

CogJobManager FailureItem Method (Int32, Boolean)

Cognex VisionPro 9.21

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

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

Syntax

C++

Copy to Clipboard Print

public ICogRecord FailureItem(
	int index,
	bool removeItem
)

public ICogRecord FailureItem(
	int index,
	bool removeItem
)

Public Function FailureItem ( 
	index As Integer,
	removeItem As Boolean
) As ICogRecord

Public Function FailureItem ( 
	index As Integer,
	removeItem As Boolean
) As ICogRecord

public:
ICogRecord^ FailureItem(
	int index, 
	bool removeItem
)

public:
ICogRecord^ FailureItem(
	int index, 
	bool removeItem
)

Parameters

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

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

Return Value

Type: ICogRecord
A reference to an ICogRecord which contains a failure image.

Events

Event Type	Reason
CogJobIndependentFailureItemRemoved	Fires when a result package is removed from the failure queue.

Exceptions

Exception	Condition
CogQueueEmptyException	Thrown if the failure queue is empty.

Remarks

Examples