LBitmapBase::Free

Summary

Frees the memory allocated for the bitmap data.

Syntax

#include "ltwrappr.h"

virtual L_INT LBitmapBase::Free()

Returns

Value Meaning
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

Platforms

Win32, x64.

See Also

Functions

Topics

Example

L_INT LBitmapBase__FreeExample() 
{ 
   L_INT nRet; 
   LBitmapBase MyBitmap; 
 
   MyBitmap.SetFileName(MAKE_IMAGE_PATH(TEXT("Image1.cmp"))); 
   nRet =MyBitmap.Load(); 
   if(nRet !=SUCCESS) 
      return nRet; 
 
   if(MyBitmap.IsAllocated()) 
      nRet = MyBitmap.Free(); 
 
   return nRet; 
 
 
}
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++ Class Library Help
Introduction
Version History
Getting Started
LEADTOOLS Raster Imaging Features
Redistributables/Files To Be Included With Your Application
Quick Reference
Classes and Member Functions
Summary of Features
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.