Función GetLargestConsoleWindowSize

Artículo
12/21/2023

Importante

En este documento se describe funcionalidad de la plataforma de consola que ya no forma parte de nuestro plan de desarrollo del ecosistema. No se recomienda usar este contenido en nuevos productos, pero seguiremos admitiendo los usos existentes para el futuro indefinido. Nuestra solución moderna preferida se centra en secuencias de terminal virtual para lograr la máxima compatibilidad en escenarios multiplataforma. Puede encontrar más información sobre esta decisión de diseño en nuestro documento de Comparación de consola clásica y terminal virtual.

Recupera el tamaño de la ventana de consola más grande posible, en función de la fuente actual y el tamaño de la pantalla.

Sintaxis

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

Parámetros

hConsoleOutput [in]
Identificador del búfer de pantalla de la consola.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es una estructura COORD que especifica el número de columnas de celda de caracteres (miembro X) y filas (miembro Y) en la ventana de consola más grande posible. En caso contrario, los miembros de la estructura son igual a cero.

Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función no tiene en cuenta el tamaño del búfer de pantalla de consola, lo que significa que el tamaño de la ventana devuelto puede ser mayor que el de este búfer. La función GetConsoleScreenBufferInfo se puede utilizar para determinar el tamaño máximo de la ventana de consola en función del tamaño del búfer de pantalla actual, la fuente actual y el tamaño de la pantalla.

Sugerencia

Esta API no se recomienda y no tiene un equivalente de terminal virtual. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos en los que se concede al usuario control total sobre esta opción de presentación. Es posible que las aplicaciones que se comunican remotamente a través de utilidades multiplataforma y los transportes como SSH no funcionen según lo previsto si se utiliza esta API.

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