跳转到主要内容
此方法在客户端实现。在对文档查看器中的当前活动页面执行分析或识别时,ABBYY FineReader Engine 会调用此方法。可通过以下任一方式启动该过程: 要了解如何调用这些命令,请参阅文档查看器命令列表。 要了解如何调用这些命令,请参阅图像查看器命令列表。 要了解如何调用这些命令,请参阅缩放查看器命令列表。
  • 通过 FineReader Engine API
此方法会向客户端传递操作的大致完成百分比。其实现可用于显示进度指示器。请处理所有系统消息,以帮助避免应用程序在长时间操作期间看起来无响应。这对于带有用户界面的应用程序尤其有用。借助此方法,还可以取消该操作。

语法

C++

HRESULT OnProgress(
  int           Percentage,
  VARIANT_BOOL* Cancel
);

C#

void OnProgress(
  int      Percentage,
  out bool Cancel
);

Visual Basic .NET

Sub OnProgress( _
  Percentage As Integer, _
  ByRef Cancel As Boolean _
)

参数

Percentage [in] 表示当前已完成工作的百分比。取值范围为 0 到 100。 Cancel [out] 您可以将此变量设置为 TRUE,表示应终止该过程。在这种情况下,分析或识别过程将会中止。

返回值

[仅限 C++] 如果此方法返回的值不是 S_OK,则表示客户端发生了错误;在这种情况下,将不考虑 Cancel 参数的值。

备注

此 method 的客户端实现必须确保:在 method 内部抛出的所有异常都会被捕获并妥善处理,且不会传播到 method 外部。异常一旦传播到 method 外部,可能会导致不可预测的结果 (例如程序终止) 。

另请参见

DocumentViewer IDocumentViewerEvents