LBitmapBase::Free

#include "ltwrappr.h"

virtual L_INT LBitmapBase::Free()

Frees the memory allocated for the bitmap data.

Returns

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

Comments

Call this function to free the memory allocated for the bitmap data. This function should be called when your program no longer needs the image data. If the bitmap was allocated in disk memory, this function deletes the temporary file. If the bitmap has a region defined, this function also frees the region. If the bitmap has a palette, it will be deleted too. After this function returns, the internal bitmap handle will be invalidated.

Note:

You do not have to call LBitmapBase::Free unless you explicitly want to free the memory. The class object will automatically free the bitmap when it is destroyed.

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.

See Also

Functions:	LBitmapBase::Allocate, LBitmapBase::Initialize, LBitmapBase::SetHandle, Class Members
Topics:	Raster Image Functions: Creating and Deleting Images

Example

L_INT LBitmapBase__FreeExample()
{
   L_INT nRet;
   LBitmapBase MyBitmap;
   MyBitmap.SetFileName(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\Image1.cmp"));
   nRet =MyBitmap.Load();
   if(nRet !=SUCCESS)
      return nRet;
   if(MyBitmap.IsAllocated())
      nRet = MyBitmap.Free();
   return nRet;
}