CM SCROLLWINDOW

This message scrolls an entire container window.

Syntax

param1
USHORT fsScrollDirection; /* Scroll direction. */

param2
LONG lScrollInc;        /* Scroll increment. */

Parameters

fsScrollDirection (USHORT) - Input

Direction in which to scroll the container window:

CMA_VERTICAL: Scroll vertically.

CMA_HORIZONTAL: Scroll horizontally.

lScrollInc (LONG) - Input

Amount (in pixels) by which to scroll the window.

Returns

rc (BOOL) - returns

Success indicator.

TRUE: Successful completion.

FALSE: An error occurred. The WinGetLastError function may return the following error:

PMERR_INVALID_PARAMETERS.

Remarks

If the lScrollInc parameter value is greater than 0 and the CMA_HORIZONTAL attribute is specified, the container window is scrolled to the right. The container window is scrolled down if the lScrollInc parameter value is greater than 0 and the CMA_VERTICAL attribute is specified. Similarly, the container window is scrolled left and up, respectively, if the lScrollInc parameter value is less than 0 and the same two attributes are specified.

If you want the container window to be scrolled by an amount that is indicated with a key, such as the PgUp, PgDn, Home, and End keys, the application can send a key event to the scroll bar.

If the container window is displaying the split details view, the CM_HORZSCROLLSPLITWINDOW message is used for horizontal scrolling.

Default Processing

The default window procedure does not expect to receive this message and therefore takes no action on it other than to return FALSE.