Properties of the Engine Object
The Engine object exposes a set of properties reflecting global settings of ABBYY FineReader Engine. With the help of these properties you can set the parameters of ABBYY FineReader Engine such as user interface language or settings of parallel processing.
| Name | Type | Description |
|---|---|---|
| Common attributes | ||
| MessagesLanguage | MessagesLanguageEnum |
Defines the language of interaction between ABBYY FineReader Engine and the user. All message boxes, error messages, tips and warnings will be displayed in this language. This parameter stays on between sessions. In order that the interface language changes are fully applied, you need to specify the required value for this property and reload the Engine object. The interface language settings are stored in the InterfaceLanguage.dat file that can be found in the FineReader Engine data folder (/var/lib/ABBYY/SDK/12/FineReader Engine for automatic installation). If your application must have language settings different from other applications that are using FineReader Engine, you need to use another folder for user-specific data, passing the path to this folder in the call of InitializeEngine function.
|
| Version | BSTR, read-only | Returns the current version (build number) of ABBYY FineReader Engine. |
| Additional attributes | ||
| PredefinedLanguages | PredefinedLanguages, read-only | Provides access to the collection of predefined languages of ABBYY FineReader Engine. See the list of all predefined languages. |
| CurrentLicense | License, read-only | Returns the current license. |
| AvailablePredefinedLanguages | PredefinedLanguages, read-only | Returns the collection of all predefined languages that are available under the current license. |
| Path | BSTR, read-only | Returns the path to the folder that contains the ABBYY FineReader Engine executables. |
| TotalObjectsCount | int, read-only | Returns the number of unreleased objects. When an object is created, this counter is incremented, and when the object is destroyed, the counter is decremented. You can use this property to trace possible memory leaks. Check the value of this property at the beginning and end of code fragment in which you suspect a memory leak. If the difference is not what you expected, you can narrow the search further and pinpoint the mistake. |
| Processing settings | ||
| AutoCleanRecognizerSession | VARIANT_BOOL |
Specifies whether recognition session should be cleaned after recognition of each page. When processing documents, FineReader Engine tunes itself for recognition of the current type of document (concerning its brightness, text types, fonts, etc.). This information is used during one recognition session and helps to improve recognition quality. In most cases, it is useful to clean the recognition session after recognition of each page; this behavior is used by default. By default, the value of this property is TRUE. |
| MultiProcessingParams | MultiProcessingParams, read-only | Provides access to the parameters of multiprocessing and multiple CPU cores usage. |
| RecognitionSpeedLimit | int | Specifies recognition speed limitation in characters per second. It allows you to specify maximum recognition speed. It may be set to 0, which means that there is no limit on recognition speed. Recognition speed can be limited in the license. In this case, the minimum value is used. |
Samples
The properties are used in all code samples and demo tools.
See also
03.07.2024 8:50:25