GetEnabledUnicodeRanges function (recapis.h)

Article
04/07/2023

Retrieves 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

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

Parameters

hrc

The handle to the recognizer context.

pcRanges

On input, the number of CHARACTER_RANGE structures the pcr buffer can contain. On output, the number of ranges the pcr buffer contains.

pcr

An 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

This function can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	One of the parameters is an invalid pointer.
E_FAIL	An unspecified error occurred.
E_INVALIDARG	An invalid argument was received.
TPC_E_INSUFFICIENT_BUFFER	The pcr buffer is too small.
E_OUTOFMEMORY	Insufficient 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 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

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	recapis.h
DLL	inkobjcore.dll