#include "l_bitmap.h"

L_LTFIL_API L_INT L_CompactFile(pszSrcFile, pszDstFile, uPages, pLoadFileOption, pSaveFileOption)

L_TCHAR* pszSrcFile;

name of the source file being compacted

L_TCHAR* pszDstFile;

name of the file in which the data will be written

L_UINT uPages;

number of pages to copy


optional pointer to the LOADFILEOPTION structure


optional pointer to the SAVEFILEOPTION structure

Compacts TIFF / BigTIFF files. It can also be used to copy or extract one or more pages from a TIFF / BigTIFF file and copy them without recompression to another TIFF / BigTIFF file.




Character string containing the name of the file being compacted. All of the pages will be read from this file.


Character string containing the name of the file to which all the pages will be written. This cannot be NULL. If this is NULL, the function will return an error. The pages can be added to this file using the pSaveFileOption parameter.


Value that represents the number of pages to copy. Use 0 to copy all of the pages. If uPages is > 0, only uPages will be copied to pszDstFile.


Optional pointer to the LOADFILEOPTION structure, which can be used to specify a starting page. You can speed up access to the starting page by using the IFD. Passing NULL is equivalent to starting from the first page and to use the default load options.


Optional pointer to the SAVEFILEOPTION structure, which can be used to specify where to save the data or how to modify an existing file. You can modify whether the new pages should appended, inserted, or replace existing pages. Pass NULL to use the default save options.



The function was successful.


The function encountered an error while reading a page from the source file. Not all of the pages have been copied to the destination file.

ERROR_TAG_VALUE_TOO_BIG This error can occur while converting BigTIFF files to regular TIFF files when the source file contains a 64-bit integer value that cannot be converted into a 32-bit integer value due to overflow.  This error can occur because TIFF files do not support 64-bit integer values.

< 1

An error occurred. Refer to Return Codes.


This function can also be used to convert a TIFF file to BigTIFF and vice versa (BigTIFF -> TIFF).

The following members of the LOADFILEOPTION structure are important for this function:

If pSaveFileOption is NULL and if pszDstFile exists, pszDstFile will be overwritten regardless of its format. Also, defaults will be used when saving the file (it will be saved in Intel format). Refer to the SAVEFILEOPTION documentation. TIFF files can be saved either in Intel or Motorola byte order (see SAVEFILEOPTIONS.Flags and the ESO_MOTOROLAORDER flag.)

NOTE: To save a region inside a TIFF file, you must have an unlocked  Document or Medical Imaging license.

If pSaveFileOption is not NULL, the following members of the SAVEFILEOPTION structure are important for this function:

Flags: can be used to specify one or more options:

Flags2: Can be used to specify one or more of the following options:

IFD64 offsets are useful only when processing BigTIFF files in 32-bit applications. For such files, the IFD pointer can be a 64-bit value > 0xFFFFFFFF. Because IFD is already a 64-bit value in 64-bit applications, IFD64 is not defined in 64-bit applications. In addition, regular TIFF files cannot use 64-bit pointers, so it is not necessary to use IFD64 with TIFF files.

Required DLLs and Libraries



For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.


Win32, x64, Linux.

See Also


L_SaveFile, L_LoadFile, L_FileInfo, L_GetDefaultLoadFileOption, L_GetDefaultSaveFileOption


Loading and Saving Large TIFF/BigTIFF Files


Raster Image Functions: Loading Files


Raster Image Functions: Saving Files


The first example will compact all the pages in a TIFF file. It will create a new file called dstfile.tif.

The second example will compact all the pages in a TIFF file. It will append all the pages to an existing file called dstfile.tif.

L_INT CompactFileFirstExample(L_VOID) 
   L_INT nRet; 
   nRet = L_CompactFile(MAKE_IMAGE_PATH(TEXT("clean.tif")),MAKE_IMAGE_PATH(TEXT("dstfile.tif")), 0, NULL, NULL); 
   if(nRet != SUCCESS) 
      MessageBox(NULL, TEXT("Error compacting file!"), TEXT("ERROR"), MB_OK); 
      return nRet; 
   return SUCCESS; 
L_INT CompactFileSecondExample(L_VOID) 
   L_INT nRet; 
   SAVEFILEOPTION SaveFileOption; 
   nRet = L_GetDefaultSaveFileOption(&SaveFileOption, sizeof(SaveFileOption)); 
   if(nRet != SUCCESS) 
      return nRet; 
   SaveFileOption.PageNumber = 2; 
   nRet = L_CompactFile(MAKE_IMAGE_PATH(TEXT("clean.tif")),MAKE_IMAGE_PATH(TEXT("dstfile.tif")), 0, NULL, &SaveFileOption);  
   if(nRet != SUCCESS)  
      MessageBox(NULL, TEXT("Error compacting file!"), TEXT("ERROR"), MB_OK); 
      return nRet; 
   return SUCCESS;  

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help