IInkRecognizerContext::StopBackgroundRecognition method (msinkaut.h)
Ends background recognition that was started with a call to BackgroundRecognize or BackgroundRecognizeWithAlternates.
Syntax
HRESULT StopBackgroundRecognition();
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Success.
This method also returns S_OK if the recognizer does not support this method. |
|
Cannot allocate memory to complete the operation. |
|
An exception occurred inside method. |
Remarks
No event is fired if StopBackgroundRecognition is called.
Call StopBackgroundRecognition if you call BackgroundRecognize or BackgroundRecognizeWithAlternates one or more times. Calling StopBackgroundRecognition does not necessarily ensure that you get no results from a recognition process that is currently under way. It only ensures that all previous calls to BackgroundRecognize or BackgroundRecognizeWithAlternates that have not yet been processed are actually not executed.
Call this method only if you process the ink asynchronously.
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 |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for