このメソッドは、Linux および Windows 版の FRE に実装されています。
このメソッドはクライアント側で実装されます。ソースの画像処理キューから次の画像ドキュメントを返します。
GetNextImageDocument メソッドの実装には、次の画像ドキュメントを待機する時間を含めることができます。ただし、FineReader Engine はマルチスレッドではないため、長時間待機する実装は推奨されません。次のドキュメントを待機している間、Engine は認識プロセスからのメッセージを処理できず、ページ処理完了の通知も受け取れません。どうしても長い待機時間を指定する必要がある場合は、GetNextImageDocument メソッドで 0 を返すことができます。この場合、Engine は認識プロセスからのメッセージの処理と認識済み画像の提供を継続し、しばらくしてから画像キューが空かどうかを確認します。キューが空でない場合 (つまり、IImageSource::IsEmpty が FALSE を返す場合) 、Engine は GetNextImageDocument メソッドを再度呼び出します。ただし、GetNextImageDocument メソッドが 0 を返し、かつ処理対象のページがもう存在しない場合、FineReader Engine は制御をユーザーに返します。このとき、IBatchProcessor::GetNextProcessedPage メソッドは 0 を返します。
- キュー内のすべての ImageDocument オブジェクトは、処理が終了するまで有効でなければなりません。正しく動作させるには、ImageDocument オブジェクトは Engine オブジェクトを介して作成する必要があります。FRDocument オブジェクトを介して作成した場合、GetNextImageDocument メソッドの呼び出し中に FRDocument オブジェクトが破棄されるため、エラーが発生することがあります。
- このメソッドはクライアント側で実装されるため、次の制限があります。
HRESULT GetNextImageDocument( IImageDocument** Result );
IImageDocument GetNextImageDocument();
Function GetNextImageDocument() As IImageDocument
Result
[out, retval] キュー内の次の画像ドキュメントにアクセスするための、IImageDocument* へのポインター変数を指すポインターです。
[C++のみ] このメソッドが S_OK 以外の値を返した場合は、クライアント側でエラーが発生したことを示します。
このメソッドのクライアント実装では、メソッド内でスローされたすべての例外を確実にキャッチして処理し、いかなる例外もメソッドの外部に伝播しないようにする必要があります。例外がメソッドの外部に伝播すると、予期しない結果 (プログラムの終了など) を招くおそれがあります。
// 画像ファイルのキューを保持するカスタム画像ソースの実装例
public class ImageSourceCallback : FREngine.IImageSource
{
public ImageSourceCallback( string imageFilesDirectory )
{
imageFiles = ImageSourceHelper.LoadFilesNames( imageFilesDirectory );
nextFileIndex = 0;
}
public bool IsEmpty()
{
return nextFileIndex >= imageFiles.Length;
}
public FREngine.IFileAdapter GetNextImageFile()
{
if( !IsEmpty() ) {
return new FileAdapterCallback( imageFiles[nextFileIndex++] );
}
return null;
}
public FREngine.IImageDocument GetNextImageDocument()
{
...
}
private string[] imageFiles;
private int nextFileIndex;
}
public class FileAdapterCallback : FREngine.IFileAdapter
{
...
}
public class ImageSourceHelper
{
...
}
IImageSource
GetNextImageFile
IsEmpty
ImageDocument