LoadImageDoc Method of the Engine Object

This method restores the contents of the ImageDocument object from the folder on disk. The ImageDocument can be saved in a folder on disk using the following methods:

SaveTo method of the ImageDocument object
PrepareBitmap (Win), PrepareBitmapBits (Win), PrepareDib (Win) methods of the Engine object.

Please notice that the files on disk in the internal format cannot be deleted until the resulting ImageDocument object is released. This is due to the fact that, for improving the performance of the method, not all the data is loaded immediately. Some of the data is only loaded from the files on demand.

Syntax

C++

HRESULT LoadImageDoc(
  BSTR             FolderName,
  IImageDocument** Result
);

C#

IImageDocument LoadImageDoc( string FolderName );

Visual Basic .NET

Function LoadImageDoc(FolderName As String) As IImageDocument

Parameters

FolderName [in] This variable contains the full path to the folder with image document. Result [out, retval] A pointer to IImageDocument* pointer variable that receives the interface pointer to the resulting ImageDocument object. Must not be NULL.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

Remarks

This method is primarily designed for multi-page scenarios when it is not possible to keep all the images in memory. In this case, ImageDocument objects are saved on disk, and then LoadImageDoc method is called as needed.

Overview

Functions

Engine Object (IEngine Interface)

Engine Loaders

Image-Related Objects

Layout-Related Objects

Language-Related Objects

Text-Related Objects

Document-Related Objects

Batch Processor

Mechanism Objects

Parameter Objects

Classification-Related Objects

License-Related Objects

Document Comparison Objects

Supplementary Objects and Methods

Enumerations

LoadImageDoc Method of the Engine Object

Syntax

C++

C#

Visual Basic .NET

Parameters

Return values

Remarks

See also

​Syntax

​C++

​C#

​Visual Basic .NET

​Parameters

​Return values

​Remarks

​See also

Syntax

C++

C#

Visual Basic .NET

Parameters

Return values

Remarks

See also