IInkRecognizerContext::Factoid
4/8/2010
Gets or sets the factoid that an IInkRecognizerContext uses to constrain its search for the recognition result.
Syntax
[propput] HRESULT put_Factoid ([in] BSTR Factoid);
[propget] HRESULT get_Factoid ([out, retval] BSTR *Factoid
);
Parameters
Factoid
Returns or sets the factoid type of the recognizer context.This property is read/write.
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. |
TPC_E_INVALID_PROPERTY |
The specified factoid is not supported. |
TPC_E_OUT_OF_ORDER_CALL |
For the IInkRecognizerContext object, this property cannot be assigned after strokes have been added to the IInkRecognizerContext::Strokes property. |
E_NOTIMPL |
The recognizer does not support this method. |
E_OUTOFMEMORY |
Cannot allocate memory to complete the operation. |
E_FAIL |
An unspecified error occurred. |
E_INK_EXCEPTION |
An exception occurred. |
E_INVALIDARG |
The context is invalid or the parameter is an invalid pointer. |
E_UNEXPECTED |
Unexpected parameter or property type. |
Remarks
A factoid provides recognizer context for recognized ink in the context of a particular field. You specify a factoid if an input field is of a known type, for example, if the input field contains a date.
Setting the factoid succeeds only if the IInkStrokes collection is NULL. You must set the factoid before you attach the IInkStrokes collection to the IInkRecognizerContext or you must set the Strokes collection to NULL and then set the factoid (and possibly reattach the IInkStrokes collection).
To ensure that ink is recognized in the correct field context, set this property before processing the ink for the first time, such as before calling the IInkRecognizerContext::Recognize method.
Note
All factoids are case sensitive.
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 |