ImageGear for C and C++ on Linux v19.10 - Updated
IG_dspl_scroll_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Display Functions > IG_dspl_scroll_get

This function calculates and returns the current scroll parameters.

Declaration:

 
Copy Code
AT_ERRCOUNT   ACCUAPI  IG_dspl_scroll_get( 
        [IN] HIGEAR hIGear, 
        [IN] DWORD dwGrpID,
        [IN] HWND hWnd,
        [OUT] LPAT_MODE lpnScrollMode,
        [OUT] LPAT_SCROLL_INFO lpScrollInfo
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of group from which to retrieve scroll parameters.
hWnd HWND Handle of window where image is drawn.
lpnScrollMode LPAT_MODE Where ScrollbarMode is to be received. If NULL, then this parameter is ignored.
lpScrollInfo LPAT_SCROLL_INFO Where to copy the current scroll parameters. 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++.

Example:

 
Copy Code
HIGEAR            hIGear;        /* HIGEAR handle of image   */ 
DWORD           nGrpID;        /* display group identifier  */
AT_MODE          nScrollMode;      /* scroll mode   */
AT_SCROLL_INFO  ScrollInfo;   /* scroll info  */
 ...
IG_dspl_scroll_get( hIGear, nGrpID, hWnd, &nScrollMode, &ScrollInfo );
 ...