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

    This function returns the foreground color.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT  ACCUAPI   IG_dspl_foreground_get(
            [IN] HIGEAR hIGear,
            [IN] DWORD dwGrpID,
            [OUT] LPAT_RGB lpFrColor
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR The ImageGear handle of an image.
    dwGrpID DWORD Identifier of the group to use.
    lpFrColor LPAT_RGB Pointer to where the FrColor option is returned. If NULL, then this parameter is ignored.

    Return Value:

    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:

    None

    Example:

     
    Copy Code
    HIGEAR hIGear;        /* HIGEAR handle of image   */
    DWORD nGrpID;        /* display group identifier  */
    AT_RGB FrColor;       /* foreground color  */
     ...
    IG_dspl_foreground_get( hIGear, nGrpID, &FrColor );
     ...