| title | description | author | ms.author | ms.topic | keywords | f1_keywords | MS-HAID | MSHAttr | ms.assetid | topic_type | api_name | api_location | api_type | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WriteConsoleOutputCharacter function |
Copies a number of characters to consecutive cells of a console screen buffer, beginning at a specified location. |
miniksa |
miniksa |
article |
console, character mode applications, command line applications, terminal applications, console api |
|
|
|
7cc935ea-6b19-4494-b746-259aa7aaa9cc |
|
|
|
|
[!INCLUDE not-recommended-banner]
Copies a number of characters to consecutive cells of a console screen buffer, beginning at a specified location.
BOOL WINAPI WriteConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_In_ LPCTSTR lpCharacter,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfCharsWritten
);hConsoleOutput [in]
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.
lpCharacter [in]
The characters to be written to the console screen buffer.
nLength [in]
The number of characters to be written.
dwWriteCoord [in]
A COORD structure that specifies the character coordinates of the first cell in the console screen buffer to which characters will be written.
lpNumberOfCharsWritten [out]
A pointer to a variable that receives the number of characters actually written.
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 characters to be written to extends beyond the end of the specified row in the console screen buffer, characters are written to the next row. If the number of characters to be written to extends beyond the end of the console screen buffer, characters are written up to the end of the console screen buffer.
The attribute values at the positions written to are not changed.
[!INCLUDE setting-codepage-mode-remarks]
Tip
This API has a virtual terminal equivalent in the text formatting and cursor positioning sequences. Move the cursor to the location to insert, apply the formatting desired, and write out text to fill. There is no equivalent to emit text to an area without also applying the active color formatting. This decision intentionally aligns the Windows platform with other operating systems where the individual client application is expected to remember its own drawn state for further manipulation.
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Header | ConsoleApi2.h (via WinCon.h, include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |
| Unicode and ANSI names | WriteConsoleOutputCharacterW (Unicode) and WriteConsoleOutputCharacterA (ANSI) |