ResultsHookHREC

The ResultsHookHREC function is an application-defined callback function that provides the application with the opportunity to view all recognition results before they are returned to the application. The name ResultsHookHREC is a placeholder; the function can have any name.

BOOL CALLBACK ResultsHookHREC( HREC hrec, HRC hrc, WORD wHooktype, UINT cResults, UINT cAlt, LPVOID rgresults )

Parameters
hrec

Module handle of the recognizer library whose results are being hooked.

hrc

Handle to the HRC object for the recognizer that hrec refers to.

wHooktype

Type of hook. This can be one of the following values:

RHH_STD

Standard results generated by GetResultsHRC.

RHH_BOX

Boxed results generated by GetBoxResultsHRC.

cResults

Count of results available.

cAlt

Count of box alternatives. This is valid only if wHooktype is RHH_BOX.

rgresults

An array of result objects. The object type depends on wHooktype. If RHH_STD, rgresults should be cast as LPHRCRESULT and the array receives cResults HRCRESULT objects. If RHH_BOX, rgresults should be cast as LPBOXRESULTS and the array receives cResults BOXRESULTS structures.

Return Value
The application hook function should return TRUE to indicate that it has processed the data and that the recognizer should do no further processing. In this case, it is the application's responsibility to destroy the results and inksets, if any; otherwise, the hook function should return FALSE.