RAKEREMOVECALLBACK Function
#include "l_bitmap.h"
L_INT EXT_CALLBACK YourFunction (hRgn, nLength, pUserData)
L_HRGN hRgn; |
/* windows region */ |
L_INT nLength; |
/* rake length */ |
L_VOID * pUserData; |
/* pointer to additional parameters */ |
Handles each rake found by the L_RakeRemoveBitmap function.
Parameter |
Description |
hRgn |
Windows region representing a rake to be removed. It is the programmers responsibility to delete this region, using L_FreeBitmapRgn when it is no longer needed. |
nLength |
Length in pixels of the rake. |
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_RakeRemoveBitmap) function. |
|
Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function. |
Returns
SUCCESS_REMOVE |
Remove the rake. |
SUCCESS_NOREMOVE |
Do not remove the rake. |
Otherwise |
An error occurred. Refer to Return Codes. |
Comments
The callback is called for each rake found. Return SUCCESS_REMOVE to have the rake removed. Return SUCCESS_NOREMOVE to leave the rake unchanged. Pass any other value to abort. This value will be the return value of the L_RakeRemoveBitmap function.
Required DLLs and Libraries
LTIMGCOR For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Functions: |
|
Topics: |
|
|
Example
For an example, refer to L_RakeRemoveBitmap.