EnableProcessorLogging Method of the Engine Object
This method enables logging of errors, warnings and method calls.
Syntax
C++
HRESULT EnableProcessorLogging(
BSTR settings
);
C#
void EnableProcessorLogging( string settings );
Visual Basic .NET
Sub EnableProcessorLogging( _ settings As String _ )
Parameters
- settings
- [in] Currently, this parameter must be a path to a folder where processor-level logs will be written (absolute or UNC path). The folder must be writable by the calling process.
- Forward compatibility: in future versions this parameter will accept a JSON string with extended logging options; at present, only a plain folder path is supported.
Return values
This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.
Remarks
- Enables logging for internal processors managed by the Engine. Log files are created under the specified folder by the corresponding processors.
- If the folder is inaccessible or the path is invalid, the call fails with a standard error code. Ensure the application has sufficient permissions and free disk space.
- Logging may have a measurable impact on performance and disk usage.
- This API is forward-compatible: do not rely on the exact format of the settings string beyond the current requirement to pass a writable folder path.
See also
07.11.2025 12:48:30