CogOCVMaxRunParams.GetKeysetCharacters Method (Int32, Int32, Int32)

CogOCVMaxRunParams GetKeysetCharacters Method (Int32, Int32, Int32)

Cognex VisionPro

Gets a string that corresponds to the key set for the specified character position within the specified line within the specified paragraph. Each individual character in this string may occur at this position.

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

Syntax

C++

Copy to Clipboard Print

public string GetKeysetCharacters(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

public string GetKeysetCharacters(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

Public Function GetKeysetCharacters ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As String

Public Function GetKeysetCharacters ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As String

public:
String^ GetKeysetCharacters(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition
)

public:
String^ GetKeysetCharacters(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition
)

Parameters

paragraphPosition: Type: System Int32
A zero-based index that specifies the position of the paragraph of interest.

linePosition: Type: System Int32
A zero-based index that specifies the position of the line of interest within the paragraph of interest.

characterPosition: Type: System Int32
A zero-based index that specifies the position of the character of interest within the line of interest within the paragraph of interest.

Return Value

Type: String
A string in which each character corresponds to a member of the key set for this position.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	If the paragraphPosition argument is less than zero or greater than or equal to the number of paragraphs described in this CogOCVMaxRunParams object.
ObjectDisposedException	If this CogOCVMaxRunParams object has already been disposed.

Remarks

Any one of the characters in the returned string may be observed at the specified position. Note that this method assumes that the character keys in this font correspond to Unicode code point values.