InkRecognizerContext.Recognition event

Article
01/07/2021

Occurs when the InkRecognizerContext has generated results from the BackgroundRecognize method.

Syntax

void Recognition(
  [in] BSTR                 RecognizedString,
  [in] VARIANT              CustomData,
  [in] InkRecognitionStatus RecognitionStatus
);

Parameters

RecognizedString [in]

The recognition result text with the highest confidence.

For more information about the BSTR data type, see the Using the COM Library.

CustomData [in]

The object that contains the custom data for the recognition result.

For more information about the VARIANT structure, see the Using the COM Library.

RecognitionStatus [in]

The recognition status as of the most recent recognition result.

Return value

This event does not return a value.

Remarks

The behavior of the application programming interface (API) is unpredictable if you try to gain access to the original InkRecognizerContext object from the recognition event handler. Do not attempt to do this. Instead, if you need to do this, create a flag and set it in the Recognition event handler. Then you can poll that flag to determine when to change the InkRecognizerContext properties outside of the event handler.

This event method is defined in the _IInkEvents interface. The _IInkEvents interface implements the IDispatch interface with an identifier of DISPID_IRERecognition.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	Msinkaut.h (also requires Msinkaut_i.c)
Library	InkObj.dll