CogOCVMaxRunParams.SetKeyset Method (CogOCVMaxCharacterIterator, String)

CogOCVMaxRunParams SetKeyset Method (CogOCVMaxCharacterIterator, String)

Cognex VisionPro

Sets the key set for the specified character position within the specified line within the specified paragraph.

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 void SetKeyset(
	CogOCVMaxCharacterIterator pCI,
	string NewValue
)

public void SetKeyset(
	CogOCVMaxCharacterIterator pCI,
	string NewValue
)

Public Sub SetKeyset ( 
	pCI As CogOCVMaxCharacterIterator,
	NewValue As String
)

Public Sub SetKeyset ( 
	pCI As CogOCVMaxCharacterIterator,
	NewValue As String
)

public:
void SetKeyset(
	CogOCVMaxCharacterIterator^ pCI, 
	String^ NewValue
)

public:
void SetKeyset(
	CogOCVMaxCharacterIterator^ pCI, 
	String^ NewValue
)

Parameters

pCI: Type: Cognex.VisionPro.OCVMax CogOCVMaxCharacterIterator
A character iterator that specifies the character position of interest.

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

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this method changes the subject key set.

Exceptions

Exception	Condition
ObjectDisposedException	If this CogOCVMaxRunParams object has already been disposed.
ArgumentNullException	If the supplied character iterator argument is NULL.

Remarks

The key values are passed in the NewValue string. Each character in this string is the key value of a character that may occur at the specified position. Note that this method assumes that the character keys in this font correspond to Unicode code point values.