GetBitmap Method of the Image Object

This method returns a part of the image as a top-down DIB (Device-Independent Bitmap). The palette, where 0 is the black color, is used for gray and black-and-white images.

The method returns the DIB as the Handle object. This object manages memory allocation and releases resources when they are no longer in use.



HRESULT GetBitmap(
  IImageModification* Modification,
  IHandle**           Result


IHandle GetBitmap( IImageModification Modification );

Visual Basic .NET

Function GetBitmap(Modification As IImageModification) As IHandle


[in] This parameter of type ImageModification defines modifications that are performed upon image. It may include clipping rectangles, in which case only specified parts of the image are passed, stretch ratio, painting rectangles for filling up parts of the image with color and so on. This parameter may be 0, and in this case no modifications will be performed upon the image page and it will be passed "as is."
[out, retval] A pointer to IHandle* pointer variable that receives interface pointer of the resulting Handle object representing the handle to the associated bitmap.

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.


C# code

The method is used in the following demo tools: Camera OCR, Engine Predefined Processing Profiles, Image Preprocessing.

See also



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.