L_CompactFile

#include "l_bitmap.h"

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

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

Returns

Comments

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

• PageNumber: specifies the start page. Page 0 is the first page, page 1 is the second page, etc. The pages will be read starting with this page.

• Flags: specifies whether to use the IFD.

• IFD: used only if Flags contains the ELO_USEIFD flag. If ELO_USEIFD is not set, the PageNumber references the beginning of the file.

If pSaveFileOption is NULL, then if pszDstFile exists, it 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. TIF files are saved in two possible byte orders: Intel or Motorola (see SAVEFILEOPTIONS.Flags and ESO_MOTOROLAORDER flag.

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

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

• PageNumber: specifies the start page. This parameter is used as follows:

• If ESO_INSERTPAGE is set in Flags, all the pages are inserted before this page.

• If ESO_REPLACEPAGE is set in Flags, this page and the remaining uPages 1 will be replaced.

• If none of the above parameters are set, then:

•  If PageNumber is 0, the file will be overwritten.

•  If PageNumber is <> 0, the pages will be appended to the end of the file.

• IFD: can be used to speed up the file access for TIFF files with many pages. Used only if ESO_USEIFD is set in Flags.

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

• ESO_NOSUBFILETYPE if this flag is set, then the TGSUBFILETYPE tag will be stripped from all the pages.

• ESO_REPLACEPAGE if this is set, pages in pszDstFile are replaced starting with page PageNumber.

• ESO_INSERTPAGE - if this is set, all the pages are inserted before page PageNumber.

• ESO_USEIFD if this is set, the first page in pszDstFile is at offset IFD. All pages will be relative to that page. (Note that this might not be the first physical page in the file). This is a common technique for manipulating files with thousands of pages.

• ESO_MOTOROLAORDER if this is set and you are creating a new file, the pages will be saved in Motorola byte order. If the flag is not set, the pages will be saved in Inter byte order. If you are modifying an existing file, this flag has no meaning the pages will be saved in the same byte order used in the file.

Required DLLs and Libraries

Platforms

Windows 2000 / XP/Vista.

See Also

Example

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(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\srcfile.tif"), TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\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(TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\srcfile.tif"), TEXT("%UserProfile%\\My Documents\\LEADTOOLS Images\\dstfile.tif"), 0, NULL, &SaveFileOption); 
   if(nRet != SUCCESS) 
   {
      MessageBox(NULL, TEXT("Error compacting file!"), TEXT("ERROR"), MB_OK);
      return nRet;
   }
   return SUCCESS; 
}