AUTO_SCROLL_DATA structure (shlobj_core.h)

Article
02/22/2024

[AUTO_SCROLL_DATA is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Specifies scrolling parameters and keeps track of the last scroll operation.

Syntax

typedef struct {
  int   iNextSample;
  DWORD dwLastScroll;
  BOOL  bFull;
  POINT pts[NUM_POINTS];
  DWORD dwTimes[NUM_POINTS];
} AUTO_SCROLL_DATA;

Members

iNextSample

Type: int

A value that indicates the number of times the DAD_AutoScroll function has stored data in the structure. The parameter is reset to 0 after it equals 2.

dwLastScroll

Type: DWORD

A DWORD that indicates the time of the last scroll. The scroll time is also stored in the dwTimes parameter indexed by the current value of iNextSample.

bFull

Type: BOOL

A value that is used to determine whether the DAD_AutoScroll function should succeed. This parameter is set to TRUE when the iNextSample parameter is equal to NUM_POINTS.

(FALSE)

Default. Indicates that the window should not scroll.

(TRUE)

Indicates that the window should scroll.

pts[NUM_POINTS]

Type: POINT[NUM_POINTS]

A pointer to the current scroll coordinates. The index of this array is iNextSample.

dwTimes[NUM_POINTS]

Type: DWORD[NUM_POINTS]

A DWORD that indicates the current scroll time. The index of this array is iNextSample.

Remarks

NUM_POINTS is currently set to 3.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	shlobj_core.h (include Shlobj.h)

Share via