0 out of 1 rated this helpful - Rate this topic

GetConsoleScreenBufferInfoEx function

Applies to: desktop apps only

Retrieves extended information about the specified console screen buffer.

Syntax

Copy

BOOL WINAPI GetConsoleScreenBufferInfoEx(
  __in   HANDLE hConsoleOutput,
  __out  PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

Parameters

hConsoleOutput [in]: A handle to the console screen buffer. The handle must have the GENERIC_READ access right. For more information, see Console Buffer Security and Access Rights.
lpConsoleScreenBufferInfoEx [out]: A CONSOLE_SCREEN_BUFFER_INFOEX structure that receives the requested console screen buffer information.

Return value

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_INFOEX structure can be modified and then passed to the SetConsoleWindowInfo function to scroll the console screen buffer in the window, to change the size of the window, or both.

All coordinates returned in the CONSOLE_SCREEN_BUFFER_INFOEX structure are in character-cell coordinates, where the origin (0, 0) is at the upper-left corner of the console screen buffer.

Requirements