SetWordlistHRC

2.0

Sets a word list into a recognition context HRC object.

int SetWordlistHRC( HRC hrc, HWL hwl )

Parameters
hrc

Handle to the HRC object.

hwl

Handle to a word list to use, or NULL. A value of NULL means that the recognizer should not constrain recognition based on any word list, including its own dictionary.

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

Constant	Description
HRCR_ERROR	Invalid parameter or other error.
HRCR_MEMERR	Insufficient memory.
HRCR_UNSUPPORTED	The recognizer does not support this function.

Comments
Specifying NULL for hrc does not destroy the word list specified by hwl. Applications must call DestroyHWL to destroy a word list.

Only one word list can be set into an HRC at a time. This is independent of the recognizer's dictionary, which can be manipulated through the function EnableSystemDictionaryHRC.

For a description of word lists and how a recognizer uses them, see "Configuring the HRC" in Chapter 5, "The Recognition Process."