Cette méthode est implémentée côté client. Elle est appelée par ABBYY FineReader Engine pour certaines méthodes de l’objet FRDocument. Elle fournit au client des informations sur le pourcentage approximatif de l’opération en cours (chargement d’image, analyse, reconnaissance, etc.). Son implémentation peut afficher un indicateur de progression, comme dans ABBYY FineReader.
Sous Windows, elle peut également traiter les messages système afin d’éviter que l’application ne semble ne plus répondre pendant les opérations longues. Cela peut être utile dans les applications dotées d’une interface utilisateur.
HRESULT OnProgress(
IFRDocument* Sender,
int Percentage,
VARIANT_BOOL* Cancel
);
void OnProgress(
IFRDocument Sender,
int Percentage,
ref bool Cancel
);
Sub OnProgress( _
Sender As IFRDocument, _
Percentage As Integer, _
ByRef Cancel As Boolean _
)
Sender
[in] Ce paramètre fait référence à l’objet FRDocument qui envoie les notifications.
Percentage
[in] Ce paramètre contient le pourcentage de travail déjà effectué. Il est compris entre 0 et 100.
Cancel
[in, out] Vous pouvez définir cette variable sur TRUE pour indiquer que le processus doit être interrompu. Dans ce cas, la fonction de traitement renvoie E_ABORT.
[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.
L’implémentation du client pour 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 exception n’est propagée 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).
IFRDocumentEvents
FRDocument