SetConsoleDisplayMode 函数

重要

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

设置指定控制台屏幕缓冲区的显示模式。

语法

BOOL WINAPI SetConsoleDisplayMode(
  _In_      HANDLE hConsoleOutput,
  _In_      DWORD  dwFlags,
  _Out_opt_ PCOORD lpNewScreenBufferDimensions
);

参数

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

dwFlags [in]
控制台的显示模式。 此参数可使用以下一个或多个值。

含义
CONSOLE_FULLSCREEN_MODE 1 文本以全屏模式显示。
CONSOLE_WINDOWED_MODE 2 文本显示在控制台窗口中。

lpNewScreenBufferDimensions [出,可选]
指向 COORD 结构的指针,该结构接收屏幕缓冲区的新尺寸(以字符为单位)。

返回值

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

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

注解

提示

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

要求

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

另请参阅

控制台函数

控制台模式

GetConsoleDisplayMode