Função GetScrollPos (winuser.h)

Artigo
08/27/2023

A função GetScrollPos recupera a posição atual da caixa de rolagem (polegar) na barra de rolagem especificada. A posição atual é um valor relativo que depende do intervalo de rolagem atual. Por exemplo, se o intervalo de rolagem for de 0 a 100 e a caixa de rolagem estiver no meio da barra, a posição atual será 50.

Nota A função GetScrollPos é fornecida para compatibilidade com versões anteriores. Novos aplicativos devem usar a função GetScrollInfo .

Sintaxe

int GetScrollPos(
  [in] HWND hWnd,
  [in] int  nBar
);

Parâmetros

[in] hWnd

Tipo: HWND

Manipule para um controle de barra de rolagem ou uma janela com uma barra de rolagem padrão, dependendo do valor do parâmetro nBar .

[in] nBar

Tipo: int

Especifica a barra de rolagem a ser examinada. Esse parâmetro pode usar um dos valores a seguir.

Valor	Significado
SB_CTL	Recupera a posição da caixa de rolagem em um controle de barra de rolagem. O parâmetro hWnd deve ser o identificador para o controle de barra de rolagem.
SB_HORZ	Recupera a posição da caixa de rolagem na barra de rolagem horizontal padrão de uma janela.
SB_VERT	Recupera a posição da caixa de rolagem na barra de rolagem vertical padrão de uma janela.

Valor retornado

Tipo: int

Se a função for bem-sucedida, o valor retornado será a posição atual da caixa de rolagem.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função GetScrollPos permite que os aplicativos usem posições de rolagem de 32 bits. Embora as mensagens que indicam a posição da barra de rolagem, WM_HSCROLL e WM_VSCROLL, sejam limitadas a 16 bits de dados de posição, as funções SetScrollPos, SetScrollRange, GetScrollPos e GetScrollRange dão suporte a dados de posição da barra de rolagem de 32 bits. Assim, um aplicativo pode chamar GetScrollPos durante o processamento das mensagens de WM_HSCROLL ou WM_VSCROLL para obter dados de posição da barra de rolagem de 32 bits.

Para obter a posição de 32 bits da caixa de rolagem (polegar) durante um código de solicitação SB_THUMBTRACK em uma mensagem de WM_HSCROLL ou WM_VSCROLL , use a função GetScrollInfo .

Se o parâmetro nBar for SB_CTL e a janela especificada pelo parâmetro hWnd não for um controle de barra de rolagem do sistema, o sistema enviará a mensagem SBM_GETPOS para a janela para obter informações da barra de rolagem. Isso permite que GetScrollPos opere em um controle personalizado que imita uma barra de rolagem. Se a janela não manipular a mensagem SBM_GETPOS , a função GetScrollPos falhará.

Requisitos


Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll
Conjunto de APIs	ext-ms-win-ntuser-misc-l1-2-0 (introduzido em Windows 8.1)