ScrollWindow 函式 (winuser.h)

發行項
03/13/2024

ScrollWindow 函式會捲動指定視窗工作區的內容。

注意提供 ScrollWindow 函式以進行回溯相容性。新的應用程式應該使用 ScrollWindowEx 函式。

語法

BOOL ScrollWindow(
  [in] HWND       hWnd,
  [in] int        XAmount,
  [in] int        YAmount,
  [in] const RECT *lpRect,
  [in] const RECT *lpClipRect
);

參數

[in] hWnd

類型： HWND

處理要捲動工作區的視窗。

[in] XAmount

類型： int

指定水平捲動的裝置單位數量。如果卷動的視窗具有 CS_OWNDC 或 CS_CLASSDC 樣式，則此參數會使用邏輯單元，而不是裝置單位。此參數必須是負值，才能向左卷動視窗的內容。

[in] YAmount

類型： int

指定垂直捲動的裝置單位數量。如果卷動的視窗具有 CS_OWNDC 或 CS_CLASSDC 樣式，則此參數會使用邏輯單元，而不是裝置單位。此參數必須是負值，才能向上捲動視窗的內容。

[in] lpRect

類型： const RECT*

RECT 結構的指標，指定要捲動之工作區的部分。如果此參數為 NULL，則會捲動整個工作區。

[in] lpClipRect

類型： const RECT*

包含裁剪矩形座標之 RECT 結構的指標。只有裁剪矩形內的裝置位會受到影響。從矩形外部捲動到內部的位會繪製;不會繪製從矩形內部捲動到外部的位。

傳回值

類型： BOOL

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果插入號位於卷動的視窗中， ScrollWindow 會自動隱藏插入號以防止清除插入號，然後在捲動完成後還原插入號。插入號位置會據以調整。

ScrollWindow 所發現的區域不會重新繪製，但會合併到視窗的更新區域。應用程式最終會收到 WM_PAINT 訊息，通知它必須重新繪製區域。若要在卷動作用中同時重新繪製發現的區域，請在呼叫 ScrollWindow 之後立即呼叫 UpdateWindow 函式。

如果 lpRect 參數為 NULL，則視窗中任何子視窗的位置會依 XAmount 和 YAmount 參數所指定的數量位移;視窗內 (未配對) 區域也會位移。當 lpRect 為 NULL 時，ScrollWindow 會更快。

如果 lpRect 不是 NULL，則子視窗的位置不會變更，而且視窗中的無效區域不會位移。若要避免在 lpRect 不是 NULL 時更新問題，請在呼叫 ScrollWindow 之前呼叫 UpdateWindow 以重新繪製視窗。

範例

如需範例，請參閱使用WM_PAINT訊息卷動文字。

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
目標平台	Windows
標頭	winuser.h (包括 Windows.h)
程式庫	User32.lib
Dll	User32.dll
API 集合	ext-ms-win-ntuser-window-l1-1-4 (於 Windows 10 10.0.14393 版)