CogJob.Image Method (Int32, Boolean)

CogJob Image Method (Int32, Boolean)

Cognex VisionPro

Image(int,bool) allows any image to be looked at and/or removed from the image queue. Care must be taken to not remove images from the image queue if the CogJob is running image processing.

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

Syntax

C++

Copy to Clipboard Print

public ICogImage Image(
	int index,
	bool removeImage
)

public ICogImage Image(
	int index,
	bool removeImage
)

Public Function Image ( 
	index As Integer,
	removeImage As Boolean
) As ICogImage

Public Function Image ( 
	index As Integer,
	removeImage As Boolean
) As ICogImage

public:
ICogImage^ Image(
	int index, 
	bool removeImage
)

public:
ICogImage^ Image(
	int index, 
	bool removeImage
)

Parameters

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

removeImage: Type: System Boolean
If this boolean is true, then the specified image will be removed from the image queue. If false, then just a reference to the image is returned without removing it from the image queue.

Return Value

Type: ICogImage
A reference to an ICogImage

Events

Event Type	Reason
CogJob ImageRemoved	Fires when an image is removed from the image queue.

Exceptions

Exception	Condition
CogQueueEmptyException	Thrown if the image queue is empty.