GetConsoleScreenBufferInfo
The GetConsoleScreenBufferInfo
function retrieves information about the specified console screen buffer.
BOOL GetConsoleScreenBufferInfo(
|
HANDLE hConsoleOutput, |
// handle of
console screen buffer |
|
PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo |
// address of
screen buffer info. |
|
); |
|
Parameters
hConsoleOutput
Identifies a
console screen buffer. The handle must have GENERIC_READ access.
lpConsoleScreenBufferInfo
Points to a CONSOLE_SCREEN_BUFFER_INFO structure in which the
screen buffer information is returned.
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
The rectangle
returned in the srWindow member of the CONSOLE_SCREEN_BUFFER_INFO
structure can be modified and then passed to the SetConsoleWindowInfo
function to scroll the screen buffer in the window, to change the size of the
window, or both.
All
coordinates returned in the CONSOLE_SCREEN_BUFFER_INFO structure are in
character-cell coordinates, where the origin (0, 0) is at the upper-left corner
of the screen buffer.
See Also