IInkDivisionUnit::ToString method
[ToString is no longer available for use as of Windows Vista. Instead, see the String property for the equivalent of this method for the IInkRecognitionAlternate object. ]
Contains the default recognizer. Performs recognition on the collection of strokes and retrieves the top string of the top alternate of the recognition result.
Syntax
HRESULT ToString(
[out, retval] BSTR *ToString
);
Parameters
ToString [out, retval]
When this method returns, ToString contains the top string of the TopAlternate property of the IInkRecognitionResult object, after the default recognizer performs recognition on the collection of strokes.For more information about the BSTR data type, see Using the COM Library.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
| S_OK | Success. |
| E_POINTER | A parameter contained an invalid pointer. |
| E_FAIL | Operation failed. |
| E_OUTOFMEMORY | Out of memory. |
| E_INK_EXCEPTION | An exception occurred inside the method. |
| TPC_E_RECOGNIZER_NOT_REGISTERED | No recognizers are installed, the recognizers registry key is corrupted, or your environment does not support handwriting recognition. |
Remarks
ToString should not be used for handwriting recognition applications; it can be used for debugging purposes.
ToString returns NULL if:
- The InkStrokes collection is empty.
- A default recognizer cannot be created.
- The default recognizer does not support free input.
Requirements
Minimum supported client |
Windows XP Tablet PC Edition [desktop apps only] |
Minimum supported server |
None supported |
End of client support |
Windows XP Tablet PC Edition |
End of server support |
None supported |
Header |
Msinkaut15.h (also requires Msinkaut15_i.c) |
Library |
Inkdiv.dll |