GetUnicodeRanges function
Returns the ranges of Unicode points that the recognizer supports.
Syntax
HRESULT WINAPI GetUnicodeRanges( HRECOGNIZER hrec, ULONG *pcRanges, CHARACTER_RANGE *pcr );
Parameters
- hrec
-
Handle to the recognizer.
- pcRanges
-
On input, the number of ranges the pcr buffer can hold. On output, the number of ranges the pcr buffer contains.
- pcr
-
Array of CHARACTER_RANGE structures. Each structure contains a range of Unicode points that the recognizer supports. The order of the array is arbitrary. To determine the required size of the buffer, set pcr to NULL; use the number of ranges to allocate the pcr buffer.
Return value
This function can return one of these values.
| Return code | Description |
|---|---|
|
Success. |
|
One of the parameters is an invalid pointer. |
|
The pcr buffer is too small. |
|
An unspecified error occurred. |
|
An invalid argument was received. |
|
Insufficient memory. |
Remarks
This function is optional.
Some recognizers do not support this capability, but may still include the GetUnicodeRanges Function function. For such recognizers the GetUnicodeRanges function returns E_NOTIMPL.
To control the Unicode ranges used by a specific recognizer context, use the GetEnabledUnicodeRanges and SetEnabledUnicodeRanges functions. These ranges are constrained to be a subset of the ranges returned by GetUnicodeRanges.
Microsoft gesture recognizers use Unicode characters from 0xF000 to 0xF0FF. Each single Unicode value in this range represents a single gesture. For a complete list of Unicode values for gestures, see Unicode Range Values of Gestures.
Requirements
|
Minimum supported client |
Windows XP Tablet PC Edition [desktop apps only] |
|---|---|
|
Minimum supported server |
None supported |
|
Header |
|
See also