Skip to main content
This method enables logging of errors, warnings and method calls.

​
Syntax

​
C++

HRESULT EnableEngineLogging(
  BSTR         settings
);

​
C#

void EnableEngineLogging(
  string settings
);

​
Visual Basic .NET

Sub EnableEngineLogging( _
  settings As String _
)

​
Parameters

settings [in] Currently, this parameter must be a path to a folder where engine-wide log files 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 additional logging settings; 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 Engine-level logging; log files are created in the specified folder for the “FREngine” component.
  • 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.
  • Enabling logging may reduce throughput due to I/O overhead.
  • Future versions may interpret settings as JSON with options such as log levels, rotation, or file naming; do not depend on today’s string format beyond the requirement to pass a folder path.

​
See also

Engine StartLogging EnableProcessorLogging StopLogging