Función SetConsoleTextAttribute

Artículo
12/15/2023

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 los atributos de los caracteres escritos en el búfer de pantalla de la consola mediante la función WriteFile o WriteConsole, o bien se repite en la función ReadFile o ReadConsole. Esta función afecta al texto escrito después de la llamada de función.

Sintaxis

BOOL WINAPI SetConsoleTextAttribute(
  _In_ HANDLE hConsoleOutput,
  _In_ WORD   wAttributes
);

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.

wAttributes [in]
Los atributos de 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

Para determinar los atributos de color actuales de un búfer de pantalla, llame a la función GetConsoleScreenBufferInfo.

Sugerencia

Esta API tiene un terminal virtual equivalente en las secuencias de formato de texto. Se recomiendan secuencias de terminal virtual para todo el desarrollo nuevo y continuo.

Ejemplos

Para ver un ejemplo, consulte Uso de las funciones de entrada y salida de alto nivel.

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