GetLargestConsoleWindowSize

The GetLargestConsoleWindowSize function retrieves the size of the largest possible console window, based on the current font and the size of the display.

COORD GetLargestConsoleWindowSize(
  HANDLE hConsoleOutput   // handle to screen buffer
);

Parameters

hConsoleOutput

[in] Handle to a console screen buffer.

Return Values

If the function succeeds, the return value is a COORD structure that specifies the number of character cell rows (X member) and columns (Y member) in the largest possible console window. Otherwise, the members of the structure are zero.

To get extended error information, call GetLastError.

Remarks

The function does not take into consideration the size of the screen buffer, which means that the window size returned may be larger than the size of the screen buffer. The GetConsoleScreenBufferInfo function can be used to determine the maximum size of the console window, given the current screen buffer size, the current font, and the display size.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Wincon.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

Consoles and Character-Mode Support Overview, Console Functions, COORD, GetConsoleScreenBufferInfo, SetConsoleWindowInfo