|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| wincon.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
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
GetConsoleCursorInfo, GetConsoleMode, GetConsoleScreenBufferInfo, ReadConsole, SetConsoleCP, SetConsoleCursorPosition, SetConsoleMode, SetConsoleOutputCP, SetConsoleTextAttribute, SetCursorPos, WriteFile
| Last news from Greatis Software |
 |
|
Nostalgia .Net |
|
.Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More » |
| Recommended software for developers |
 |
|
Ultimate Pack |
|
Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More » |
 |
|
Form Designer .Net |
|
Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More » |
 |
|
Print Suite .Net |
|
Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More » |
 |
|
Gradient Controls .Net |
|
Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More » |
 |
|
Greatis iGrid |
|
iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More » |
All the contacts and projectsDmitry Vasiliev (just.dmitry)
Related LinksSoftware for Visual Studio .NET developers
Software for Delphi and C++ Builder developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET More Online Helps Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages
|
