SetConsoleScreenBufferSize 函数

  • 项目

重要

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

更改指定控制台屏幕缓冲区的大小。

语法

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

参数

hConsoleOutput [in]
控制台屏幕缓冲区的句柄。 该句柄必须具有 GENERIC_READ 访问权限。 有关详细信息，请参阅控制台缓冲区安全性和访问权限。

dwSize [in]
COORD 结构，指定控制台屏幕缓冲区的新大小（以字符行和列为单位）。 指定的宽度和高度不能小于控制台屏幕缓冲区窗口的宽度和高度。 指定的尺寸也不能小于系统允许的最小大小。 此最小值取决于控制台的当前字号（由用户选择）以及 GetSystemMetrics 函数返回的 SM_CXMIN 和 SM_CYMIN 值。

返回值

如果该函数成功，则返回值为非零值。

如果函数失败，则返回值为零。 要获得更多的错误信息，请调用 GetLastError。

备注

提示

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

要求

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

另请参阅

控制台函数

控制台输入缓冲区

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo