CogOCVMaxRunParams.GetKeysetCharacters Method (CogOCVMaxCharacterIterator)

CogOCVMaxRunParams GetKeysetCharacters Method (CogOCVMaxCharacterIterator)

Cognex VisionPro 9.5

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: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

public string GetKeysetCharacters(
	CogOCVMaxCharacterIterator pCI
)

public string GetKeysetCharacters(
	CogOCVMaxCharacterIterator pCI
)

Public Function GetKeysetCharacters ( 
	pCI As CogOCVMaxCharacterIterator
) As String

Public Function GetKeysetCharacters ( 
	pCI As CogOCVMaxCharacterIterator
) As String

public:
String^ GetKeysetCharacters(
	CogOCVMaxCharacterIterator^ pCI
)

public:
String^ GetKeysetCharacters(
	CogOCVMaxCharacterIterator^ pCI
)

Parameters

pCI: Type: Cognex.VisionPro.OCVMax CogOCVMaxCharacterIterator
A character iterator that specifies the character position 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
ObjectDisposedException	If this CogOCVMaxRunParams object has already been disposed.
ArgumentNullException	If the supplied argument is NULL.

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.