GetEnabledUnicodeRanges Function

GetEnabledUnicodeRanges Function

Returns a list of Unicode point ranges enabled on the context. If you do not call the SetEnabledUnicodeRanges function to specify the enabled ranges, this function returns the recognizer's default Unicode point ranges.

Syntax

[C++]

HRESULT WINAPI GetEnabledUnicodeRanges(
  HRECOCONTEXT hrc,
  ULONG *pcRanges,
  CHARACTER_RANGE *pcr
);

Parameters

hrc

[in] Handle to the recognizer context.

pcRanges

[in, out] On input, the number of CHARACTER_RANGE structures the pRanges buffer can contain. On output, the number of ranges the pRanges buffer contains.

pcr

[out] Array of CHARACTER_RANGE structures. Each structure contains a range of Unicode points enabled on the context. The order of the array is arbitrary. To determine the size of the buffer, set pcr to NULL; use the number of ranges to allocate the pcr buffer.

Return Value

HRESULT valueDescription
S_OKSuccess.
E_POINTEROne of the parameters is an invalid pointer.
TPC_E_INSUFFICIENT_BUFFERThe pcr buffer is too small.
E_OUTOFMEMORYInsufficient memory.

Remarks

This function is optional.

Some recognizers do not support enabling and disabling specific Unicode points, but may still include the GetEnabledUnicodeRanges function. For such recognizers the GetEnabledUnicodeRanges function returns the same ranges as the GetUnicodeRanges function.

Microsoft® gesture recognizerrs 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.

Related Topics

Show: