Función GetConsoleScreenBufferInfo

Artículo
12/21/2023

Recupera información sobre el búfer de pantalla de consola especificado.

Sintaxis

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

Parámetros

hConsoleOutput [in]
Identificador del búfer de pantalla de la consola. El identificador debe tener derecho de acceso de GENERIC_READ. Para obtener más información, consulte Seguridad y derechos de acceso del búfer de la consola.

lpConsoleScreenBufferInfo [out]
Puntero a una estructura CONSOLE_SCREEN_BUFFER_INFO que recibe la información del búfer de pantalla de consola.

Valor devuelto

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

El rectángulo devuelto en el miembro srWindow de la estructura CONSOLE_SCREEN_BUFFER_INFO se puede modificar y, a continuación, pasar a la función SetConsoleWindowInfo para desplazar el búfer de pantalla de consola en la ventana, cambiar el tamaño de la ventana o realizar ambas acciones.

Todas las coordenadas devueltas en la estructura CONSOLE_SCREEN_BUFFER_INFO están en coordenadas de celda de caracteres, donde el origen (0, 0) se encuentra en la esquina superior izquierda del búfer de pantalla de consola.

Sugerencia

Esta API no tiene un equivalente de terminal virtual. Es posible que se siga requiriendo su uso en el caso de las aplicaciones que intentan dibujar columnas o cuadrículas, o rellenar la pantalla para recuperar el tamaño de la ventana. Este estado de ventana se administra mediante la TTY/PTY/pseudoconsola fuera del flujo normal y, generalmente, la aplicación cliente lo considera un privilegio de usuario no ajustable. Se pueden recibir novedades en ReadConsoleInput.

Ejemplos

Para ver un ejemplo, consulte Desplazamiento por la ventana de un búfer de pantalla.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	ConsoleApi2.h (a través de WinCon.h, incluido Windows.h)
Biblioteca	Kernel32.lib
Archivo DLL	Kernel32.dll