Función WriteConsoleOutputAttribute
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.
Copia una serie de atributos de carácter en celdas consecutivas de un búfer de pantalla de consola, comenzando en una ubicación especificada.
Sintaxis
BOOL WINAPI WriteConsoleOutputAttribute(
_In_ HANDLE hConsoleOutput,
_In_ const WORD *lpAttribute,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfAttrsWritten
);
Parámetros
hConsoleOutput [in]
Identificador del búfer de pantalla de la consola. El identificador debe tener derecho de acceso de GENERIC_WRITE. Para obtener más información, consulte Seguridad y derechos de acceso del búfer de la consola.
lpAttribute [in]
Los atributos que se usarán al escribir en el búfer de pantalla de la consola. Para más información, consulte Atributos de carácter.
nLength [in]
Número de celdas de caracteres de búfer de pantalla a las que se copiarán los atributos.
dwWriteCoord [in]
Una estructura COORD que especifica las coordenadas de caracteres de la primera celda del búfer de pantalla de la consola en la que se escribirán los atributos.
lpNumberOfAttrsWritten [out]
Un puntero a una variable que recibe el número de atributos escritos realmente en el búfer de pantalla de la 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
Si el número de atributos que se van a escribir se extiende más allá del final de la fila especificada en el búfer de pantalla de la consola, los atributos se escriben en la fila siguiente. Si el número de atributos que se van a escribir se extiende más allá del final del búfer de pantalla de la consola, los atributos se escriben hasta el final del búfer de pantalla de la consola.
Los valores de carácter de las posiciones en las que se escriben no se cambian.
Sugerencia
Esta API tiene un terminal virtual equivalente en las secuencias de formato de texto y posicionamiento del cursor. Mueva el cursor a la ubicación para insertar, aplique el formato deseado y escriba texto para rellenarlo. No hay ningún equivalente para aplicar color a un área sin emitir texto. Esta decisión alinea intencionadamente la plataforma Windows con otros sistemas operativos en los que se espera que la aplicación cliente individual recuerde su propio estado dibujado para su posterior manipulación.
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 |