CreateHWL - Microsoft Windows Pen API Programmer's Reference (penapi.hlp)

Microsoft Windows Pen API
Programmer's Reference

Index Commented Search About

CreateHWL

2.0

Creates a handle to a word list.

HWL CreateHWL( HREC hrec, LPSTR lpsz, UINT uType, DWORD dwReserved )

Parameters
hrec

Module handle of the recognizer library. If this value is NULL, the system default recognizer is used.

lpsz

A pointer to a source of words, depending on the uType parameter.

Type

Word-list type. This can be one of the following values:

Constant	Description
WLT_EMPTY	An empty word list is created. The lpsz parameter is ignored.
WLT_STRING	The lpsz parameter points to a single null-terminated character string in memory.
WLT_STRINGTABLE	The lpsz parameter points to an array of null-terminated character strings in memory. The list is terminated by two null characters.

dwReserved

Must be 0.

Return Value
If successful, returns the handle of a newly created word list; otherwise, returns NULL. If the recognizer does not support word lists, the return value is NULL.

Comments
CreateHWL creates a word list for constraining recognition. Word lists can be combined using the AddWordsHWL function.

To make a word list from words in a file, an application uses CreateHWL to create an empty word list, then reads the file into it with the ReadHWL function.

Any word lists created by an application must eventually be destroyed by calling DestroyHWL. Attempting to unload a recognizer that has open word lists results in an error.

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

Example
The following example demonstrates how to provide a word list to constrain recognition results to the words "Canada," "USA," or "Mexico":

static char szNames[] = { "Canada",

"USA",

"Mexico"

};

HWL hwlCountries = CreateHWL( NULL,

(LPSTR)szNames,

WLT_STRINGS, 0L ); // Create early for later use

if (hrc = CreateCompatibleHRC( NULL, NULL ))

{

SetWordlistHRC( hrc, hwlCountries ); // Set list into HRC