ImageGear for C and C++ on Windows v19.10 - Updated
IG_GUI_magnify_attribute_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > GUI Functions > GUI Magnify Functions > IG_GUI_magnify_attribute_get

This function is used to get the various attributes of the Magnifier window.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_GUI_magnify_attribute_get(
        HWND hwndMag, 
        AT_MODE nAttributeID,
        LPVOID lpData
);

Arguments:

Name Type Description
hwndMag HWND Handle to the Magnifier Window created by the IG_GUI_magnify_window_create(). If a popup magnifier is being used, then specify NULL for this parameter.
nAttributeID AT_MODE One of the GUI Magnify control options defined in accucnst.h.
LpData LPVOID

The value currently assigned to the attribute will be returned here. The value depends on the nAttributeID value:

  • IG_GUI_MAGNIFY_POPUP_WIDTH - Width, in pixels of the window
  • IG_GUI_MAGNIFY_POPUP_HEIGHT - Height, in pixels, of the window
  • IG_GUI_MAGNIFY_POPUP_ZOOM - Zoom factor (2 = 2x, 10=10x, etc.)
  • IG_GUI_MAGNIFY_POPUP_CIRCLE - Only used for Popup window TRUE (circle) or FALSE (square) - Win32 only.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

Magnify, GUI Windows

Remarks:

See the function IG_GUI_magnify_window_create.