Function name: ReadConsole

Defined in : Kernel32

Requirements : Windows NT 3.1 or later; Windows 95 or later

Declaration:

Declare Function ReadConsole Lib "kernel32" Alias "ReadConsoleA" (ByVal hConsoleInput As Long, ByVal lpBuffer As String, ByVal nNumberOfCharsToRead As Long, lpNumberOfCharsRead As Long, lpReserved As Any) As Long

Parameters:

* hConsoleInput [in] Handle to the console input buffer. The handle must have GENERIC_READ access. * lpBuffer [out] Pointer to a buffer that receives the data read from the console input buffer. * nNumberOfCharsToRead [in] Specifies the number of TCHARs to read. Because the function can read either Unicode or ANSI characters, the size of the buffer pointed to by the lpBuffer parameter should be at least nNumberOfCharsToRead * sizeof(TCHAR) bytes. * lpNumberOfCharsRead [out] Pointer to a variable that receives the number of TCHARs actually read. * lpReserved [in] Reserved; must be NULL.

Returns:

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.

Related functions:

Examples:

Console Application