ImageGear for C and C++ on Windows v19.5 - Updated
FNIG_REC_WORD_CHECK
API Reference Guide > Recognition Component API Reference > Recognition Component Functions Reference > Recognition Callback Functions > FNIG_REC_WORD_CHECK

This callback function has been deprecated and will be removed from the public API in a future release.

Declaration:

 
Copy Code
DWORD ACCUAPI FNIG_REC_WORD_CHECK(
     int nZone, 
         LPCWSTR pTobechecked, 
         enumIGRecCheckWordReturnCode* pOpinion, 
         void* pReserved
);

Arguments:

Name Type Description
nZone int Zone list index of the zone containing the string to be checked.
pTobechecked LPCWSTR UNICODE string (or line) to be checked by the function.
pOpinion enumIGRecCheckWordReturnCode* Pointer to variable to hold the returned value.
pReserved void* Internal use only.

Return Value:

IGE_REC_EXT_OK. This callback function should always return with this value.

Supported Raster Image Formats:

See IG_REC_image_import.

Remarks:

The user-written checking callback function.

The FNIG_REC_WORD_CHECK callback function allows user-written checking of recognition results. It gives the application the ability to influence recognition results at the zone level. This checking can be called back by some recognition modules (MOR, MAT) through the checking subsystem during the recognition of a particular zone. The value returned in the pOpinion parameter can influence a recognition module decision about the recognized result. It is the task of the function to check the pTobechecked UNICODE recognized string and to decide whether it is acceptable for that zone. The pOpinion parameter of the function should make a judgment on the acceptability of the recognized string through one of the enumIGRecCheckWordReturnCode values.

To use user-written checking for a zone:

The following are some examples where the enumIGRecCheckWordReturnCode value is to be returned by the integrating application:

The callback function should not contain calls to any IG_REC_... functions.