Share via


Función GetScrollBarInfo (winuser.h)

La función GetScrollBarInfo recupera información sobre la barra de desplazamiento especificada.

Sintaxis

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

Parámetros

[in] hwnd

Tipo: HWND

Identificador de una ventana asociada a la barra de desplazamiento cuya información se va a recuperar. Si el parámetro idObject es OBJID_CLIENT, hwnd es un identificador de un control de barra de desplazamiento. De lo contrario, hwnd es un identificador de una ventana creada con WS_VSCROLL o estilo WS_HSCROLL .

[in] idObject

Tipo: LONG

Especifica el objeto de barra de desplazamiento. Este parámetro puede ser uno de los valores siguientes.

Valor Significado
OBJID_CLIENT
El parámetro hwnd es un identificador de un control de barra de desplazamiento.
OBJID_HSCROLL
Barra de desplazamiento horizontal de la ventana hwnd .
OBJID_VSCROLL
Barra de desplazamiento vertical de la ventana hwnd .

[out] psbi

Tipo: PSCROLLBARINFO

Puntero a una estructura SCROLLBARINFO para recibir la información. Antes de llamar a GetScrollBarInfo, establezca el miembro cbSize en sizeof(SCROLLBARINFO).

Valor devuelto

Tipo: BOOL

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

Si idObject es OBJID_CLIENT y la ventana especificada por hwnd no es un control de barra de desplazamiento del sistema, el sistema envía el mensaje SBM_GETSCROLLBARINFO a la ventana para obtener información de la barra de desplazamiento. Esto permite que GetScrollBarInfo funcione en un control personalizado que imita una barra de desplazamiento. Si la ventana no controla el mensaje de SBM_GETSCROLLBARINFO , se produce un error en la función GetScrollBarInfo .

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado winuser.h (incluir Windows.h)
Library User32.lib
Archivo DLL User32.dll
Redistribuible Service Pack 6
Conjunto de API ext-ms-win-ntuser-misc-l1-2-0 (introducido en Windows 8.1)

Consulte también

SCROLLBARINFO