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

Glossary Item Box

This function obtains information about the page specified by the nPage parameter from a named multipage file without actually loading it.

Declaration:

  Copy Code
AT_ERRCOUNT ACCUAPI IG_fltr_pageinfo_get_ex(
   const LPSTR lpszFileName,
   UINT nPage,
   LPAT_MODE lpFileType,
   LPAT_MODE lpCompression,
   HIGDIBINFO * lphDIB
);

Arguments:

lpszFileName Path and name of the file to get the information about. The path can be absolute or relative.
nPage Number of the page in a multi-page file for which to get information.
lpFileType Pointer to an AT_MODE variable in which the file type will be returned. See enumIGFormats for possible values.
lpCompression Pointer to an AT_MODE variable in which compression type will be returned. See enumIGCompressions for possible values.
lphDIB Pointer to HIGDIBINFO object to which other file information, such as width, height, Bits Per Pixel etc. will be returned.

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;
AT_MODE fileType;
AT_MODE compression;
HIGDIBINFO hDIB;

nErrCount = IG_fltr_pageinfo_get_ex("picture.tif", 1,
    &fileType, &compression, &hDIB);
if(nErrCount == 0)
{
    // ...
    // Delete DIB info
    IG_DIB_info_delete(hDIB);
}

Remarks:

Any of the output parameters such as lpFileType, lpCompression or lphDIB can be NULL, if the corresponding info is not required.

See also the section Getting Information and Sorting Images.

This function is identical to IG_info_get_ex.

©2012. Accusoft Corporation. All Rights Reserved.