ImageGear for C and C++ on Windows v19.6 - Updated
IG_fltr_pagedelete_file_W
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Filter Functions > IG_fltr_pagedelete_file_W

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

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_fltr_pagedelete_file_W(
   const LPAT_WCHAR lpwszFileName,
   AT_MODE nFormatType,
   UINT nStartPage,
   UINT nRange
);

Arguments:

Name Type Description
lpwszFileName const LPAT_WCHAR Path and name of the multi-page file from which to delete pages, specified as a wide string (UTF-16). The path can be absolute or relative.
nFormatType AT_MODE 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 UINT Determines the first page to delete from the szFileName file.
nRange UINT 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 for C and C++.

Sample:

None

Example:

 
Copy Code
AT_ERRCOUNT     nErrcount;            // Count of returned errors on stack
nErrcount = IG_fltr_pagedelete_file_W(L"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 "Getting Information about a Format Filter" section in Loading and Saving.

This function may work slower on PDF and PostScript images, compared to its ANSI analog IG_fltr_pagedelete_file.