SetGuide function
Sets the recognition guide to use for boxed or lined input. You must call this function before you add strokes to the context.
Syntax
HRESULT WINAPI SetGuide(
HRECOCONTEXT hrc,
const RECO_GUIDE *pGuide,
ULONG iIndex
);
Parameters
- hrc
-
Handle to the recognizer context.
- pGuide
-
Guide to use for box or line input. Setting this parameter to NULL means that the context has no guide. This is the default and means the recognizer is in free input mode. For guide details, see the RECO_GUIDE structure.
- iIndex
-
Index value to use for the first box or line in the context.
Return value
This function can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
The context is invalid or one of the parameters is an invalid pointer. |
|
Unable to allocate memory to complete the operation. |
|
Attempted to set a recognition mode (free, lined, boxed, and so on) that is not supported by the recognizer, or the RECO_GUIDE field values are illegal (negative heights or widths, for example). |
|
An unspecified error occurred. |
|
Attempted to set guide when there was already some ink in the reco context, or, in the case of recognizers of East Asian characters, SetCACMode was called previously. |
Remarks
Guide boxes are numbered based on the iIntex value.
Requirements
|
Minimum supported client |
Windows XP Tablet PC Edition [desktop apps only] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
See also