CogImageFileCDB.ReadComment Method

CogImageFileCDB ReadComment Method

Cognex VisionPro 9.22

Read the comment at the given index.

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

Syntax

public string ReadComment(
	int imageIndex
)

public string ReadComment(
	int imageIndex
)

Public Function ReadComment ( 
	imageIndex As Integer
) As String

Public Function ReadComment ( 
	imageIndex As Integer
) As String

public:
String^ ReadComment(
	int imageIndex
)

public:
String^ ReadComment(
	int imageIndex
)

Type: String

The image comment.

Exceptions

Exception	Condition
ArgumentException	The value supplied for imageIndex is out of range

Remarks

Reads the comment at the given image collection index.