このメソッドは、Linux 版および Windows 版の FRE で実装されています。
このメソッドはクライアント側で実装します。Batch Processor を使用した処理中に、ABBYY FineReader Engine によって呼び出されます。実装では、長時間の処理中にアプリケーションが応答なしに見えるのを防ぐため、システムメッセージを処理できます。また、このメソッドを使用して処理をキャンセルすることもできます。
HRESULT OnProgress( VARIANT_BOOL* Cancel );
void OnProgress( ref bool Cancel );
Sub OnProgress( ByRef Cancel As Boolean )
Cancel
[in, out] プロセスを中止する必要があることを示すには、この変数を TRUE に設定します。この場合、処理関数は E_ABORT を返します。
[C++ のみ] このメソッドが S_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。この場合、Cancel パラメーターの値は考慮されません。
このメソッドのクライアント実装では、メソッド内でスローされるすべての例外を確実に捕捉して処理し、例外がメソッドの外部に伝播しないようにする必要があります。例外がメソッドの外部に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。
IAsyncProcessingCallback
BatchProcessor