|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| wincon.h
| Unicode
| No
| Platform Notes
| None
|
|
|
WriteConsoleOutputAttribute
The WriteConsoleOutputAttribute function copies a number of foreground and background color attributes to
consecutive cells of a console screen buffer, beginning at a specified location.
BOOL WriteConsoleOutputAttribute(
HANDLE hConsoleOutput,
| // handle to a console screen buffer
| CONST WORD *lpAttribute,
| // pointer to buffer to write attributes from
| DWORD nLength,
| // number of character cells to write to
| COORD wWriteCoord,
| // coordinates of first cell to write to
| LPDWORD lpNumberOfAttrsWritten
| // pointer to number of cells written to
| );
|
|
Parameters
hConsoleOutput
Identifies the screen buffer. The handle must have GENERIC_WRITE access.
lpAttribute
Points to a buffer that contains the attributes to write to the screen buffer.
nLength
Specifies the number of screen buffer character cells to write to.
dwWriteCoord
Specifies the column and row coordinates of the first cell in the screen
buffer to write to.
lpNumberOfAttrsWritten
Points to a 32-bit variable that receives the number of attributes actually
written to the screen buffer.
Return Values
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.
Remarks
If the number of attributes to be written to extends beyond the end of the
specified row in the screen buffer, attributes are written to the next row. If the
number of attributes to be written to extends beyond the end of the screen
buffer, the attributes are written up to the end of the screen buffer.
The character values at the positions written to are not changed.
Each attribute specifies the foreground (text) and background colors in which
that character cell is drawn. The attribute values are some combination of the
following values: FOREGROUND_BLUE, FOREGROUND_GREEN, FOREGROUND_RED,
FOREGROUND_INTENSITY, BACKGROUND_BLUE, BACKGROUND_GREEN, BACKGROUND_RED, and
BACKGROUND_INTENSITY. For example, the following combination of values produces red text on
a white background:
FOREGROUND_RED | BACKGROUND_RED | BACKGROUND_GREEN | BACKGROUND_BLUE
See Also
ReadConsoleOutput, ReadConsoleOutputAttribute, ReadConsoleOutputCharacter, WriteConsoleOutput, WriteConsoleOutputCharacter
Related Links
Software for Delphi and C++ Builder developers
Software for Visual Studio .NET developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET
TMS Scripter Studio Pro components for Delphi/C++Builder
More Online Helps
Win32 Multimedia Programmer's Reference (mmedia.hlp)
OLE Programmer's Reference (ole.hlp)
Microsoft Windows Pen API Programmer's Reference (penapi.hlp)
Microsoft Windows Sockets 2 Reference (sock2.hlp)
Microsoft Windows Telephony API (TAPI) Programmer's Reference (tapi.hlp)
Unix Manual Pages
|
