SetWordlistCoercionHRC 

2.0     

Specifies to what degree input must match a word list set into an HRC. SetWordlistCoercionHRC determines the influence a recognizer s word list or dictionary has on the recognizer s guesses.

int SetWordlistCoercionHRC( HRC hrc, UINT uCoercion )

Parameters

hrc

Handle to the HRC object.

uCoercion

Coercion flag. This can be one of the following:

SCH_ADVISE

The word list serves only to advise the recognizer, but lacks a strong degree of influence. Recognition results are not strongly coerced to match the word list.

SCH_FORCE

If the recognizer s guess is not found in the word list, the closest matching entry in the list is returned. For example, if the recognizer interprets writing as  Cana , it returns  Canada  from a word list of country names.

SCH_NONE

Do not coerce. This flag can be used to turn off a previous request.

Return Value

Returns HRCR_OK if successful; otherwise, returns one of the following negative values:

Constant

Description

HRCR_ERROR

Invalid parameter or other error, including an attempt to set coercion with no word lists set into the recognition context.

HRCR_MEMERR

Insufficient memory.

HRCR_UNSUPPORTED

The recognizer does not support this function.

 

Comments

The default type of coercion a recognizer provides is SCH_ADVISE. That is, results are not strongly coerced to any word list that might be set into a recognition context.

Coercion is used only if a word list (HWL) has actually been set into an HRC with SetWordlistHRC1AOCT_, or if the recognizer s dictionary is enabled by EnableSystemDictionaryHRC1AOBV0. If the HRC is configured with a word list and the recognizer s dictionary is also enabled, coercion is done on both; the priority depends on the recognizer.

See Also

CreateHWL, GetWordlistCoercionHRC