| title | description | author | ms.author | ms.topic | keywords | f1_keywords | MS-HAID | MSHAttr | ms.assetid | topic_type | api_name | api_location | api_type | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WriteConsoleInput function |
See reference information about the WriteConsoleInput function, which writes data directly to the console input buffer. |
miniksa |
miniksa |
article |
console, character mode applications, command line applications, terminal applications, console api |
|
|
|
ad06231f-5063-4aff-b14d-8df5e6e42430 |
|
|
|
|
[!INCLUDE not-recommended-banner]
Writes data directly to the console input buffer.
BOOL WINAPI WriteConsoleInput(
_In_ HANDLE hConsoleInput,
_In_ const INPUT_RECORD *lpBuffer,
_In_ DWORD nLength,
_Out_ LPDWORD lpNumberOfEventsWritten
);hConsoleInput [in]
A handle to the console input buffer. The handle must have the GENERIC_WRITE access right. For more information, see Console Buffer Security and Access Rights.
lpBuffer [in]
A pointer to an array of INPUT_RECORD structures that contain data to be written to the input buffer.
nLength [in]
The number of input records to be written.
lpNumberOfEventsWritten [out]
A pointer to a variable that receives the number of input records 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.
WriteConsoleInput places input records into the input buffer behind any pending events in the buffer. The input buffer grows dynamically, if necessary, to hold as many events as are written.
[!INCLUDE setting-codepage-mode-remarks]
Tip
This API is not recommended and does not have a virtual terminal equivalent. This decision intentionally aligns the Windows platform with other operating systems. This operation is considered the wrong-way verb for this buffer. Applications remoting via cross-platform utilities and transports like SSH may not work as expected if using this API.
| 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 | WriteConsoleInputW (Unicode) and WriteConsoleInputA (ANSI) |