WriteConsole
The WriteConsole
function writes a character string to a console screen buffer beginning at the
current cursor location.
BOOL WriteConsole(
|
HANDLE hConsoleOutput, |
// handle to a
console screen buffer |
|
CONST VOID *lpBuffer, |
// pointer to
buffer to write from |
|
DWORD nNumberOfCharsToWrite, |
// number of
characters to write |
|
LPDWORD lpNumberOfCharsWritten, |
// pointer to
number of characters written |
|
LPVOID lpReserved |
// reserved |
|
); |
|
Parameters
hConsoleOutput
Identifies
the console screen buffer to be written to. The handle must have GENERIC_WRITE
access.
lpBuffer
Points to a buffer
that contains characters to be written to the screen buffer.
nNumberOfCharsToWrite
Specifies the
number of characters to write.
lpNumberOfCharsWritten
Points to a
32-bit variable that receives the number of characters actually written.
lpReserved
Reserved;
must be NULL.
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
WriteConsole writes characters to a console screen buffer. It
behaves like the WriteFile
function, except it can write in either Unicode (wide-character) or ANSI mode.
To create an application that maintains a single set of sources compatible with
both modes, use WriteConsole rather than WriteFile. Although WriteConsole
can be used only with a console screen buffer handle, WriteFile can be
used with other handles (such as files or pipes). WriteConsole fails if
used with a standard handle that has been redirected to be something other than
a console handle.
Although an
application can use WriteConsole in ANSI mode to write ANSI characters,
consoles do not support ANSI escape sequences. However, some Win32 functions
provide equivalent functionality: for example, SetCursorPos, SetConsoleTextAttribute, and GetConsoleCursorInfo.
WriteConsole writes characters to the screen buffer at the current
cursor position. The cursor position advances as characters are written. The SetConsoleCursorPosition function sets the current
cursor position.
Characters
are written using the foreground and background color attributes associated
with the screen buffer. The SetConsoleTextAttribute function changes
these colors. To determine the current color attributes and the current cursor
position, use GetConsoleScreenBufferInfo.
All of the
input modes that affect the behavior of WriteFile have the same effect
on WriteConsole. To retrieve and set the output modes of a console
screen buffer, use the GetConsoleMode and SetConsoleMode functions.
Windows NT: This function uses either Unicode characters or 8-bit
characters from the console's current codepage. The console's codepage defaults
initially to the system's OEM codepage. To change the console's codepage, use
the SetConsoleCP or SetConsoleOutputCP functions, or use the chcp
or mode con cp select= commands.
See Also