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

This function scrolls the image to a specified position and updates the window's scroll bars accordingly.

Declaration:

 
Copy Code
AT_ERRCOUNT  ACCUAPI  IG_dspl_scroll_to_ex( 
        [IN] HIGEAR hIGear, 
        [IN] DWORD dwGrpID,
        [IN] HWND hWnd,
        [IN] INT nXPos,
        [IN] INT nYPos,
        [OUT] LPAT_SCROLL_INFO lpScrollInfo
        [IN] BOOL bRepaint
);

Arguments:

Name Type Description
hIGear HIGEAR ImageGear handle of image.
dwGrpID DWORD Identifier of group where to work.
hWnd HWND Handle of window where image is drawn and scrolled.
nXPos INT New horizontal scroll position. Should be in a valid range that can be retrieved using the IG_dspl_scroll_get() function.
nYPos INT New vertical scroll position. Should be in a valid range that can be retrieved using the IG_dspl_scroll_get() function.
lpScrollInfo LPAT_SCROLL_INFO Where to copy the new scroll parameters. If NULL then the parameter is ignored.
bRepaint BOOL This parameter determines if the function repaints scrolling content (TRUE) or not (FALSE).

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

Remarks:

It can be used even if a window's scroll bars are disabled. Both scroll positions should be in valid scroll range but if not, then the nearest valid value will be assigned.

This function is the same as IG_dspl_scroll_to() function, but has bRepaint parameter that when FALSE allows do not repaint the scrolling content.