ProcessHRC 

2.0     

Gives a recognizer sufficient time for intermediate processing of pen input. A recognizer must export this function.

int ProcessHRC( HRC hrc, DWORD dwTimeMax )

Parameters

hrc

Handle to the HRC object for the recognizer.

dwTimeMax

The maximum time in milliseconds that the recognizer should process before returning from this call. This parameter can also be one of the following time-out codes:

Return Value

If there are no errors, returns one of the following values:

To indicate an error, ProcessHRC returns one of the following negative values:

Comments

ProcessHRC returns if the time specified by dwTimeMax elapses before recognition is complete.

In an operating environment that does not use threads, this function allows an application to provide some time for the recognizer to process input. By checking the return value, the application is able to monitor the progress, specifically whether a gesture is a recognition candidate. If the function returns HRCR_GESTURE, the application can call GetResultsHRC9GBK.HD to determine whether the gesture should be acted on immediately.

Typically, the return value is HRCR_OK if the current batch of ink input has been processed by the recognizer, and HRCR_INCOMPLETE if the recognizer has not yet finished processing.

If ProcessHRC is called with PH_MAX, recognition is complete only if EndPenInputHRC1AOBV. has been called to notify the recognizer that no more results are expected. The return value in this case is HRCR_COMPLETE, and the application is free to get and display final results. If the application supplies further input at this point, it has the effect of canceling the EndPenInputHRC call, although this procedure is not recommended for reasons of efficiency.

However, PH_MAX may result in poorer performance, since further processing in the system is blocked until ProcessHRC returns. Instead, the application can call ProcessHRC in an idle loop or a separate thread, calling it repeatedly with smaller time allotments until the function returns HRCR_COMPLETE. Note that if a separate thread is used to finish processing, the main thread can call this function with PH_MIN from time to time to determine if processing has finished (that is, checking for the HRCR_COMPLETE return value).

The first time that ProcessHRC is called for a particular recognition context, functions that set its state cannot be used for the remainder of that context s existence. The following functions return an error if they are called before ProcessHRC returns HRCR_COMPLETE:

    EnableGestureSetHRC1AOBV9

    EnableSystemDictionaryHRC1AOBV0

    SetAlphabetHRC1AOCS7

    SetAlphabetPriorityHRC1AOCS8

    SetBoxAlphabetHRC1AOCS9

    SetWordlistCoercionHRC1AOCT.

    SetGuideHRC3BE5AG5

    SetInternationalHRC1AOCS.

    SetMaxResultsHRC1AOCS_

    SetWordlistHRC1AOCT_

See Also