ImageGear for C and C++ on Linux v19.10 - Updated
IG_PDE_softmask_get_backdrop_color
API Reference Guide > PDF Component API Reference > PDF Component Objects Reference > Page Editing Objects and Elements > HIG_PDE_SOFTMASK > IG_PDE_softmask_get_backdrop_color

Gets the array of color values of the backdrop color.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_PDE_softmask_get_backdrop_color (
        HIG_PDE_SOFTMASK hSoftMask,
        LPAT_PDF_FIXED lpColorValues, 
        LONG nColorValuesLen,
        LPLONG lpnCount 
);

Arguments:

Name Type Description
hSoftMask HIG_PDE_SOFTMASK The soft mask object.
lpColorValues LPAT_PDF_FIXED Pointer to an array of color values. If NULL, the number of color values is returned in lpnCount.
nColorValuesLen LONG Length of the array lpColorValues.
lpnCount LPLONG Number of values copied.

Return Value:

Error count.

Supported Raster Image Formats:

This function does not process image pixels.

Remarks:

Given a pointer to an array and the length of the array, copies the color values to that array and returns the number of values copied. If the pointer to the array is NULL, the number of color values is returned in lpnCount.