IInkStrokes::ToString
4/8/2010
Has the default recognizer perform recognition on the collection of strokes in IInkStrokes and returns the top string of the top alternate of the recognition result.
Syntax
HRESULT ToString (
[out, retval] BSTR *ToString
);
Parameters
ToString
The top string of the IInkRecognitionResult::TopAlternate property, after the default recognizer performs recognition on the collection of strokes.For more information about the BSTR data type, see Using the Automation Library with Windows Mobile Ink.
Return Value
| HRESULT value | 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. |
Remarks
Warning
The ToString method of the IInkStrokes collection is deprecated. It should not be used for handwriting recognition applications; it can be used for debugging purposes.
ToString returns NULL if:
- The IInkStrokes collection is empty.
- A default recognizer cannot be created.
- The default recognizer does not support free input.
Note
See the IInkRecognitionAlternate::String property for the equivalent to this method for that object.
Requirements
| Header | msinkaut.h |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |