CogOCVMaxCharacterIterator.GetDisplayCharacter Method

CogOCVMaxCharacterIterator GetDisplayCharacter Method

Cognex VisionPro 9.8

Get the character that should be displayed on a graphical user interface for the position specified by this character iterator. This is useful for character positions for which the (train time) key set has more than one value. Note that this assumes that the character keys in the font correspond to Unicode code point values.

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

Syntax

C++

Copy to Clipboard Print

public char GetDisplayCharacter()

public char GetDisplayCharacter()

Public Function GetDisplayCharacter As Char

Public Function GetDisplayCharacter As Char

public:
wchar_t GetDisplayCharacter()

public:
wchar_t GetDisplayCharacter()

Return Value

Type: Char
A System::Char. The character key identified as the display value for this character position is converted to a System::Char based upon the assumption that the character keys in the font correspond to Unicode code point values.

Exceptions

Exception	Condition
ObjectDisposedException	If the associated CogOCVMaxPattern object has already been disposed.
InvalidOperationException	If this character iterator cannot be found.