ICogImageFileProvider.Delete Method

ICogImageFileProvider Delete Method

Cognex VisionPro

Delete the specified images from the current open file.

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

Syntax

C++

Copy to Clipboard Print

void Delete(
	int[] imageIndices
)

void Delete(
	int[] imageIndices
)

Sub Delete ( 
	imageIndices As Integer()
)

Sub Delete ( 
	imageIndices As Integer()
)

void Delete(
	array<int>^ imageIndices
)

void Delete(
	array<int>^ imageIndices
)

Parameters

imageIndices: Type: System Int32
The image indices to delete.

Events

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

Event Type

Reason

CogImageFileProviderChanged

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 images from the current open file. You specify the images to delete by supplying a dynamic array containing the indices of the images to delete.

The storage space occupied by the deleted images is reclaimed.