Función SetConsoleDisplayMode
Importante
En este documento se describe funcionalidad de la plataforma de consola que ya no forma parte de nuestra hoja de ruta del ecosistema. No se recomienda usar este contenido en nuevos productos, pero seguiremos admitiendo los usos existentes en un 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.
Establece el modo de presentación del búfer de pantalla de consola especificado.
Sintaxis
BOOL WINAPI SetConsoleDisplayMode(
_In_ HANDLE hConsoleOutput,
_In_ DWORD dwFlags,
_Out_opt_ PCOORD lpNewScreenBufferDimensions
);
Parámetros
hConsoleOutput [in]
Identificador del búfer de pantalla de la consola.
dwFlags [in]
El modo de presentación de la consola. Este parámetro puede ser uno o más de los siguientes valores.
Valor | Significado |
---|---|
CONSOLE_FULLSCREEN_MODE 1 | El texto se muestra en modo de pantalla completa. |
CONSOLE_WINDOWED_MODE 2 | El texto se muestra en una ventana de consola. |
lpNewScreenBufferDimensions [out, optional]
Un puntero a una estructura COORD que recibe las nuevas dimensiones del búfer de pantalla, en caracteres.
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
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 transportes, como SSH, no funcionen según lo previsto si se usa esta API.
Requisitos
Cliente mínimo compatible | Windows XP [solo aplicaciones de escritorio] |
Servidor mínimo compatible | Windows Server 2003 [solo aplicaciones de escritorio] |
Encabezado | ConsoleApi3.h (a través de WinCon.h, incluido Windows.h) |
Biblioteca | Kernel32.lib |
Archivo DLL | Kernel32.dll |