Classes and Member Functions > LBitmapBase > LBitmapBase Member Functions > LBitmapBase::Clear

LBitmapBase::Clear

#include "ltwrappr.h"

virtual L_INT LBitmapBase::Clear(void)

Sets all bits to 0 in the specified bitmap, making it a black bitmap.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Call this function to clear the bitmap data, this will fill the bitmap data with zeros.

Required DLLs and Libraries

LTDIS
LTFIL

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

Win32, x64.

Example

#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName 
L_INT LBitmapBase__ClearExample() 
{ 
   L_INT nRet; 
   LBitmapBase MyBitmap; 
   MyBitmap.SetFileName(MAKE_IMAGE_PATH(TEXT("Image1.cmp"))); 
   nRet =MyBitmap.Load(); 
   if(nRet !=SUCCESS) 
      return nRet; 
   nRet =MyBitmap.Clear(); 
   if(nRet !=SUCCESS) 
      return nRet; 
   return SUCCESS; 
}