Copies a number of character attributes to consecutive cells of a console screen buffer, beginning at a specified location.
BOOL WINAPI WriteConsoleOutputAttribute( _In_ HANDLE hConsoleOutput, _In_ const WORD *lpAttribute, _In_ DWORD nLength, _In_ COORD dwWriteCoord, _Out_ LPDWORD lpNumberOfAttrsWritten );
A handle to the console screen buffer. The handle must have the GENERIC_WRITE access right. For more information, see Console Buffer Security and Access Rights.
The attributes to be used when writing to the console screen buffer. For more information, see Character Attributes.
The number of screen buffer character cells to which the attributes will be copied.
A COORD structure that specifies the character coordinates of the first cell in the console screen buffer to which the attributes will be written.
A pointer to a variable that receives the number of attributes actually written to the console screen buffer.
If the function succeeds, the return value is nonzero.
If the function fails, the return value is zero. To get extended error information, call GetLastError.
If the number of attributes to be written to extends beyond the end of the specified row in the console screen buffer, attributes are written to the next row. If the number of attributes to be written to extends beyond the end of the console screen buffer, the attributes are written up to the end of the console screen buffer.
The character values at the positions written to are not changed.
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
|ConsoleApi2.h (via Wincon.h, include Windows.h)|
We'd love to hear your thoughts. Choose the type you'd like to provide:
Our feedback system is built on GitHub Issues. Read more on our blog.