LBitmapBase::ToggleCompression (original) (raw)
✎ NOTE
This function is now obsolete. New applications should use the LBitmapBase::ChangeCompression function.
Summary
Toggles the compression of the bitmap.
Syntax
#include "ltwrappr.h"
virtual L_INT LBitmapBase::ToggleCompression(L_VOID)
Returns
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
Comments
This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.
(Document/Medical only) If the specified bitmap is compressed, calling this function will make the bitmap uncompressed. If the bitmap is uncompressed, calling this function will make the bitmap compressed.
This function only works for 1 bit per pixel images.
Required DLLs and Libraries
- LTKRN
- LTWVC
- 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.
See Also
Functions
Topics
Example
L_INT LBitmapBase__ToggleCompressionExample()
{
L_INT nRet;
LBitmapBase LeadBitmap; /* Bitmap handle to hold the loaded image. */
pBITMAPHANDLE pLeadBitmapHandle = LeadBitmap.GetHandle();
/* Load the bitmap, keeping the bits per pixel of the file */
nRet = LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("OCR1.TIF")), 0, ORDER_BGR);
if(nRet !=SUCCESS)
return nRet;
LeadBitmap.ToggleCompression();
nRet = LeadBitmap.Save (MAKE_IMAGE_PATH(TEXT("Result.BMP")), FILE_BMP, 24, 0, NULL);
if(nRet !=SUCCESS)
return nRet;
//free bitmap
if(pLeadBitmapHandle->Flags.Allocated)
L_FreeBitmap(pLeadBitmapHandle);
return SUCCESS;
}
LEADTOOLS Raster Imaging C++ Class Library Help