OpenBitmap Method of the Engine Object

OpenBitmap method of the Engine Object in the ABBYY FineReader Engine API — This method opens the specified bitmap image (HBITMAP) (Windows only).

This method is implemented in FRE for Windows.

This method opens the specified bitmap image (HBITMAP).

Syntax

C++

HRESULT OpenBitmap(
  __int64            BitmapHandle,
  int                XResolution,
  int                YResolution,
  IPrepareImageMode* PrepareMode
  IImageDocument**   Result
);

C#

IImageDocument OpenBitmap(
  Int64             BitmapHandle,
  int               XResolution,
  int               YResolution,
  IPrepareImageMode PrepareMode
);

Visual Basic .NET

Function OpenBitmap( _
  BitmapHandle As Int64, _
  XResolution As Integer, _
  YResolution As Integer, _
  [PrepareMode As IPrepareImageMode = Nothing] _
) As IImageDocument

Parameters

BitmapHandle

[in] Specifies the handle of the GDI object (HBITMAP). This handle should be available to the process that operates ABBYY FineReader Engine. The handle is passed as __int64.

XResolution

[in] Specifies the horizontal resolution of the bitmap.

YResolution

[in] Specifies the vertical resolution of the bitmap.

PrepareMode

[in] Refers to the PrepareImageMode object that stores parameters for bitmap conversion in internal format. This parameter may be 0 in which case default parameters of the image preparation mode are used, or, if a profile has been loaded, the parameters set by this profile are used.

Result

[out, retval] A pointer to IImageDocument* pointer variable that receives the interface pointer to the resulting ImageDocument object.

Return values

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

Linux and macOS: This method returns E_NOTIMPL.

Remarks

This method does not work if the Engine is loaded as an out-of-process server in Linux or if the object is created using the OutprocLoader object in Windows.

See also

Engine

PrepareBitmap