ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_IMAGE > IG_PDE_image_is_data_encoded

Determines if image data is encoded or not. Used only for inline images; not relevant to XObject images.


Copy Code
AT_ERRCOUNT ACCUAPI IG_PDE_image_is_data_encoded(
        HIG_PDE_IMAGE hImage,
        LPAT_PDF_BOOL lpbIsEncoded,
        LPDWORD lpnEncodedLen


Name Type Description
hImage HIG_PDE_IMAGE Image to examine.
lpbIsEncoded LPAT_PDF_BOOL TRUE if IG_PDE_image_get_data returns encoded data; FALSE otherwise. Returns FALSE for XObject images.
lpnEncodedLen LPDWORD Length of the encoded data-if the data is encoded, that is, if lpbIsEncoded returns TRUE.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.


lpbIsEncoded always returns FALSE for XObject images; XObject image data can be obtained from IG_PDE_image_get_data or IG_PDE_image_get_data_stream, either encoded or decoded.

Only if IG_PDE_image_create is used to explicitly create a new image using encoded data does lpbIsEncoded returns TRUE.

Is this page helpful?
Yes No
Thanks for your feedback.