Méthode OnProgress de l’interface IZoomViewerEvents

Cette méthode est implémentée côté client. Elle est appelée par ABBYY FineReader Engine lors de l’analyse ou de la reconnaissance de la page active dans Zoom Viewer. Le processus peut être lancé de l’une des manières suivantes :

• à l’aide des commandes suivantes de Zoom Viewer :
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

Pour savoir comment appeler ces commandes, consultez la liste Zoom Viewer Commands.

• à l’aide des commandes suivantes de Image Viewer, synchronisé avec Zoom Viewer :
  • MI_Read
  • MI_ReadBlock
  • MI_AnalyzeLayout
  • MI_AnalyzeLayoutInBlock

Pour savoir comment appeler ces commandes, consultez la liste Image Viewer Commands.

• à l’aide des commandes de Document Viewer, synchronisé avec Image Viewer :
  • MI_Read
  • MI_AnalyzeLayout

Pour savoir comment appeler ces commandes, consultez la liste Document Viewer Commands.

• via l’API FineReader Engine

Elle fournit au client le pourcentage approximatif d’avancement de l’opération. Son implémentation peut afficher un indicateur de progression. Elle peut également traiter les messages système afin d’éviter que l’application ne paraisse bloquée pendant les opérations longues. Cela peut être utile dans les applications dotées d’une interface utilisateur. Cette méthode permet également d’annuler l’opération.

​

Syntaxe

​

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

​

Paramètres

Percentage

[in] Contient le pourcentage de travail déjà effectué. Sa valeur est comprise entre 0 et 100.

Cancel

[out] Vous pouvez définir cette variable sur TRUE pour indiquer que le processus doit être arrêté. Dans ce cas, le processus d’analyse ou de reconnaissance sera annulé.

​

Valeurs de retour

[C++ uniquement] Si cette méthode renvoie une valeur autre que S_OK, cela indique qu’une erreur s’est produite côté client et, dans ce cas, la valeur du paramètre Cancel n’est pas prise en compte.

​

Remarques

L’implémentation côté client de cette méthode doit garantir que toutes les exceptions levées à l’intérieur de la méthode sont interceptées et traitées, et qu’aucune ne se propage en dehors de la méthode. La propagation d’une exception en dehors de la méthode peut entraîner des résultats imprévisibles (comme l’arrêt du programme).

​

Voir aussi

ZoomViewer

IZoomViewerEvents