Retrieves the size of the largest possible console window, based on the current font and the size of the display.
Syntax
COORD WINAPI GetLargestConsoleWindowSize(
__in HANDLE hConsoleOutput
);
Parameters
- hConsoleOutput [in]
-
A handle to the console screen buffer.
Return Value
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 console screen buffer, which means that the window size returned may be larger than the size of the console 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
| Minimum supported client | Windows 2000 Professional |
| Minimum supported server | Windows 2000 Server |
| Header | Wincon.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |
See Also
- Console Functions
- COORD
- GetConsoleScreenBufferInfo
- SetConsoleWindowInfo
- Window and Screen Buffer Size
Send comments about this topic to Microsoft
Build date: 10/8/2009