OnProgress-Methode der IZoomViewerEvents-Schnittstelle

Diese Methode wird clientseitig implementiert. Sie wird von ABBYY FineReader Engine während der Analyse oder Erkennung der aktiven Seite in Zoom Viewer aufgerufen. Der Prozess kann auf eine der folgenden Arten ausgelöst werden:

mit den folgenden Befehlen von Zoom Viewer:

Informationen dazu, wie diese Befehle aufgerufen werden können, finden Sie in der Liste Zoom Viewer Commands.

mit den folgenden Befehlen von Image Viewer, synchronisiert mit Zoom Viewer:

Informationen dazu, wie diese Befehle aufgerufen werden können, finden Sie in der Liste Image Viewer Commands.

mit den Befehlen von Document Viewer, synchronisiert mit Image Viewer:
- MI_Read
- MI_AnalyzeLayout

Informationen dazu, wie diese Befehle aufgerufen werden können, finden Sie in der Liste Document Viewer Commands.

über die FineReader Engine API

Sie übermittelt dem Client den ungefähren Fortschritt des Vorgangs in Prozent. Ihre Implementierung kann eine Fortschrittsanzeige einblenden. Sie kann außerdem Systemmeldungen verarbeiten, damit die Anwendung bei langen Vorgängen nicht den Eindruck erweckt, nicht mehr zu reagieren. Dies kann in Anwendungen mit Benutzeroberfläche nützlich sein. Mithilfe dieser Methode kann der Vorgang abgebrochen werden.

Syntax

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 _
)

Parameter

Percentage [in] Enthält den Prozentsatz der aktuell bereits erledigten Arbeit. Der Wert liegt zwischen 0 und 100. Cancel [out] Sie können diese Variable auf TRUE setzen, um anzugeben, dass der Prozess beendet werden soll. In diesem Fall wird der Analyse- oder Erkennungsvorgang abgebrochen.

Rückgabewerte

[Nur C++] Wenn diese Methode einen anderen Wert als S_OK zurückgibt, bedeutet dies, dass clientseitig ein Fehler aufgetreten ist. In diesem Fall wird der Wert des Parameters Cancel nicht berücksichtigt.

Bemerkungen

Die Client-Implementierung dieser Methode muss sicherstellen, dass alle innerhalb der Methode ausgelösten Ausnahmen abgefangen und behandelt werden und dass keine Ausnahmen über die Methode hinaus weitergegeben werden. Die Weitergabe einer Ausnahme über die Methode hinaus kann zu unvorhersehbaren Ergebnissen führen (z. B. zur Beendigung des Programms).