CogImageFile.DeleteImage Method

CogImageFile DeleteImage Method

Cognex VisionPro 9.8 SR1

Delete the specified image from the current open file.

Namespace: Cognex.VisionPro.ImageFile
Assembly: Cognex.VisionPro.ImageFile (in Cognex.VisionPro.ImageFile.dll) Version: 75.0.0.0

Syntax

C++

Copy to Clipboard Print

public void DeleteImage(
	int imageIndex
)

public void DeleteImage(
	int imageIndex
)

Public Sub DeleteImage ( 
	imageIndex As Integer
)

Public Sub DeleteImage ( 
	imageIndex As Integer
)

public:
void DeleteImage(
	int imageIndex
)

public:
void DeleteImage(
	int imageIndex
)

Parameters

imageIndex: Type: System Int32
The index of the image to delete.

Events

Event Type	Reason
CogImageFile Changed	The number of images in the file has changed. The following state flag may be affected:

Event Type

Reason

CogImageFile Changed

The number of images in the file has changed.

The following state flag may be affected:

Exceptions

Exception	Condition
CogNoFileOpenException	No file is open.
CogBadFileModeException	The file is not open for writing.

Remarks

Delete the specified image from the current open file. This function is equivalent to Delete( Int32 ), except that you supply a single image index as an Integer.