In This Topic ▼

L_ReadFileStamp

Summary

Reads a thumbnail image stored in a file and loads it into a specified bitmap.

Syntax

#include "l_bitmap.h"

L_LTFIL_API L_INT L_ReadFileStamp(pszFile, pBitmap, uStructSize, pLoadOptions)

Parameters

L_TCHAR* pszFile

Character string containing the file name.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle referencing the bitmap that will contain the thumbnail image.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pBitmap, for versioning. Use sizeof(BITMAPHANDLE).

pLOADFILEOPTION pLoadOptions

Pointer to optional extended load options. Pass NULL to use the default load options.

Returns

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

Comments

Only EXIF, CMP, JPEG, FlashPix, HEIF/HEIC and PNG formats support stamps. However, not all files of these formats contain stamps.

At this time, the only multipage format that supports stamps is HEIF/HEIC.

If you know the file format of the file, you can achieve better performance by calling L_ReadFileStamp2.

Required DLLs and Libraries

LTFIL
File format DLLs
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, Linux.

Example

Reads a thumbnail image stored in a FlashPix file and loads it into a specified bitmap.
Then saves the thumbnail image into bmp image.

L_INT ReadFileStampExample(L_VOID) 
{ 
   L_INT nRet; 
   BITMAPHANDLE StampBitmap; 
   nRet = L_ReadFileStamp(MAKE_IMAGE_PATH(TEXT("STAMP.CMP")), 
                   &StampBitmap, sizeof(BITMAPHANDLE), NULL); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_SaveBitmap(MAKE_IMAGE_PATH(TEXT("Thumbnail.BMP")), 
                &StampBitmap, FILE_BMP, 24, 0, NULL); 
    
   if(StampBitmap.Flags.Allocated) 
      L_FreeBitmap(&StampBitmap); 
 
   return nRet; 
}