CogImageFileCDB.AppendImageAndComment Method

CogImageFileCDB AppendImageAndComment Method

Cognex VisionPro 9.22

Append image and comment to end of file.

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

Syntax

C++

Copy to Clipboard Print

public void AppendImageAndComment(
	ICogImage newImage,
	string comment
)

public void AppendImageAndComment(
	ICogImage newImage,
	string comment
)

Public Sub AppendImageAndComment ( 
	newImage As ICogImage,
	comment As String
)

Public Sub AppendImageAndComment ( 
	newImage As ICogImage,
	comment As String
)

public:
void AppendImageAndComment(
	ICogImage^ newImage, 
	String^ comment
)

public:
void AppendImageAndComment(
	ICogImage^ newImage, 
	String^ comment
)

Parameters

newImage: Type: Cognex.VisionPro ICogImage
The CogImage to append to file.

comment: Type: System String
A comment that describes the image.

Events

Event Type	Reason
CogImageFileCDB Changed	The new image count is provided in NewValue. The following state flag may be affected:

Event Type

Reason

CogImageFileCDB Changed

The new image count is provided in NewValue.

The following state flag may be affected:

Exceptions

Exception	Condition
ArgumentException	newImage is NULL.
CogNoFileOpenException	No File is open
CogBadFileModeException	The image file is not opened in a mode that permits writing.

Remarks

Appends an image and comment to the end of an image database file. This function also appends the selected space of the image and the coordinate space tree associated with the image.