Función GetUpdateRect (winuser.h)

Artículo
03/15/2023

La función GetUpdateRect recupera las coordenadas del rectángulo más pequeño que incluye completamente la región de actualización de la ventana especificada. GetUpdateRect recupera el rectángulo en coordenadas lógicas. Si no hay ninguna región de actualización, GetUpdateRect recupera un rectángulo vacío (establece todas las coordenadas en cero).

Sintaxis

BOOL GetUpdateRect(
  [in]  HWND   hWnd,
  [out] LPRECT lpRect,
  [in]  BOOL   bErase
);

Parámetros

[in] hWnd

Identificador de la ventana cuya región de actualización se va a recuperar.

[out] lpRect

Puntero a la estructura RECT que recibe las coordenadas, en unidades de dispositivo, del rectángulo envolvente.

Una aplicación puede establecer este parámetro en NULL para determinar si existe una región de actualización para la ventana. Si este parámetro es NULL, GetUpdateRect devuelve un valor distinto de cero si existe una región de actualización y cero si no existe una. Esto proporciona un medio sencillo y eficaz para determinar si un mensaje de WM_PAINT resultó de un área no válida.

[in] bErase

Especifica si el fondo de la región de actualización debe borrarse. Si este parámetro es TRUE y la región de actualización no está vacía, GetUpdateRect envía un mensaje de WM_ERASEBKGND a la ventana especificada para borrar el fondo.

Valor devuelto

Si la región de actualización no está vacía, el valor devuelto es distinto de cero.

Si no hay ninguna región de actualización, el valor devuelto es cero.

Comentarios

El rectángulo de actualización recuperado por la función BeginPaint es idéntico al recuperado por GetUpdateRect.

BeginPaint valida automáticamente la región de actualización, por lo que cualquier llamada a GetUpdateRect realizada inmediatamente después de la llamada a BeginPaint recupera una región de actualización vacía.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-draw-l1-1-0 (introducido en Windows 8)