CleanCacheDictionary Method of the FRPage Object

CleanCacheDictionary method of the FRPage Object in the ABBYY FineReader Engine API — Deletes all words from the page-level cache dictionary; requires IEngine.AutoCleanRecognizerSession to be FALSE.

This method deletes all words from the cache dictionary. The cache dictionary is a small dictionary (about a hundred words) which can be changed easily during processing. The cache dictionaries can be used when it is possible to select a dictionary more precisely, if you found new information about the document during processing.

To use the cache dictionary, you should set the IEngine::AutoCleanRecognizerSession property to FALSE. The AutoCleanRecognizerSession property is set to TRUE by default, which means that FineReader Engine cleans its recognition session after recognition of each page, in which case the cache dictionary is cleaned too. To prevent accidental destruction of user data, FineReader Engine prohibits using of cache dictionaries in this mode. If you use the cache dictionary, it is your concern to clean the recognition session manually by calling the IEngine::CleanRecognizerSession method when necessary. See the description of the method to find out when it is necessary to clean the recognition session.

Syntax

C++

HRESULT CleanCacheDictionary( IRecognizerParams* params );

C#

void CleanCacheDictionary( IRecognizerParams params );

Visual Basic .NET

Sub CleanCacheDictionary(params As IRecognizerParams)

Parameters

params

[in] The RecognizerParams object that stores parameters of page processing.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

FRPage

AddWordToCacheDictionary

AddWordsToCacheDictionary

Working with Dictionaries