OpenBitmapBits Method of the Engine Object

This method opens the specified bitmap data and supports the following image formats:

  • 1-bit monochrome (each pixel is represented as 1 bit).
  • 8-bit gray (each pixel is represented as 8 bits).
  • 24-bit color (each 24 bits use 8 bits of each R, G, B component).



HRESULT OpenBitmapBits(
  BitmapBitsFormatEnum Format,
  int                  Width,
  int                  Height,
  int                  ByteWidth,
  int                  XResolution,
  int                  YResolution,
  __int64              RawDataPtr,
  IPrepareImageMode*   PrepareMode,
  IImageDocument**     Result


IImageDocument OpenBitmapBits(
  BitmapBitsFormatEnum Format,
  int                  Width,
  int                  Height,
  int                  ByteWidth,
  int                  XResolution,
  int                  YResolution,
  Int64                RawDataPtr,
  IPrepareImageMode    PrepareMode

Visual Basic .NET

Function OpenBitmapBits( _
  Format As BitmapBitsFormatEnum, _
  Width As Integer, _
  Height As Integer, _
  ByteWidth As Integer, _
  XResolution As Integer, _
  YResolution As Integer, _
  RawDataPtr As Int64, _
  [PrepareMode As IPrepareImageMode = Nothing] _
) As IImageDocument


[in] This parameter of the BitmapBitsFormatEnum type describes the format of the bitmap data to be opened.
[in] Specifies the width of the bitmap in pixels. This parameter must not be 0.
[in] Specifies the height of the bitmap in pixels. This parameter must not be 0.
[in] Specifies the width of the line of bitmap in bytes (padding included). This parameter must not be 0.
[in] Specifies the horizontal resolution of the bitmap in dots per inch.
[in] Specifies the vertical resolution of the bitmap in dots per inch.
[in] This parameter is treated as a handle to memory buffer containing bitmap data.  The handle is passed as __int64. See the description of the BitmapBitsFormatEnum constants for details on the data format.
[in] Refers to the PrepareImageMode object that defines the mode of image preparation. It may be 0, in which case default values for the PrepareImageMode properties will be used, or, if a profile has been loaded, the parameters set by this profile are used.
[out, retval] A pointer to IImageDocument* pointer variable that receives the interface pointer of the resulting ImageDocument object.

Return values

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


This method does not work if the Engine object is created using the OutprocLoader object.

See also



Working with Profiles

24.03.2023 8:51:52

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.