Passer au contenu principal
Cette méthode décharge de la mémoire et, si nécessaire, enregistre sur disque les objets ImageDocument et Layout correspondant à l’objet FRPage, s’il n’existe plus aucune référence à ces objets. L’enregistrement sur disque est facultatif ; vous pouvez omettre cette étape si les données n’ont pas été modifiées. Cette méthode est utile lors du traitement de documents volumineux, car elle réduit l’utilisation de la mémoire. Une fois l’opération sur une page du document terminée, libérez toutes les références aux objets ImageDocument et Layout correspondant à cette page, puis appelez la méthode Flush afin de réduire l’utilisation de la mémoire. Notez que si vous avez apporté des modifications à la page et souhaitez les conserver, vous devez appeler Flush avec le paramètre IsSaveRequired défini sur TRUE. Sinon, ces modifications risquent d’être perdues lors de l’appel d’autres méthodes qui libèrent de la mémoire (voir Itérer sur les pages du document pour plus de détails).

​
Syntaxe

​
C++

HRESULT Flush(
  VARIANT_BOOL  IsSaveRequired,
  VARIANT_BOOL* Result
);

​
C#

bool Flush(bool IsSaveRequired);

​
Visual Basic .NET

Function Flush(Boolean IsSaveRequired) As Boolean

​
Paramètres

IsSaveRequired [in] Indique s’il est nécessaire d’enregistrer les modifications apportées à la page. Passez FALSE si la page n’a pas été modifiée ou si l’enregistrement n’est pas nécessaire. Result [out, retval] Pointeur vers la variable qui reçoit le résultat de l’exécution de la méthode. Le résultat est TRUE si la méthode s’est exécutée avec succès, et FALSE dans le cas contraire.

​
Valeurs de retour

Cette méthode n’a pas de valeur de retour spécifique. Elle renvoie les codes de retour standard des fonctions ABBYY FineReader Engine.

​
Remarques

Sous Windows, le comportement de la méthode Flush dépend de la valeur de la propriété IFRDocument::PageFlushingPolicy. Si la valeur de PageFlushingPolicy est PFP_FlushToDisk, un appel à la méthode décharge la mise en page et les documents image sur le disque. Si elle est PFP_Auto, un appel à la méthode décharge les données sur le disque s’il y a plus de 30 pages dans le document ; sinon, les données sont conservées en mémoire. Si elle est PFP_KeepInMemory, les données ne sont pas déchargées. C’est pratique lorsque vous traitez à la fois de petits et de grands documents dans une même solution, car vous pouvez utiliser le même code pour le traitement.

​
Voir aussi

FRPage IFRDocument::PageFlushingPolicy
Itérer sur les pages du document