ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / ArtX Component API Reference / ArtX Component Objects Reference / HIG_ARTX_IMAGE_EMBEDDED / IG_ARTX_image_embedded_transparent_color_get
In This Topic
    IG_ARTX_image_embedded_transparent_color_get
    In This Topic

    This function queries annotation transparent color.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_ARTX_image_embedded_transparent_color_get(
            HIG_ARTX_IMAGE_EMBEDDED hMark,
            LPAT_RGBQUAD lpColor,
            LPAT_UINT pnDataSize
    );
    

    Arguments:

    Name Type Description
    hMark HIG_ARTX_IMAGE_EMBEDDED Annotation handle.
    lpColor LPAT_RGBQUAD Pointer to storage for the transparent color value.
    pnDataSize LPAT_UINT Pointer to the variable that on input contains size of buffer specified by lpColor parameter. On output it contains the number of bytes copied to lpColor buffer.

    Return Value:

    Error count.

    Supported Raster Image Formats:

    This function does not process image pixels.

    Remarks:

    If transparent color is specified for the annotation, then it is copied into the output buffer lpColor and the number of bytes copied is placed into pnDataSize.

    If lpColor is NULL and pnDataSize is not NULL, then on output pnDataSize contains the size of AT_RGBQUAD structure.

    If lpColor is not NULL and pnDataSize is not NULL and there is no transparent color in the annotation, then on output pnDataSize contains zero.