BORDERREMOVECALLBACK

Summary

Handles each border found by L_BorderRemoveBitmap.

Syntax

#include "l_bitmap.h"

L_INT pEXT_CALLBACK YourFunction(hRgn, uBorderToRemove, pBoundingRect, pUserData)

Parameters

HRGN hRgn

Windows region representing the border to be removed. It is the programmers responsibility to delete this region (using DeleteObject() when it is no longer needed).

L_UINT uBorderToRemove

Flag that indicates which border is being processed. Possible values are:

Value Meaning
BORDER_LEFT The left border is being processed.
BORDER_TOP The top border is being processed.
BORDER_RIGHT The right border is being processed.
BORDER_BOTTOM The bottom border is being processed.

PRECT pBoundingRect

Pointer to a RECT structure that contains the bounding rectangle of the border being processed.

L_VOID *pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_BorderRemoveBitmap.)

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

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

Comments

The callback is called once for each border found. It is called a maximum of four times for each call to the C API. Return SUCCESS_REMOVE to have the border removed. Return SUCCESS_NOREMOVE to leave the border unchanged. Pass any other value to abort. This value will be the return value of the L_BorderRemoveBitmap(). If flags BORDER_IMAGE_UNCHANGED and BORDER_SINGLE_REGION are being used, then the return value of the callback affects only the internal single region that contains all the changes.

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to L_BorderRemoveBitmap.

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

LEADTOOLS Raster Imaging C API Help

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