SetConsoleActiveScreenBuffer 函数

重要

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

将指定的屏幕缓冲区设置为当前显示的控制台屏幕缓冲区。

语法

BOOL WINAPI SetConsoleActiveScreenBuffer(
  _In_ HANDLE hConsoleOutput
);

参数

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

返回值

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

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

注解

一个控制台可以有多个屏幕缓冲区。 SetConsoleActiveScreenBuffer 决定显示哪一个。 可以写入到非活动屏幕缓冲区,然后使用 SetConsoleActiveScreenBuffer 显示缓冲区的内容。

提示

不建议使用此 API,但它在备用屏幕缓冲区序列中具有等效的近似虚拟终端。 设置备用屏幕缓冲区可以为应用程序提供单独的隔离空间,用于在其会话运行时过程中进行绘制,同时保留应用程序调用方显示的内容。 这会维护用于在进程退出时进行简单还原的绘图信息。

示例

有关示例,请参阅读取和写入字符和属性块

要求

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

另请参阅

控制台函数

控制台屏幕缓冲区

CreateConsoleScreenBuffer