Called for each hole punch found by LBitmap::HolePunchRemove.


#include "ltwrappr.h"

virtual L_INT LBitmap::HolePunchRemoveCallBack(hRgn, pBoundingRect, iHoleIndex, iHoleTotalCount, iWhiteCount, iBlackCount)



Windows region representing one of the holes of the hole punch pattern. It is the programmers responsibility to delete this region (using DeleteObject())when it is no longer needed.

PRECT pBoundingRect

Pointer to a RECT structure that contains the bounding rectangle of one of the holes in a hole punch pattern.

L_INT32 iHoleIndex

Index of the hole within a hole punch pattern. The holes are numbered from 1 to n, where n is the total number of holes in the hole punch pattern.

L_INT32 iHoleTotalCount

The total number of holes that make up the hole punch pattern. This value will not change for a particular call to LBitmap::HolePunchRemove().

L_INT32 iWhiteCount

Total number of white pixels in one of the holes of a hole punch pattern.

L_INT32 iBlackCount

Total number of black pixels in one of the holes of a hole punch pattern.


Value Meaning
SUCCESS_REMOVE Remove the hole.
SUCCESS_NOREMOVE Do not remove the hole.
Otherwise An error occurred. Refer to Return Codes.


This function is called once for each occurring hole in the hole punch configuration. For example, if there are three holes, the callback gets called three times. Return SUCCESS_REMOVE to have a particular hole removed. Return SUCCESS_NOREMOVE to leave the hole unchanged. Pass any other value to abort. This value will be the return value of the LBitmap::HolePunchRemove(). If HOLEPUNCH_IMAGE_UNCHANGED and HOLEPUNCH_SINGLE_REGION are being used, then the return value of this function affects only the internal single region that contains all the changes.

Required DLLs and Libraries


Win32, x64.

See Also




For an example, refer to LBitmap::HolePunchRemove.

Help Version 22.0.2023.2.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C++ Class Library Help