WriteConsoleInput
The WriteConsoleInput
function writes data directly to the console input buffer.
BOOL WriteConsoleInput(
|
HANDLE hConsoleInput, |
// handle to a
console input buffer |
|
CONST INPUT_RECORD *lpBuffer, |
// pointer to the
buffer for write data |
|
DWORD nLength, |
// number of
records to write |
|
LPDWORD lpNumberOfEventsWritten |
// pointer to
number of records written |
|
); |
|
Parameters
hConsoleInput
Identifies
the input buffer. The handle must have GENERIC_WRITE access.
lpBuffer
Points to an INPUT_RECORD buffer containing data to
be written to the input buffer.
nLength
Specifies the
number of input records to be written.
lpNumberOfEventsWritten
Points to a
32-bit variable that receives the number of input records actually written.
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
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.
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