ConfigRecognizer

0 2.0

Provides system access to the configuration settings of a recognizer. In version 2.0 of the Pen API, only the pen system can call ConfigRecognizer. Applications must call ConfigHREC to query or set recognizer configuration values. The system routes ConfigHREC calls to the ConfigRecognizer function of the appropriate recognizer.

A recognizer must export ConfigRecognizer. The information in this entry is for recognizer developers only, not application developers.

UINT ConfigRecognizer( UINT uSubFunction, WPARAM wParam, LPARAM lParam )

Parameters
uSubFunction

Recognizer subfunction identifier. See ConfigHREC for descriptions of the WCR_ subfunctions that ConfigRecognizer must support. In addition, ConfigRecognizer must support the following two WCR_ subfunctions:

WCR_INITRECOGNIZER

When an application installs a recognizer by using InstallRecognizer, the system calls the recognizer's ConfigRecognizer function with the WCR_INITRECOGNIZER subfunction. The wParam parameter is not used and lParam is a far pointer to an ASCII string containing the user's name, as set in the system registry. If successful, the recognizer should return 1; otherwise, it should return 0 to indicate an error.

In response to the WCR_INITRECOGNIZER subfunction, the recognizer should perform any required initialization tasks. (This subfunction replaces the InitRecognizer function exported by version 1.0 recognizers.)

WCR_CLOSERECOGNIZER

When an application unloads a recognizer by using UninstallRecognizer, the system calls the recognizer's ConfigRecognizer function with the WCR_CLOSERECOGNIZER subfunction. The wParam and lParam parameters are not used. If successful, the recognizer should return 1; otherwise, it should return 0 to indicate an error.

In response to the WCR_CLOSERECOGNIZER subfunction, the recognizer should perform any required cleanup tasks. (This subfunction replaces the CloseRecognizer function exported by version 1.0 recognizers.)

wParam

Depends on the value of uSubFunction.

lParam

A value, or an address of a buffer. The contents of the buffer depend on the value of uSubFunction.

Return Value
Returns 0 or a positive value, depending on uSubFunction.

Comments
ConfigRecognizer provides initialization and query services for the pen system. The parameter uSubFunction is a WCR_ value that specifies the configuration service that ConfigRecognizer must perform.

When an application calls ConfigHREC, the system determines the appropriate recognizer and passes the call to that recognizer's ConfigRecognizer function. ConfigHREC exists only because its extra argument hrec identifies to the system the intended recognizer library. This information is necessary in version 2.0 of the Pen API, which allows multiple recognizer libraries to exist simultaneously. Thus, the names ConfigHREC and ConfigRecognizer refer to the same function. Applications refer to the function as ConfigHREC, while recognizers export it as ConfigRecognizer.