CogOCVMaxRunParams.GetKeysetCharacterKeys Method (Int32, Int32, Int32)

CogOCVMaxRunParams GetKeysetCharacterKeys Method (Int32, Int32, Int32)

Cognex VisionPro

Gets an array of integers that correspond to the key set for the specified character position within the specified line within the specified paragraph. Each element of this array is the key value of a character that 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 int[] GetKeysetCharacterKeys(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

public int[] GetKeysetCharacterKeys(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

Public Function GetKeysetCharacterKeys ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As Integer()

Public Function GetKeysetCharacterKeys ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As Integer()

public:
array<int>^ GetKeysetCharacterKeys(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition
)

public:
array<int>^ GetKeysetCharacterKeys(
	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: Int32
An array of integers that correspond to the key set for the specified character position within the specified line within the specified paragraph. The size of this array matches the number of different possible characters that may occur at this position.

Exceptions

Exception	Condition
ObjectDisposedException	If this CogOCVMaxRunParams object has already been disposed.
ArgumentOutOfRangeException	If the linePosition argument is less than zero or greater than or equal to the number of lines in the specified paragraph as described in this CogOCVMaxRunParams object.