IInkRecognizerContext::BackgroundRecognize method (msinkaut.h)

Causes the IInkRecognizer object to recognize the associated strokes collection and fire a Recognition event when recognition is complete.


HRESULT BackgroundRecognize(
  [in, optional] VARIANT CustomData


[in, optional] CustomData

Specifies any application-defined data that is available to the application in the Recognition event. This parameter may be a VARIANT of type VT_EMPTY or VT_NULL if no data needs to be passed. The default value is NULL.

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

Return value

This method can return one of these values.

Return code Description
Cannot allocate memory to complete the operation.
No strokes exist.
An exception occurred inside the method.


This method specifies that ink recognition is performed asynchronously. To recognize ink synchronously, call the Recognize method.

This method recognizes only the best result string. Alternates are not created. To perform recognition that creates a list of available alternates, call the BackgroundRecognizeWithAlternates method.

The Recognition event is not raised if the recognizer does not recognize anything.


Minimum supported client Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header msinkaut.h
Library InkObj.dll

See also

BackgroundRecognizeWithAlternates Method

Data Property

IInkRecognitionAlternate Interface


InkRecognizerContext Class