ImageGear Professional DLL v17.1 for Windows Accusoft
IG_fltr_pagedelete_file
Send Feedback  
ImageGear Professional DLL v17.1 for Windows > API Reference Guide > Core Component API Reference > Core Component Functions Reference > Filter Functions > IG_fltr_pagedelete_file

Glossary Item Box

This function deletes pages from a multipage file, if such operation is supported by the format filter.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_fltr_pagedelete_file(
   const LPSTR lpszFileName,
   AT_MODE nFormatType,
   UINT nStartPage,
   UINT nRange
);

Arguments:

lpszFileName Path and name of the multipage file to delete pages from. The path can be absolute or relative.
nFormatType A constant indicating the file format of the input file. See enumIGFormats for possible values. Set to IG_FORMAT_UNKNOWN to let ImageGear detect the file format.
nStartPage Determines the first page to delete from the szFileName file.
nRange Determines the number of pages to delete, starting from nStartPage.

Return Value:

Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear Professional.

Sample:

None

Example:

  Copy Code
AT_ERRCOUNT     nErrcount;            // Count of returned errors on stack
nErrcount = IG_fltr_pagedelete_file("picture_multipage.tif", IG_FORMAT_TIF, 1, 1);

Remarks:

Use IG_fltr_info_get function to determine whether the format filter supports page deletion. If the flags returned by this function contain IG_FLTR_PAGEDELETESUPPORT, then the format filter supports the deleting procedure.

See also the section Getting Information and Sorting Images.

Currently only TIFF filter supports this procedure.

©2012. Accusoft Corporation. All Rights Reserved.