> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IFRPageEvents インターフェイスの OnProgress メソッド

> ABBYY FineReader Engine API の IFRPageEvents インターフェイスの OnProgress メソッド。FRPage の操作（解析、認識、エクスポート）のおおよその進行率を通知するために呼び出されるクライアント側のメソッドです。

このメソッドはクライアント側で実装されます。[FRPage](/ja/fine-reader/engine/api-reference/document-related-objects/frpage) オブジェクトの一部のメソッドに対して、ABBYY FineReader Engine から呼び出されます。現在の処理 (解析、認識、エクスポート) のおおよその進行率に関する情報をクライアントに通知します。実装では、ABBYY FineReader と同様に、進行状況インジケーターを表示できます。

<Note>
  Windows では、長時間の処理中にアプリケーションが応答していないように見えるのを防ぐため、システムメッセージを処理することもできます。これは、ユーザーインターフェイスを持つアプリケーションで役立ちます。
</Note>

<div id="syntax">
  ## 構文
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT OnProgress(
  IFRPage*      Sender,
  int           Percentage,
  VARIANT_BOOL* Cancel
);
```

### C\#

```csharp theme={null}
void OnProgress(
  IFRPage   Sender,
  int      Percentage,
  ref bool Cancel
);
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Sub OnProgress( _
  Sender As IFRPage, _
  Percentage As Integer, _
  ByRef Cancel As Boolean _
)
```

<div id="parameters">
  ## パラメーター
</div>

Sender

\[in] このパラメーターは、通知を送信する [FRPage](/ja/fine-reader/engine/api-reference/document-related-objects/frpage) オブジェクトを指します。

Percentage

\[in] このパラメーターには、現在の作業進行率が格納されます。値の範囲は 0 から 100 です。

Cancel

\[in, out] process を終了する必要があることを示すには、この変数を TRUE に設定します。この場合、進行率を通知する処理関数は E\_ABORT を返します。

<div id="return-values">
  ## 戻り値
</div>

\[C++ のみ] このメソッドが S\_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。この場合、Cancel パラメーターの値は考慮されません。

<div id="remarks">
  ## 注記
</div>

このメソッドのクライアント実装では、メソッド内でスローされたすべての例外を確実にキャッチして処理し、例外がメソッドの外部に伝播しないようにする必要があります。例外がメソッドの外部に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。

<div id="see-also">
  ## 関連項目
</div>

[IFRPageEvents](/ja/fine-reader/engine/api-reference/document-related-objects/ifrpageevents)

[FRPage](/ja/fine-reader/engine/api-reference/document-related-objects/frpage)