OnProgress-Methode der IDocumentViewerEvents-Schnittstelle

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

mithilfe der Befehle von Document Viewer:
- MI_Read
- MI_AnalyzeLayout

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

mithilfe der folgenden Befehle von Image Viewer, synchronisiert mit Document Viewer:

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

mithilfe der folgenden Befehle von Zoom Viewer, synchronisiert mit Image Viewer:

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

über die FineReader Engine API

Sie übermittelt dem Client den ungefähren Fortschritt des Vorgangs in Prozent. In ihrer Implementierung kann eine Fortschrittsanzeige angezeigt werden. Verarbeiten Sie Systemmeldungen, damit die Anwendung bei lang andauernden Vorgängen nicht den Eindruck erweckt, nicht mehr zu reagieren. Dies kann in Anwendungen mit einer Benutzeroberfläche hilfreich 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 bisher erledigten Arbeit. Der Wert liegt im Bereich von 0 bis 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 in C++] Wenn diese Methode einen anderen Wert als S_OK zurückgibt, bedeutet dies, dass ein clientseitiger Fehler aufgetreten ist; in diesem Fall wird der Wert des Parameters Cancel nicht berücksichtigt.

Hinweise

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 propagiert werden. Die Propagierung einer Ausnahme über die Methode hinaus kann zu unvorhersehbaren Ergebnissen führen (z. B. zur Beendigung des Programms).