CreateFRDocumentFromImage Method of the Engine Object

CreateFRDocumentFromImage method of the Engine Object in the ABBYY FineReader Engine API — This method opens an image file and creates the FRDocument object.

This method opens image file and creates the FRDocument object.

Syntax

C++

HRESULT CreateFRDocumentFromImage(
  BSTR               ImageFileName,
  IPrepareImageMode* PrepareMode,
  IFRDocument**      Result
);

C#

IFRDocument CreateFRDocumentFromImage(
  string           ImageFileName,
  IPrepareImageMode PrepareMode
);

Visual Basic .NET

Function CreateFRDocumentFromImage( _
  ImageFileName As String, _
  PrepareMode As IPrepareImageMode, _
) As IFRDocument

Parameters

ImageFileName

[in] This variable contains a full path to the image file to open.

Example: Windows: C:\MyPictures\MyPic.bmp, Linux: /opt/MyPictures/MyPic.bmp, macOS: /Users/user/Pictures/MyPic.bmp

PrepareMode

[in] This parameter refers to the PrepareImageMode object which specifies how an image will be preprocessed during opening.

Result

[out, retval] A pointer to IFRDocument* pointer variable that receives the interface pointer of the resulting FRDocument 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

For Linux and Windows, if your license includes the Office Formats Opening module, you may also use this method to open digital documents of supported formats.

See also

Engine

FRDocument

CreateFRDocument