L_ClearBitmap
#include "l_bitmap.h"
L_LTKRN_API L_INT L_ClearBitmap(pBitmap)
pBITMAPHANDLE pBitmap; |
/* pointer to the bitmap handle */ |
Sets all bits to 0 in the specified bitmap, making it a black bitmap.
Parameter |
Description |
pBitmap |
Pointer to the bitmap handle referencing the bitmap to clear. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To update a status bar or detect a user interrupt during execution of this function, refer to L_SetStatusCallback.
Required DLLs and Libraries
LTKRN For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Platforms
Windows 2000 / XP/Vista, Windows CE.
See Also
Functions: |
|
|
|
|
|
|
|
Topics: |
Example
For complete sample code, refer to the COMPCB example. This example loads a bitmap and clears it.
L_INT ClearBitmapExample(L_VOID) { L_INT nRet; BITMAPHANDLE LeadBitmap; /* Bitmap handle to hold the loaded image. */ /* Load the bitmap, keeping the bits per pixel of the file */ nRet = L_LoadBitmap (TEXT("C:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\IMAGE1.CMP"), &LeadBitmap, sizeof(BITMAPHANDLE), 0, ORDER_BGR, NULL, NULL); if(nRet != SUCCESS) return nRet; /* Clear the bitmap */ nRet = L_ClearBitmap(&LeadBitmap); if(nRet != SUCCESS) return nRet; nRet = L_SaveBitmap(TEXT("C:\\Program Files\\LEAD Technologies\\LEADTOOLS 15\\Images\\Result.BMP"), &LeadBitmap, FILE_BMP, 24, 0, NULL); if(nRet != SUCCESS) return nRet; if(LeadBitmap.Flags.Allocated) L_FreeBitmap(&LeadBitmap); return SUCCESS; }