StartLogging Method of the Engine Object

StartLogging method of the Engine Object in the ABBYY FineReader Engine API — This method enables logging of errors, warnings, and method calls to a specified log file.

This method enables logging of errors, warnings and method calls.

Syntax

C++

HRESULT StartLogging(
  BSTR         LogFileName,
  VARIANT_BOOL WriteMethodCalls
);

C#

void StartLogging(
  string LogFileName,
  bool   WriteMethodCalls
);

Visual Basic .NET

Sub StartLogging( _
  LogFileName As String, _
  WriteMethodCalls As Boolean _
)

Parameters

LogFileName

[in] This parameter contains the full path to the log file. If the file does not exist, it will be created.

WriteMethodCalls

[in] This parameter enables logging calls of ABBYY FineReader Engine methods to the log file. The format is as follows:

<time of call>, <duration of execution (in ms)>, <Interface::Method (parameter1, … )>

For example, 12:40:31.254, 17 ms, IRecognizerParams::put_OneWordPerLine( VARIANT_TRUE )

Return values

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

Remarks

The log file can contain a list of objects that have not been deleted before the deinitialization of the Engine object. To do this, do not call the StopLogging method which disables logging, before the deinitialization.

See also

Engine

EnableEngineLogging

EnableProcessorLogging

StopLogging