CogOCRMaxTool.UnknownCharacterMarker Property

CogOCRMaxTool UnknownCharacterMarker Property

Cognex VisionPro

A string which will be used to identify the unknown character code in result strings generated by this tool.

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

Syntax

C++

Copy to Clipboard Print

public string UnknownCharacterMarker { get; set; }

public string UnknownCharacterMarker { get; set; }

Public Property UnknownCharacterMarker As String 
	Get 
	Set

Public Property UnknownCharacterMarker As String 
	Get 
	Set

public:
property String^ UnknownCharacterMarker {
	String^ get ();
	void set (String^ value);
}

public:
property String^ UnknownCharacterMarker {
	String^ get ();
	void set (String^ value);
}

Property Value

Type: String
The UnknownCharacterMarker value. The default value is "?".

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfUnknownCharacterMarker

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfUnknownCharacterMarker

Exceptions

Exception	Condition
ArgumentNullException	if UnknownCharacterMarker is set to null.
ArgumentException	if UnknownCharacterMarker is the empty string or contains more than a single text element.

Remarks

If the classifier fails to match a run-time character with a score that satisfies the classifier's accept threshold, the resulting CogOCRMaxChar.CharacterCode output is set to a special character code (0xF800) that means the character is "Unknown". This UnknownCharacterMarker provides an alias for displaying the unknown character code is the ResultString.