メインコンテンツへスキップ
このメソッドは、FRPage オブジェクトに対応する ImageDocument および Layout オブジェクトへの参照が存在しない場合に、それらをアンロードし、必要に応じてディスクに保存します。ディスクへの保存はオプションであり、データが変更されていない場合はこの段階を省略できます。 このメソッドは、大きなDocumentを処理する際に有用で、メモリ使用量を削減できます。個別のDocumentページに対する操作が完了したら、そのページに対応する ImageDocument および Layout オブジェクトへのすべての参照を解放し、Flush メソッドを呼び出してメモリ使用量を削減してください。 ページに変更を加えており、その変更を保持したい場合は、IsSaveRequired パラメーターを TRUE に設定して Flush を呼び出す必要があります。そうしないと、メモリを解放する他のメソッドを呼び出した際に変更が失われる可能性があります (詳細については、Iterating Document Pages を参照してください) 。

​
構文

​
C++

HRESULT Flush(
  VARIANT_BOOL  IsSaveRequired,
  VARIANT_BOOL* Result
);

​
C#

bool Flush(bool IsSaveRequired);

​
Visual Basic .NET

Function Flush(Boolean IsSaveRequired) As Boolean

​
Parameters

IsSaveRequired [in] ページに加えられた変更を保存するかどうかを指定します。ページが変更されていない場合、または変更の保存が不要な場合は FALSE を渡してください。 Result [out, retval] メソッドの実行結果を受け取る変数へのポインターです。メソッドが正常に完了した場合は TRUE、それ以外の場合は FALSE が返されます。

​
戻り値

このメソッドに固有の戻り値はありません。ABBYY FineReader Engine 関数の標準リターンコードを返します。

​
備考

Windowsでは、Flushメソッドの動作はIFRDocument::PageFlushingPolicyプロパティの値によって異なります。PageFlushingPolicyの値がPFP_FlushToDiskの場合、メソッドを呼び出すとLayoutおよび画像のDocumentがディスクにアンロードされます。PFP_Autoの場合、Documentに含まれるページ数が30を超えるときにメソッドを呼び出すとデータがディスクにアンロードされ、それ以外の場合はデータがメモリに保持されます。PFP_KeepInMemoryの場合、データはアンロードされません。これは、1つのソリューションで小規模と大規模の両方のDocumentを処理する場合に便利で、処理に同じコードを使用できます。

​
関連項目

FRPage IFRDocument::PageFlushingPolicy
Iterating Document Pages