IInkRecognizerContext::BackgroundRecognizeWithAlternates method (msinkaut.h)
Causes the IInkRecognizer object to recognize the associated strokes collection and fire a RecognitionWithAlternates event when recognition is complete.
Syntax
HRESULT BackgroundRecognizeWithAlternates(
[in, optional] VARIANT CustomData
);
Parameters
[in, optional] CustomData
Optional. Specifies any application-defined data that is available to the application in the RecognitionWithAlternates 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.
| HRESULT Value | Description |
|---|---|
|
Success. |
|
Cannot allocate memory to complete the operation. |
|
No strokes exist. |
|
An exception occurred inside the method. |
Remarks
This method specifies that ink recognition is performed asynchronously.
To perform recognition that includes only the best result string with no alternates, call the BackgroundRecognize method.
The RecognitionWithAlternates event is not raised if the recognizer does not recognize any alternates.
Requirements
| Requirement | Value |
|---|---|
| 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 |