メインコンテンツへスキップ
このメソッドは、エラー、警告、メソッド呼び出しのログ出力を有効にします。

構文

C++

HRESULT EnableEngineLogging(
  BSTR         settings
);

C#

void EnableEngineLogging(
  string settings
);

Visual Basic .NET

Sub EnableEngineLogging( _
  settings As String _
)

パラメーター

settings [in] 現時点では、このパラメーターには、エンジン全体のログ ファイルの書き込み先となるフォルダーのパス (絶対パスまたは UNC パス) を指定する必要があります。このフォルダーは、呼び出し元のプロセスが書き込み可能でなければなりません。 前方互換性: 今後のバージョンでは、このパラメーターで追加のログ設定を含む JSON 文字列を受け付けるようになる予定です。現時点でサポートされているのは、通常のフォルダー パスのみです。

戻り値

このメソッドに固有の戻り値はありません。返されるのは、ABBYY FineReader Engine 関数の標準戻り値です。

注記

  • エンジン レベルのログ出力を有効にします。ログ ファイルは、指定したフォルダーに “FREngine” コンポーネント用として作成されます。
  • フォルダーにアクセスできない場合、またはパスが無効な場合、呼び出しは標準のエラー コードで失敗します。アプリケーションに十分なアクセス許可と空きディスク容量があることを確認してください。
  • ログ出力を有効にすると、I/O のオーバーヘッドによりスループットが低下する場合があります。
  • 今後のバージョンでは、ログ レベル、ローテーション、ファイル名などのオプションを含む JSON として設定が解釈される可能性があります。フォルダー パスを渡す必要があること以外は、現在の string 形式に依存しないでください。

関連項目

Engine StartLogging EnableProcessorLogging StopLogging