GetLargestConsoleWindowSize 函数

重要

本文档介绍控制台平台功能,该功能已不再是生态系统蓝图的一部分。 我们不建议在新产品中使用此内容,但我们未来将无限期支持现有使用。 我们的首选最新解决方案侧重于虚拟终端序列,以实现跨平台方案中的最大兼容性。 可以在经典控制台与虚拟终端文档中找到有关此设计决策的详细信息。

根据显示屏的当前字体和大小,检索最大控制台窗口的大小。

语法

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

参数

hConsoleOutput [in]
控制台屏幕缓冲区的句柄。

返回值

如果函数成功,则返回值为 COORD 结构,它指定可能最大的控制台窗口中字符单元列(X 成员)和行(Y 成员)的数目。 否则,结构的成员为零。

要获得更多的错误信息,请调用 GetLastError

备注

该函数不会考虑控制台屏幕缓冲区的大小,这意味着返回的窗口大小可能大于控制台屏幕缓冲区的大小。 GetConsoleScreenBufferInfo 函数可根据当前屏幕缓冲区大小、当前字体和显示大小,确定控制台窗口的大小上限。

提示

不建议使用此 API,并且此 API 没有虚拟终端等效项。 此决策有意使 Windows 平台与其他操作系统保持一致,在这些操作系统中,用户可以完全控制此演示选项。 如果使用此 API,则通过跨平台实用工具和传输(例如 SSH)进行远程处理的应用程序可能无法正常工作。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
Header ConsoleApi2.h (via WinCon.h, include Windows.h)
Kernel32.lib
DLL Kernel32.dll

另请参阅

控制台函数

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo

窗口和屏幕缓冲区大小