CogVisionDataFileCDB.ReadComment Method

CogVisionDataFileCDB ReadComment Method

Cognex VisionPro 9.24

Gets the comment associated with the specified record index.

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

Syntax

public string ReadComment(
	int index
)

public string ReadComment(
	int index
)

Public Function ReadComment ( 
	index As Integer
) As String

Public Function ReadComment ( 
	index As Integer
) As String

public:
String^ ReadComment(
	int index
)

public:
String^ ReadComment(
	int index
)

index: Type: System Int32
The index of the ICogVisionData whose comment to get.

Type: String

Exceptions

Exception	Condition
ArgumentOutOfRangeException	index is out of range.
[T:Cognex.VisionPro.Exceptions.CogNoFileOpenException>]	The file is not open.
ObjectDisposedException	This CDB file has been disposed.