ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Filter Functions / IG_fltr_pageinfo_get_ex_W
In This Topic
    IG_fltr_pageinfo_get_ex_W
    In This Topic

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

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_fltr_pageinfo_get_ex_W(
       const LPAT_WCHAR lpwszFileName,
       UINT nPage,
       LPAT_MODE lpFileType,
       LPAT_MODE lpCompression,
       HIGDIBINFO* lphDIB
    );
    

    Arguments:

    Name Type Description
    lpwszFileName const LPAT_WCHAR Path and name of the file about which to get the information, specified as a wide string (UTF-16). The path can be absolute or relative.
    nPage UINT Number of the page in a multi-page file for which to get information.
    lpFileType LPAT_MODE Pointer to an AT_MODE variable in which the file type will be returned. See enumIGFormats for possible values.
    lpCompression LPAT_MODE Pointer to an AT_MODE variable in which compression type will be returned. See enumIGCompressions for possible values.
    lphDIB HIGDIBINFO* 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 for C and C++.

    Sample:

    GUI Windows

    Example:

     
    Copy Code
    AT_ERRCOUNT nErrCount;
    AT_MODE fileType;
    AT_MODE compression;
    HIGDIBINFO hDIB;
    
    nErrCount = IG_fltr_pageinfo_get_ex_W(L"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 "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_pageinfo_get_ex.