Функция GetScrollBarInfo (winuser.h)

  • Статья

Функция GetScrollBarInfo извлекает сведения об указанной полосе прокрутки.

Синтаксис

BOOL GetScrollBarInfo(
  [in]  HWND           hwnd,
  [in]  LONG           idObject,
  [out] PSCROLLBARINFO psbi
);

Параметры

[in] hwnd

Тип: HWND

Дескриптор окна, связанного с полосой прокрутки, сведения о которой требуется извлечь. Если параметр idObject имеет значение OBJID_CLIENT, hwnd — это дескриптор элемента управления полосы прокрутки. В противном случае hwnd — это дескриптор окна, созданного с WS_VSCROLL и (или) WS_HSCROLL стилем.

[in] idObject

Тип: LONG

Указывает объект полосы прокрутки. Этот параметр может принимать одно из указанных ниже значений.

Значение Значение
OBJID_CLIENT
 Параметр hwnd — это дескриптор для элемента управления полосой прокрутки.
OBJID_HSCROLL
 Горизонтальная полоса прокрутки вешенного окна.
OBJID_VSCROLL
 Вертикальная полоса прокрутки вешенного окна.

[out] psbi

Тип: PSCROLLBARINFO

Указатель на структуру SCROLLBARINFO для получения сведений. Перед вызовом GetScrollBarInfo задайте для элемента cbSizeзначение sizeof(SCROLLBARINFO).

Возвращаемое значение

Тип: BOOL

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

Если idObject OBJID_CLIENT и окно, указанное hwnd , не является системным элементом управления полосой прокрутки, система отправляет SBM_GETSCROLLBARINFO сообщение в окно для получения сведений о полосе прокрутки. Это позволяет GetScrollBarInfo работать с пользовательским элементом управления, который имитирует полосу прокрутки. Если окно не обрабатывает сообщение SBM_GETSCROLLBARINFO , функция GetScrollBarInfo завершается ошибкой.

Требования

Требование Значение
Минимальная версия клиента Windows Vista [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header winuser.h (включая Windows.h)
Библиотека User32.lib
DLL User32.dll
Распространяемые компоненты Пакет обновления 6 (SP6)
Набор API ext-ms-win-ntuser-misc-l1-2-0 (представлено в Windows 8.1)

См. также раздел

SCROLLBARINFO