ImageGear for C and C++ on Windows v19.7 - Updated
IG_dspl_grp_reset
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_grp_reset

This function resets all the options of the specified group to its default values.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_dspl_grp_reset(
        [IN] HIGEAR hIGear, 
        [IN] DWORD dwGrpID
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of group to reset.

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:

Display, Print

Example:

 
Copy Code
    HIGEAR hIGear; /* HIGEAR handle of image */ DWORD nGrpID; /* display group identifier */ ...
    IG_dspl_grp_reset( hIGear, nGrpID ); ...
 

Remarks:

Please note the application code is responsible for freeing memory allocated for options such as TranspMaskandBkBrush. This function does not free it.

This function also removes the flag that marks this group as "used." It may be set again by any display function that specifies using this group identifier.